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.454 by root, Thu Sep 25 12:14:32 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 }
879 } 1194 }
880 } else { 1195 } else {
881 aio_unlink $filename; 1196 aio_unlink $filename;
882 aio_unlink "$filename.pst"; 1197 aio_unlink "$filename.pst";
883 } 1198 }
884 } 1199 };
885} 1200}
886 1201
887sub object_freezer_as_string { 1202sub object_freezer_as_string {
888 my ($rdata, $objs) = @_; 1203 my ($rdata, $objs) = @_;
889 1204
901 or return; 1216 or return;
902 1217
903 unless (aio_stat "$filename.pst") { 1218 unless (aio_stat "$filename.pst") {
904 (aio_load "$filename.pst", $av) >= 0 1219 (aio_load "$filename.pst", $av) >= 0
905 or return; 1220 or return;
1221
906 $av = eval { (Storable::thaw $av)->{objs} }; 1222 my $st = eval { Coro::Storable::thaw $av };
1223 $av = $st->{objs};
907 } 1224 }
908 1225
1226 utf8::decode (my $decname = $filename);
909 warn sprintf "loading %s (%d)\n", 1227 warn sprintf "loading %s (%d,%d)\n",
910 $filename, length $data, scalar @{$av || []};#d# 1228 $decname, length $data, scalar @{$av || []};
1229
911 return ($data, $av); 1230 ($data, $av)
912} 1231}
1232
1233=head2 COMMAND CALLBACKS
1234
1235=over 4
1236
1237=cut
913 1238
914############################################################################# 1239#############################################################################
915# command handling &c 1240# command handling &c
916 1241
917=item cf::register_command $name => \&callback($ob,$args); 1242=item cf::register_command $name => \&callback($ob,$args);
930 push @{ $COMMAND{$name} }, [$caller, $cb]; 1255 push @{ $COMMAND{$name} }, [$caller, $cb];
931} 1256}
932 1257
933=item cf::register_extcmd $name => \&callback($pl,$packet); 1258=item cf::register_extcmd $name => \&callback($pl,$packet);
934 1259
935Register a callbackf ro execution when the client sends an extcmd packet. 1260Register a callback for execution when the client sends an (synchronous)
1261extcmd packet. Ext commands will be processed in the order they are
1262received by the server, like other user commands. The first argument is
1263the logged-in player. Ext commands can only be processed after a player
1264has logged in successfully.
936 1265
937If the callback returns something, it is sent back as if reply was being 1266If the callback returns something, it is sent back as if reply was being
938called. 1267called.
939 1268
1269=item cf::register_exticmd $name => \&callback($ns,$packet);
1270
1271Register a callback for execution when the client sends an (asynchronous)
1272exticmd packet. Exti commands are processed by the server as soon as they
1273are received, i.e. out of order w.r.t. other commands. The first argument
1274is a client socket. Exti commands can be received anytime, even before
1275log-in.
1276
1277If the callback returns something, it is sent back as if reply was being
1278called.
1279
940=cut 1280=cut
941 1281
942sub register_extcmd { 1282sub register_extcmd {
943 my ($name, $cb) = @_; 1283 my ($name, $cb) = @_;
944 1284
945 my $caller = caller;
946 #warn "registering extcmd '$name' to '$caller'";
947
948 $EXTCMD{$name} = [$cb, $caller]; 1285 $EXTCMD{$name} = $cb;
1286}
1287
1288sub register_exticmd {
1289 my ($name, $cb) = @_;
1290
1291 $EXTICMD{$name} = $cb;
949} 1292}
950 1293
951cf::player->attach ( 1294cf::player->attach (
952 on_command => sub { 1295 on_command => sub {
953 my ($pl, $name, $params) = @_; 1296 my ($pl, $name, $params) = @_;
962 cf::override; 1305 cf::override;
963 }, 1306 },
964 on_extcmd => sub { 1307 on_extcmd => sub {
965 my ($pl, $buf) = @_; 1308 my ($pl, $buf) = @_;
966 1309
967 my $msg = eval { from_json $buf }; 1310 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
968 1311
969 if (ref $msg) { 1312 if (ref $msg) {
1313 my ($type, $reply, @payload) =
1314 "ARRAY" eq ref $msg
1315 ? @$msg
1316 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1317
1318 my @reply;
1319
970 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1320 if (my $cb = $EXTCMD{$type}) {
971 if (my %reply = $cb->[0]->($pl, $msg)) { 1321 @reply = $cb->($pl, @payload);
972 $pl->ext_reply ($msg->{msgid}, %reply);
973 }
974 } 1322 }
1323
1324 $pl->ext_reply ($reply, @reply)
1325 if $reply;
1326
975 } else { 1327 } else {
976 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1328 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
977 } 1329 }
978 1330
979 cf::override; 1331 cf::override;
980 }, 1332 },
981); 1333);
982 1334
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 { 1335sub load_extensions {
1336 cf::sync_job {
1337 my %todo;
1338
1060 for my $ext (<$LIBDIR/*.ext>) { 1339 for my $path (<$LIBDIR/*.ext>) {
1061 next unless -r $ext; 1340 next unless -r $path;
1062 eval { 1341
1063 load_extension $ext; 1342 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1343 my $base = $1;
1344 my $pkg = $1;
1345 $pkg =~ s/[^[:word:]]/_/g;
1346 $pkg = "ext::$pkg";
1347
1348 open my $fh, "<:utf8", $path
1349 or die "$path: $!";
1350
1351 my $source = do { local $/; <$fh> };
1352
1353 my %ext = (
1354 path => $path,
1355 base => $base,
1356 pkg => $pkg,
1357 );
1358
1359 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1360 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1361
1362 $ext{source} =
1363 "package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
1364 . "#line 1 \"$path\"\n{\n"
1365 . $source
1366 . "\n};\n1";
1367
1368 $todo{$base} = \%ext;
1369 }
1370
1371 my %done;
1372 while (%todo) {
1373 my $progress;
1374
1375 while (my ($k, $v) = each %todo) {
1376 for (split /,\s*/, $v->{meta}{depends}) {
1377 goto skip
1378 unless exists $done{$_};
1379 }
1380
1381 warn "... loading '$k' into '$v->{pkg}'\n";
1382
1383 unless (eval $v->{source}) {
1384 my $msg = $@ ? "$v->{path}: $@\n"
1385 : "$v->{base}: extension inactive.\n";
1386
1387 if (exists $v->{meta}{mandatory}) {
1388 warn $msg;
1389 cf::cleanup "mandatory extension failed to load, exiting.";
1390 }
1391
1392 warn $msg;
1393 }
1394
1395 $done{$k} = delete $todo{$k};
1396 push @EXTS, $v->{pkg};
1397 $progress = 1;
1064 1 1398 }
1065 } or warn "$ext not loaded: $@"; 1399
1400 skip:
1401 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1402 unless $progress;
1403 }
1066 } 1404 };
1067} 1405}
1068 1406
1069############################################################################# 1407#############################################################################
1070# load/save/clean perl data associated with a map
1071 1408
1072*cf::mapsupport::on_clean = sub { 1409=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 1410
1085=head2 CORE EXTENSIONS 1411=head2 CORE EXTENSIONS
1086 1412
1087Functions and methods that extend core crossfire objects. 1413Functions and methods that extend core deliantra objects.
1088 1414
1089=cut 1415=cut
1090 1416
1091package cf::player; 1417package cf::player;
1092 1418
1094 1420
1095=head3 cf::player 1421=head3 cf::player
1096 1422
1097=over 4 1423=over 4
1098 1424
1425=item cf::player::num_playing
1426
1427Returns the official number of playing players, as per the Crossfire metaserver rules.
1428
1429=cut
1430
1431sub num_playing {
1432 scalar grep
1433 $_->ob->map
1434 && !$_->hidden
1435 && !$_->ob->flag (cf::FLAG_WIZ),
1436 cf::player::list
1437}
1438
1099=item cf::player::find $login 1439=item cf::player::find $login
1100 1440
1101Returns the given player object, loading it if necessary (might block). 1441Returns the given player object, loading it if necessary (might block).
1102 1442
1103=cut 1443=cut
1104 1444
1105sub playerdir($) { 1445sub playerdir($) {
1106 cf::localdir 1446 "$PLAYERDIR/"
1107 . "/"
1108 . cf::playerdir
1109 . "/"
1110 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1447 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1111} 1448}
1112 1449
1113sub path($) { 1450sub path($) {
1114 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1451 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1115 1452
1116 (playerdir $login) . "/$login.pl" 1453 (playerdir $login) . "/playerdata"
1117} 1454}
1118 1455
1119sub find_active($) { 1456sub find_active($) {
1120 $cf::PLAYER{$_[0]} 1457 $cf::PLAYER{$_[0]}
1121 and $cf::PLAYER{$_[0]}->active 1458 and $cf::PLAYER{$_[0]}->active
1124 1461
1125sub exists($) { 1462sub exists($) {
1126 my ($login) = @_; 1463 my ($login) = @_;
1127 1464
1128 $cf::PLAYER{$login} 1465 $cf::PLAYER{$login}
1129 or cf::sync_job { !aio_stat $login } 1466 or !aio_stat path $login
1130} 1467}
1131 1468
1132sub find($) { 1469sub find($) {
1133 return $cf::PLAYER{$_[0]} || do { 1470 return $cf::PLAYER{$_[0]} || do {
1134 my $login = $_[0]; 1471 my $login = $_[0];
1135 1472
1136 my $guard = cf::lock_acquire "user_find:$login"; 1473 my $guard = cf::lock_acquire "user_find:$login";
1137 1474
1138 $cf::PLAYER{$_[0]} || do { 1475 $cf::PLAYER{$_[0]} || do {
1139 my $pl = load_pl path $login 1476 # rename old playerfiles to new ones
1477 #TODO: remove when no longer required
1478 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1479 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1480 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1481 aio_unlink +(playerdir $login) . "/$login.pl";
1482
1483 my $f = new_from_file cf::object::thawer path $login
1140 or return; 1484 or return;
1485
1486 my $pl = cf::player::load_pl $f
1487 or return;
1488
1489 local $cf::PLAYER_LOADING{$login} = $pl;
1490 $f->resolve_delayed_derefs;
1141 $cf::PLAYER{$login} = $pl 1491 $cf::PLAYER{$login} = $pl
1142 } 1492 }
1143 } 1493 }
1144} 1494}
1145 1495
1154 return if $pl->{deny_save}; 1504 return if $pl->{deny_save};
1155 1505
1156 aio_mkdir playerdir $pl, 0770; 1506 aio_mkdir playerdir $pl, 0770;
1157 $pl->{last_save} = $cf::RUNTIME; 1507 $pl->{last_save} = $cf::RUNTIME;
1158 1508
1509 cf::get_slot 0.01;
1510
1159 $pl->save_pl ($path); 1511 $pl->save_pl ($path);
1160 Coro::cede; 1512 cf::cede_to_tick;
1161} 1513}
1162 1514
1163sub new($) { 1515sub new($) {
1164 my ($login) = @_; 1516 my ($login) = @_;
1165 1517
1171 $cf::PLAYER{$login} = $self; 1523 $cf::PLAYER{$login} = $self;
1172 1524
1173 $self 1525 $self
1174} 1526}
1175 1527
1528=item $player->send_msg ($channel, $msg, $color, [extra...])
1529
1530=cut
1531
1532sub send_msg {
1533 my $ns = shift->ns
1534 or return;
1535 $ns->send_msg (@_);
1536}
1537
1176=item $pl->quit_character 1538=item $pl->quit_character
1177 1539
1178Nukes the player without looking back. If logged in, the connection will 1540Nukes the player without looking back. If logged in, the connection will
1179be destroyed. May block for a long time. 1541be destroyed. May block for a long time.
1180 1542
1181=cut 1543=cut
1182 1544
1183sub quit_character { 1545sub quit_character {
1184 my ($pl) = @_; 1546 my ($pl) = @_;
1185 1547
1548 my $name = $pl->ob->name;
1549
1186 $pl->{deny_save} = 1; 1550 $pl->{deny_save} = 1;
1187 $pl->password ("*"); # this should lock out the player until we nuked the dir 1551 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1188 1552
1189 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1553 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1190 $pl->deactivate; 1554 $pl->deactivate;
1555 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1556 $pl->ob->check_score;
1191 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1557 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1192 $pl->ns->destroy if $pl->ns; 1558 $pl->ns->destroy if $pl->ns;
1193 1559
1194 my $path = playerdir $pl; 1560 my $path = playerdir $pl;
1195 my $temp = "$path~$cf::RUNTIME~deleting~"; 1561 my $temp = "$path~$cf::RUNTIME~deleting~";
1196 aio_rename $path, $temp; 1562 aio_rename $path, $temp;
1197 delete $cf::PLAYER{$pl->ob->name}; 1563 delete $cf::PLAYER{$pl->ob->name};
1198 $pl->destroy; 1564 $pl->destroy;
1565
1566 my $prefix = qr<^~\Q$name\E/>;
1567
1568 # nuke player maps
1569 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1570
1199 IO::AIO::aio_rmtree $temp; 1571 IO::AIO::aio_rmtree $temp;
1572}
1573
1574=item $pl->kick
1575
1576Kicks a player out of the game. This destroys the connection.
1577
1578=cut
1579
1580sub kick {
1581 my ($pl, $kicker) = @_;
1582
1583 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1584 $pl->killer ("kicked");
1585 $pl->ns->destroy;
1200} 1586}
1201 1587
1202=item cf::player::list_logins 1588=item cf::player::list_logins
1203 1589
1204Returns am arrayref of all valid playernames in the system, can take a 1590Returns am arrayref of all valid playernames in the system, can take a
1205while and may block, so not sync_job-capable, ever. 1591while and may block, so not sync_job-capable, ever.
1206 1592
1207=cut 1593=cut
1208 1594
1209sub list_logins { 1595sub list_logins {
1210 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1596 my $dirs = aio_readdir $PLAYERDIR
1211 or return []; 1597 or return [];
1212 1598
1213 my @logins; 1599 my @logins;
1214 1600
1215 for my $login (@$dirs) { 1601 for my $login (@$dirs) {
1602 my $path = path $login;
1603
1604 # a .pst is a dead give-away for a valid player
1605 # if no pst file found, open and chekc for blocked users
1606 if (aio_stat "$path.pst") {
1216 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1607 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1217 aio_read $fh, 0, 512, my $buf, 0 or next; 1608 aio_read $fh, 0, 512, my $buf, 0 or next;
1218 $buf !~ /^password -------------$/m or next; # official not-valid tag 1609 $buf !~ /^password -------------$/m or next; # official not-valid tag
1610 }
1219 1611
1220 utf8::decode $login; 1612 utf8::decode $login;
1221 push @logins, $login; 1613 push @logins, $login;
1222 } 1614 }
1223 1615
1224 \@logins 1616 \@logins
1225} 1617}
1226 1618
1227=item $player->maps 1619=item $player->maps
1228 1620
1229Returns an arrayref of cf::path's of all maps that are private for this 1621Returns an arrayref of map paths that are private for this
1230player. May block. 1622player. May block.
1231 1623
1232=cut 1624=cut
1233 1625
1234sub maps($) { 1626sub maps($) {
1235 my ($pl) = @_; 1627 my ($pl) = @_;
1628
1629 $pl = ref $pl ? $pl->ob->name : $pl;
1236 1630
1237 my $files = aio_readdir playerdir $pl 1631 my $files = aio_readdir playerdir $pl
1238 or return; 1632 or return;
1239 1633
1240 my @paths; 1634 my @paths;
1241 1635
1242 for (@$files) { 1636 for (@$files) {
1243 utf8::decode $_; 1637 utf8::decode $_;
1244 next if /\.(?:pl|pst)$/; 1638 next if /\.(?:pl|pst)$/;
1245 next unless /^$PATH_SEP/; 1639 next unless /^$PATH_SEP/o;
1246 1640
1247 s/$PATH_SEP/\//g; 1641 push @paths, cf::map::normalise "~$pl/$_";
1248 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1249 } 1642 }
1250 1643
1251 \@paths 1644 \@paths
1252} 1645}
1253 1646
1647=item $protocol_xml = $player->expand_cfpod ($cfpod)
1648
1649Expand deliantra pod fragments into protocol xml.
1650
1254=item $player->ext_reply ($msgid, $msgtype, %msg) 1651=item $player->ext_reply ($msgid, @msg)
1255 1652
1256Sends an ext reply to the player. 1653Sends an ext reply to the player.
1257 1654
1258=cut 1655=cut
1259 1656
1260sub ext_reply($$$%) { 1657sub ext_reply($$@) {
1261 my ($self, $id, %msg) = @_; 1658 my ($self, $id, @msg) = @_;
1262 1659
1263 $msg{msgid} = $id; 1660 $self->ns->ext_reply ($id, @msg)
1264
1265 $self->send ("ext " . cf::to_json \%msg);
1266} 1661}
1267 1662
1268package cf; 1663=item $player->ext_msg ($type, @msg)
1664
1665Sends an ext event to the client.
1666
1667=cut
1668
1669sub ext_msg($$@) {
1670 my ($self, $type, @msg) = @_;
1671
1672 $self->ns->ext_msg ($type, @msg);
1673}
1674
1675=head3 cf::region
1676
1677=over 4
1678
1679=cut
1680
1681package cf::region;
1682
1683=item cf::region::find_by_path $path
1684
1685Tries to decuce the likely region for a map knowing only its path.
1686
1687=cut
1688
1689sub find_by_path($) {
1690 my ($path) = @_;
1691
1692 my ($match, $specificity);
1693
1694 for my $region (list) {
1695 if ($region->{match} && $path =~ $region->{match}) {
1696 ($match, $specificity) = ($region, $region->specificity)
1697 if $region->specificity > $specificity;
1698 }
1699 }
1700
1701 $match
1702}
1269 1703
1270=back 1704=back
1271
1272 1705
1273=head3 cf::map 1706=head3 cf::map
1274 1707
1275=over 4 1708=over 4
1276 1709
1279package cf::map; 1712package cf::map;
1280 1713
1281use Fcntl; 1714use Fcntl;
1282use Coro::AIO; 1715use Coro::AIO;
1283 1716
1717use overload
1718 '""' => \&as_string,
1719 fallback => 1;
1720
1284our $MAX_RESET = 3600; 1721our $MAX_RESET = 3600;
1285our $DEFAULT_RESET = 3000; 1722our $DEFAULT_RESET = 3000;
1286 1723
1287sub generate_random_map { 1724sub generate_random_map {
1288 my ($path, $rmp) = @_; 1725 my ($self, $rmp) = @_;
1726
1727 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1289 1728
1290 # mit "rum" bekleckern, nicht 1729 # mit "rum" bekleckern, nicht
1291 cf::map::_create_random_map 1730 $self->_create_random_map (
1292 $path,
1293 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1731 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1294 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1732 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1295 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1733 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1296 $rmp->{exit_on_final_map}, 1734 $rmp->{exit_on_final_map},
1297 $rmp->{xsize}, $rmp->{ysize}, 1735 $rmp->{xsize}, $rmp->{ysize},
1298 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1736 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1299 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1737 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1300 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1738 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1301 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1739 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1302 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1740 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1303 (cf::region::find $rmp->{region}) 1741 (cf::region::find $rmp->{region}), $rmp->{custom}
1742 )
1743}
1744
1745=item cf::map->register ($regex, $prio)
1746
1747Register a handler for the map path matching the given regex at the
1748givne priority (higher is better, built-in handlers have priority 0, the
1749default).
1750
1751=cut
1752
1753sub register {
1754 my (undef, $regex, $prio) = @_;
1755 my $pkg = caller;
1756
1757 no strict;
1758 push @{"$pkg\::ISA"}, __PACKAGE__;
1759
1760 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1761}
1762
1763# also paths starting with '/'
1764$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1765
1766sub thawer_merge {
1767 my ($self, $merge) = @_;
1768
1769 # we have to keep some variables in memory intact
1770 local $self->{path};
1771 local $self->{load_path};
1772
1773 $self->SUPER::thawer_merge ($merge);
1774}
1775
1776sub normalise {
1777 my ($path, $base) = @_;
1778
1779 $path = "$path"; # make sure its a string
1780
1781 $path =~ s/\.map$//;
1782
1783 # map plan:
1784 #
1785 # /! non-realised random map exit (special hack!)
1786 # {... are special paths that are not being touched
1787 # ?xxx/... are special absolute paths
1788 # ?random/... random maps
1789 # /... normal maps
1790 # ~user/... per-player map of a specific user
1791
1792 $path =~ s/$PATH_SEP/\//go;
1793
1794 # treat it as relative path if it starts with
1795 # something that looks reasonable
1796 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1797 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1798
1799 $base =~ s{[^/]+/?$}{};
1800 $path = "$base/$path";
1801 }
1802
1803 for ($path) {
1804 redo if s{//}{/};
1805 redo if s{/\.?/}{/};
1806 redo if s{/[^/]+/\.\./}{/};
1807 }
1808
1809 $path
1810}
1811
1812sub new_from_path {
1813 my (undef, $path, $base) = @_;
1814
1815 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1816
1817 $path = normalise $path, $base;
1818
1819 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1820 if ($path =~ $EXT_MAP{$pkg}[1]) {
1821 my $self = bless cf::map::new, $pkg;
1822 $self->{path} = $path; $self->path ($path);
1823 $self->init; # pass $1 etc.
1824 return $self;
1825 }
1826 }
1827
1828 Carp::cluck "unable to resolve path '$path' (base '$base').";
1829 ()
1830}
1831
1832sub init {
1833 my ($self) = @_;
1834
1835 $self
1836}
1837
1838sub as_string {
1839 my ($self) = @_;
1840
1841 "$self->{path}"
1842}
1843
1844# the displayed name, this is a one way mapping
1845sub visible_name {
1846 &as_string
1847}
1848
1849# the original (read-only) location
1850sub load_path {
1851 my ($self) = @_;
1852
1853 "$MAPDIR/$self->{path}.map"
1854}
1855
1856# the temporary/swap location
1857sub save_path {
1858 my ($self) = @_;
1859
1860 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1861 "$TMPDIR/$path.map"
1862}
1863
1864# the unique path, undef == no special unique path
1865sub uniq_path {
1866 my ($self) = @_;
1867
1868 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1869 "$UNIQUEDIR/$path"
1304} 1870}
1305 1871
1306# and all this just because we cannot iterate over 1872# and all this just because we cannot iterate over
1307# all maps in C++... 1873# all maps in C++...
1308sub change_all_map_light { 1874sub change_all_map_light {
1310 1876
1311 $_->change_map_light ($change) 1877 $_->change_map_light ($change)
1312 for grep $_->outdoor, values %cf::MAP; 1878 for grep $_->outdoor, values %cf::MAP;
1313} 1879}
1314 1880
1881sub decay_objects {
1882 my ($self) = @_;
1883
1884 return if $self->{deny_reset};
1885
1886 $self->do_decay_objects;
1887}
1888
1889sub unlink_save {
1890 my ($self) = @_;
1891
1892 utf8::encode (my $save = $self->save_path);
1893 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1894 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1895}
1896
1315sub try_load_header($) { 1897sub load_header_from($) {
1316 my ($path) = @_; 1898 my ($self, $path) = @_;
1317 1899
1318 utf8::encode $path; 1900 utf8::encode $path;
1319 aio_open $path, O_RDONLY, 0 1901 my $f = new_from_file cf::object::thawer $path
1320 or return; 1902 or return;
1321 1903
1322 my $map = cf::map::new 1904 $self->_load_header ($f)
1323 or return; 1905 or return;
1324 1906
1325 # for better error messages only, will be overwritten 1907 local $MAP_LOADING{$self->{path}} = $self;
1326 $map->path ($path); 1908 $f->resolve_delayed_derefs;
1327 1909
1328 $map->load_header ($path) 1910 $self->{load_path} = $path;
1911
1912 1
1913}
1914
1915sub load_header_orig {
1916 my ($self) = @_;
1917
1918 $self->load_header_from ($self->load_path)
1919}
1920
1921sub load_header_temp {
1922 my ($self) = @_;
1923
1924 $self->load_header_from ($self->save_path)
1925}
1926
1927sub prepare_temp {
1928 my ($self) = @_;
1929
1930 $self->last_access ((delete $self->{last_access})
1931 || $cf::RUNTIME); #d#
1932 # safety
1933 $self->{instantiate_time} = $cf::RUNTIME
1934 if $self->{instantiate_time} > $cf::RUNTIME;
1935}
1936
1937sub prepare_orig {
1938 my ($self) = @_;
1939
1940 $self->{load_original} = 1;
1941 $self->{instantiate_time} = $cf::RUNTIME;
1942 $self->last_access ($cf::RUNTIME);
1943 $self->instantiate;
1944}
1945
1946sub load_header {
1947 my ($self) = @_;
1948
1949 if ($self->load_header_temp) {
1950 $self->prepare_temp;
1951 } else {
1952 $self->load_header_orig
1329 or return; 1953 or return;
1954 $self->prepare_orig;
1955 }
1330 1956
1331 $map->{load_path} = $path; 1957 $self->{deny_reset} = 1
1958 if $self->no_reset;
1332 1959
1333 $map 1960 $self->default_region (cf::region::find_by_path $self->{path})
1961 unless $self->default_region;
1962
1963 1
1334} 1964}
1335 1965
1336sub find; 1966sub find;
1337sub find { 1967sub find {
1338 my ($path, $origin) = @_; 1968 my ($path, $origin) = @_;
1339 1969
1340 #warn "find<$path,$origin>\n";#d#
1341
1342 $path = new cf::path $path, $origin && $origin->path; 1970 $path = normalise $path, $origin && $origin->path;
1343 my $key = $path->as_string;
1344 1971
1972 cf::lock_wait "map_data:$path";#d#remove
1345 cf::lock_wait "map_find:$key"; 1973 cf::lock_wait "map_find:$path";
1346 1974
1347 $cf::MAP{$key} || do { 1975 $cf::MAP{$path} || do {
1976 my $guard1 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1348 my $guard = cf::lock_acquire "map_find:$key"; 1977 my $guard2 = cf::lock_acquire "map_find:$path";
1349 1978
1350 # do it the slow way 1979 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; 1980 or return;
1369 1981
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; 1982 $map->{last_save} = $cf::RUNTIME;
1382 1983
1383 Coro::cede; 1984 $map->load_header
1985 or return;
1384 1986
1385 if ($map->should_reset) { 1987 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1988 # doing this can freeze the server in a sync job, obviously
1989 #$cf::WAIT_FOR_TICK->wait;
1990 undef $guard2;
1991 undef $guard1;
1386 $map->reset; 1992 $map->reset;
1387 undef $guard;
1388 $map = find $path 1993 return find $path;
1389 or return;
1390 } 1994 }
1391 1995
1392 $cf::MAP{$key} = $map 1996 $cf::MAP{$path} = $map
1393 } 1997 }
1394} 1998}
1999
2000sub pre_load { }
2001sub post_load { }
1395 2002
1396sub load { 2003sub load {
1397 my ($self) = @_; 2004 my ($self) = @_;
1398 2005
2006 local $self->{deny_reset} = 1; # loading can take a long time
2007
1399 my $path = $self->{path}; 2008 my $path = $self->{path};
2009
2010 {
1400 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2011 my $guard = cf::lock_acquire "map_data:$path";
1401 2012
2013 return unless $self->valid;
1402 return if $self->in_memory != cf::MAP_SWAPPED; 2014 return unless $self->in_memory == cf::MAP_SWAPPED;
1403 2015
1404 $self->in_memory (cf::MAP_LOADING); 2016 $self->in_memory (cf::MAP_LOADING);
1405 2017
1406 $self->alloc; 2018 $self->alloc;
1407 $self->load_objects ($self->{load_path}, 1) 2019
2020 $self->pre_load;
2021 cf::cede_to_tick;
2022
2023 my $f = new_from_file cf::object::thawer $self->{load_path};
2024 $f->skip_block;
2025 $self->_load_objects ($f)
1408 or return; 2026 or return;
1409 2027
1410 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2028 $self->post_load_original
1411 if delete $self->{load_original}; 2029 if delete $self->{load_original};
1412 2030
1413 if (my $uniq = $path->uniq_path) { 2031 if (my $uniq = $self->uniq_path) {
1414 utf8::encode $uniq; 2032 utf8::encode $uniq;
1415 if (aio_open $uniq, O_RDONLY, 0) { 2033 unless (aio_stat $uniq) {
2034 if (my $f = new_from_file cf::object::thawer $uniq) {
1416 $self->clear_unique_items; 2035 $self->clear_unique_items;
1417 $self->load_objects ($uniq, 0); 2036 $self->_load_objects ($f);
2037 $f->resolve_delayed_derefs;
2038 }
1418 } 2039 }
1419 } 2040 }
1420 2041
1421 Coro::cede; 2042 $f->resolve_delayed_derefs;
1422 2043
2044 cf::cede_to_tick;
1423 # now do the right thing for maps 2045 # now do the right thing for maps
1424 $self->link_multipart_objects; 2046 $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) 2047 $self->difficulty ($self->estimate_difficulty)
1435 unless $self->difficulty; 2048 unless $self->difficulty;
2049 cf::cede_to_tick;
2050
2051 unless ($self->{deny_activate}) {
2052 $self->decay_objects;
2053 $self->fix_auto_apply;
2054 $self->update_buttons;
2055 cf::cede_to_tick;
2056 $self->set_darkness_map;
2057 cf::cede_to_tick;
1436 $self->activate; 2058 $self->activate;
1437 } 2059 }
1438 2060
1439 Coro::cede; 2061 $self->{last_save} = $cf::RUNTIME;
2062 $self->last_access ($cf::RUNTIME);
1440 2063
1441 $self->in_memory (cf::MAP_IN_MEMORY); 2064 $self->in_memory (cf::MAP_ACTIVE);
2065 }
2066
2067 $self->post_load;
2068}
2069
2070sub customise_for {
2071 my ($self, $ob) = @_;
2072
2073 return find "~" . $ob->name . "/" . $self->{path}
2074 if $self->per_player;
2075
2076# return find "?party/" . $ob->name . "/" . $self->{path}
2077# if $self->per_party;
2078
2079 $self
1442} 2080}
1443 2081
1444# find and load all maps in the 3x3 area around a map 2082# find and load all maps in the 3x3 area around a map
1445sub load_diag { 2083sub load_neighbours {
1446 my ($map) = @_; 2084 my ($map) = @_;
1447 2085
1448 my @diag; # diagonal neighbours 2086 my @neigh; # diagonal neighbours
1449 2087
1450 for (0 .. 3) { 2088 for (0 .. 3) {
1451 my $neigh = $map->tile_path ($_) 2089 my $neigh = $map->tile_path ($_)
1452 or next; 2090 or next;
1453 $neigh = find $neigh, $map 2091 $neigh = find $neigh, $map
1454 or next; 2092 or next;
1455 $neigh->load; 2093 $neigh->load;
1456 2094
2095 push @neigh,
1457 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2096 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1458 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2097 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1459 } 2098 }
1460 2099
1461 for (@diag) { 2100 for (grep defined $_->[0], @neigh) {
2101 my ($path, $origin) = @$_;
1462 my $neigh = find @$_ 2102 my $neigh = find $path, $origin
1463 or next; 2103 or next;
1464 $neigh->load; 2104 $neigh->load;
1465 } 2105 }
1466} 2106}
1467 2107
1472} 2112}
1473 2113
1474sub do_load_sync { 2114sub do_load_sync {
1475 my ($map) = @_; 2115 my ($map) = @_;
1476 2116
2117 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2118 if $Coro::current == $Coro::main;
2119
1477 cf::sync_job { $map->load }; 2120 cf::sync_job { $map->load };
1478} 2121}
1479 2122
1480our %MAP_PREFETCH; 2123our %MAP_PREFETCH;
2124our $MAP_PREFETCHER = undef;
2125
2126sub find_async {
2127 my ($path, $origin, $load) = @_;
2128
2129 $path = normalise $path, $origin && $origin->{path};
2130
2131 if (my $map = $cf::MAP{$path}) {
2132 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2133 }
2134
2135 $MAP_PREFETCH{$path} |= $load;
2136
1481our $MAP_PREFETCHER = Coro::async { 2137 $MAP_PREFETCHER ||= cf::async {
1482 while () { 2138 $Coro::current->{desc} = "map prefetcher";
2139
1483 while (%MAP_PREFETCH) { 2140 while (%MAP_PREFETCH) {
1484 my $key = each %MAP_PREFETCH 2141 while (my ($k, $v) = each %MAP_PREFETCH) {
1485 or next; 2142 if (my $map = find $k) {
2143 $map->load if $v;
2144 }
2145
1486 my $path = delete $MAP_PREFETCH{$key}; 2146 delete $MAP_PREFETCH{$k};
1487
1488 my $map = find $path
1489 or next;
1490 $map->load;
1491 } 2147 }
1492 Coro::schedule; 2148 }
2149 undef $MAP_PREFETCHER;
1493 } 2150 };
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; 2151 $MAP_PREFETCHER->prio (6);
1508 2152
1509 () 2153 ()
1510} 2154}
1511 2155
1512sub save { 2156sub save {
1513 my ($self) = @_; 2157 my ($self) = @_;
1514 2158
1515 my $lock = cf::lock_acquire "map_data:" . $self->path; 2159 my $lock = cf::lock_acquire "map_data:$self->{path}";
1516 2160
1517 $self->{last_save} = $cf::RUNTIME; 2161 $self->{last_save} = $cf::RUNTIME;
1518 2162
1519 return unless $self->dirty; 2163 return unless $self->dirty;
1520 2164
1521 my $save = $self->{path}->save_path; utf8::encode $save; 2165 my $save = $self->save_path; utf8::encode $save;
1522 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2166 my $uniq = $self->uniq_path; utf8::encode $uniq;
1523 2167
1524 $self->{load_path} = $save; 2168 $self->{load_path} = $save;
1525 2169
1526 return if $self->{deny_save}; 2170 return if $self->{deny_save};
1527 2171
1528 local $self->{last_access} = $self->last_access;#d# 2172 local $self->{last_access} = $self->last_access;#d#
1529 2173
1530 cf::async { 2174 cf::async {
2175 $Coro::current->{desc} = "map player save";
1531 $_->contr->save for $self->players; 2176 $_->contr->save for $self->players;
1532 }; 2177 };
1533 2178
2179 cf::get_slot 0.02;
2180
1534 if ($uniq) { 2181 if ($uniq) {
1535 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2182 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1536 $self->save_objects ($uniq, cf::IO_UNIQUES); 2183 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1537 } else { 2184 } else {
1538 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2185 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1539 } 2186 }
1540} 2187}
1541 2188
1542sub swap_out { 2189sub swap_out {
1543 my ($self) = @_; 2190 my ($self) = @_;
1544 2191
1545 # save first because save cedes 2192 # save first because save cedes
1546 $self->save; 2193 $self->save;
1547 2194
1548 my $lock = cf::lock_acquire "map_data:" . $self->path; 2195 my $lock = cf::lock_acquire "map_data:$self->{path}";
1549 2196
1550 return if $self->players; 2197 return if $self->players;
1551 return if $self->in_memory != cf::MAP_IN_MEMORY; 2198 return if $self->in_memory != cf::MAP_ACTIVE;
1552 return if $self->{deny_save}; 2199 return if $self->{deny_save};
1553 2200
2201 $self->in_memory (cf::MAP_SWAPPED);
2202
2203 $self->deactivate;
2204 $_->clear_links_to ($self) for values %cf::MAP;
1554 $self->clear; 2205 $self->clear;
1555 $self->in_memory (cf::MAP_SWAPPED);
1556} 2206}
1557 2207
1558sub reset_at { 2208sub reset_at {
1559 my ($self) = @_; 2209 my ($self) = @_;
1560 2210
1561 # TODO: safety, remove and allow resettable per-player maps 2211 # TODO: safety, remove and allow resettable per-player maps
1562 return 1e99 if $self->{path}{user_rel};
1563 return 1e99 if $self->{deny_reset}; 2212 return 1e99 if $self->{deny_reset};
1564 2213
1565 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2214 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1566 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2215 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1567 2216
1572 my ($self) = @_; 2221 my ($self) = @_;
1573 2222
1574 $self->reset_at <= $cf::RUNTIME 2223 $self->reset_at <= $cf::RUNTIME
1575} 2224}
1576 2225
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 { 2226sub reset {
1599 my ($self) = @_; 2227 my ($self) = @_;
1600 2228
1601 my $lock = cf::lock_acquire "map_data:" . $self->path; 2229 my $lock = cf::lock_acquire "map_data:$self->{path}";
1602 2230
1603 return if $self->players; 2231 return if $self->players;
1604 return if $self->{path}{user_rel};#d#
1605 2232
1606 warn "resetting map ", $self->path;#d# 2233 warn "resetting map ", $self->path;
2234
2235 $self->in_memory (cf::MAP_SWAPPED);
2236
2237 # need to save uniques path
2238 unless ($self->{deny_save}) {
2239 my $uniq = $self->uniq_path; utf8::encode $uniq;
2240
2241 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2242 if $uniq;
2243 }
1607 2244
1608 delete $cf::MAP{$self->path}; 2245 delete $cf::MAP{$self->path};
1609 2246
2247 $self->deactivate;
1610 $_->clear_links_to ($self) for values %cf::MAP; 2248 $_->clear_links_to ($self) for values %cf::MAP;
2249 $self->clear;
1611 2250
1612 $self->unlink_save; 2251 $self->unlink_save;
1613 $self->destroy; 2252 $self->destroy;
1614} 2253}
1615 2254
1616my $nuke_counter = "aaaa"; 2255my $nuke_counter = "aaaa";
1617 2256
1618sub nuke { 2257sub nuke {
1619 my ($self) = @_; 2258 my ($self) = @_;
1620 2259
2260 {
2261 my $lock = cf::lock_acquire "map_data:$self->{path}";
2262
2263 delete $cf::MAP{$self->path};
2264
2265 $self->unlink_save;
2266
2267 bless $self, "cf::map";
2268 delete $self->{deny_reset};
1621 $self->{deny_save} = 1; 2269 $self->{deny_save} = 1;
1622 $self->reset_timeout (1); 2270 $self->reset_timeout (1);
1623 $self->rename ("{nuke}/" . ($nuke_counter++)); 2271 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2272
2273 $cf::MAP{$self->path} = $self;
2274 }
2275
1624 $self->reset; # polite request, might not happen 2276 $self->reset; # polite request, might not happen
1625} 2277}
1626 2278
1627sub customise_for { 2279=item $maps = cf::map::tmp_maps
1628 my ($map, $ob) = @_;
1629 2280
1630 if ($map->per_player) { 2281Returns an arrayref with all map paths of currently instantiated and saved
1631 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2282maps. May block.
2283
2284=cut
2285
2286sub tmp_maps() {
1632 } 2287 [
1633 2288 map {
1634 $map 2289 utf8::decode $_;
2290 /\.map$/
2291 ? normalise $_
2292 : ()
2293 } @{ aio_readdir $TMPDIR or [] }
2294 ]
1635} 2295}
1636 2296
1637package cf; 2297=item $maps = cf::map::random_maps
2298
2299Returns an arrayref with all map paths of currently instantiated and saved
2300random maps. May block.
2301
2302=cut
2303
2304sub random_maps() {
2305 [
2306 map {
2307 utf8::decode $_;
2308 /\.map$/
2309 ? normalise "?random/$_"
2310 : ()
2311 } @{ aio_readdir $RANDOMDIR or [] }
2312 ]
2313}
2314
2315=item cf::map::unique_maps
2316
2317Returns an arrayref of paths of all shared maps that have
2318instantiated unique items. May block.
2319
2320=cut
2321
2322sub unique_maps() {
2323 [
2324 map {
2325 utf8::decode $_;
2326 s/\.map$//; # TODO future compatibility hack
2327 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2328 ? ()
2329 : normalise $_
2330 } @{ aio_readdir $UNIQUEDIR or [] }
2331 ]
2332}
1638 2333
1639=back 2334=back
1640 2335
1641=head3 cf::object 2336=head3 cf::object
1642 2337
1646 2341
1647=over 4 2342=over 4
1648 2343
1649=item $ob->inv_recursive 2344=item $ob->inv_recursive
1650 2345
1651Returns the inventory of the object _and_ their inventories, recursively. 2346Returns the inventory of the object I<and> their inventories, recursively,
2347but I<not> the object itself.
1652 2348
1653=cut 2349=cut
1654 2350
1655sub inv_recursive_; 2351sub inv_recursive_;
1656sub inv_recursive_ { 2352sub inv_recursive_ {
1659 2355
1660sub inv_recursive { 2356sub inv_recursive {
1661 inv_recursive_ inv $_[0] 2357 inv_recursive_ inv $_[0]
1662} 2358}
1663 2359
2360=item $ref = $ob->ref
2361
2362Creates and returns a persistent reference to an object that can be stored as a string.
2363
2364=item $ob = cf::object::deref ($refstring)
2365
2366returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2367even if the object actually exists. May block.
2368
2369=cut
2370
2371sub deref {
2372 my ($ref) = @_;
2373
2374 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2375 my ($uuid, $name) = ($1, $2);
2376 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2377 or return;
2378 $pl->ob->uuid eq $uuid
2379 or return;
2380
2381 $pl->ob
2382 } else {
2383 warn "$ref: cannot resolve object reference\n";
2384 undef
2385 }
2386}
2387
1664package cf; 2388package cf;
1665 2389
1666=back 2390=back
1667 2391
1668=head3 cf::object::player 2392=head3 cf::object::player
1674Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2398Sends 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 2399can be C<undef>. Does the right thing when the player is currently in a
1676dialogue with the given NPC character. 2400dialogue with the given NPC character.
1677 2401
1678=cut 2402=cut
2403
2404our $SAY_CHANNEL = {
2405 id => "say",
2406 title => "Map",
2407 reply => "say ",
2408 tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
2409};
2410
2411our $CHAT_CHANNEL = {
2412 id => "chat",
2413 title => "Chat",
2414 reply => "chat ",
2415 tooltip => "Player chat and shouts, global to the server.",
2416};
1679 2417
1680# rough implementation of a future "reply" method that works 2418# rough implementation of a future "reply" method that works
1681# with dialog boxes. 2419# with dialog boxes.
1682#TODO: the first argument must go, split into a $npc->reply_to ( method 2420#TODO: the first argument must go, split into a $npc->reply_to ( method
1683sub cf::object::player::reply($$$;$) { 2421sub cf::object::player::reply($$$;$) {
1685 2423
1686 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2424 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1687 2425
1688 if ($self->{record_replies}) { 2426 if ($self->{record_replies}) {
1689 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2427 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2428
1690 } else { 2429 } else {
2430 my $pl = $self->contr;
2431
2432 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2433 my $dialog = $pl->{npc_dialog};
2434 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2435
2436 } else {
1691 $msg = $npc->name . " says: $msg" if $npc; 2437 $msg = $npc->name . " says: $msg" if $npc;
1692 $self->message ($msg, $flags); 2438 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2439 }
1693 } 2440 }
2441}
2442
2443=item $object->send_msg ($channel, $msg, $color, [extra...])
2444
2445=cut
2446
2447sub cf::object::send_msg {
2448 my $pl = shift->contr
2449 or return;
2450 $pl->send_msg (@_);
1694} 2451}
1695 2452
1696=item $player_object->may ("access") 2453=item $player_object->may ("access")
1697 2454
1698Returns wether the given player is authorized to access resource "access" 2455Returns wether the given player is authorized to access resource "access"
1711 2468
1712=item $player_object->enter_link 2469=item $player_object->enter_link
1713 2470
1714Freezes the player and moves him/her to a special map (C<{link}>). 2471Freezes the player and moves him/her to a special map (C<{link}>).
1715 2472
1716The player should be reaosnably safe there for short amounts of time. You 2473The player should be reasonably safe there for short amounts of time (e.g.
1717I<MUST> call C<leave_link> as soon as possible, though. 2474for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2475though, as the palyer cannot control the character while it is on the link
2476map.
2477
2478Will never block.
1718 2479
1719=item $player_object->leave_link ($map, $x, $y) 2480=item $player_object->leave_link ($map, $x, $y)
1720 2481
1721Moves the player out of the specila link map onto the given map. If the 2482Moves 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 2483map. 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, 2484to the location he/she was before the call to C<enter_link>, or, if that
1724to the emergency map position. 2485fails, to the emergency map position.
1725 2486
1726Might block. 2487Might block.
1727 2488
1728=cut 2489=cut
2490
2491sub link_map {
2492 unless ($LINK_MAP) {
2493 $LINK_MAP = cf::map::find "{link}"
2494 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2495 $LINK_MAP->load;
2496 }
2497
2498 $LINK_MAP
2499}
1729 2500
1730sub cf::object::player::enter_link { 2501sub cf::object::player::enter_link {
1731 my ($self) = @_; 2502 my ($self) = @_;
1732 2503
1733 $self->deactivate_recursive; 2504 $self->deactivate_recursive;
1734 2505
1735 return if $self->map == $LINK_MAP; 2506 return if UNIVERSAL::isa $self->map, "ext::map_link";
1736 2507
1737 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2508 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1738 if $self->map; 2509 if $self->map && $self->map->{path} ne "{link}";
1739 2510
1740 $self->enter_map ($LINK_MAP, 20, 20); 2511 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1741} 2512}
1742 2513
1743sub cf::object::player::leave_link { 2514sub cf::object::player::leave_link {
1744 my ($self, $map, $x, $y) = @_; 2515 my ($self, $map, $x, $y) = @_;
2516
2517 return unless $self->contr->active;
1745 2518
1746 my $link_pos = delete $self->{_link_pos}; 2519 my $link_pos = delete $self->{_link_pos};
1747 2520
1748 unless ($map) { 2521 unless ($map) {
1749 # restore original map position 2522 # restore original map position
1763 # use -1 or undef as default coordinates, not 0, 0 2536 # use -1 or undef as default coordinates, not 0, 0
1764 ($x, $y) = ($map->enter_x, $map->enter_y) 2537 ($x, $y) = ($map->enter_x, $map->enter_y)
1765 if $x <=0 && $y <= 0; 2538 if $x <=0 && $y <= 0;
1766 2539
1767 $map->load; 2540 $map->load;
1768 $map->load_diag; 2541 $map->load_neighbours;
1769 2542
1770 return unless $self->contr->active; 2543 return unless $self->contr->active;
2544 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
1771 $self->activate_recursive; 2545 $self->activate_recursive;
2546
2547 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1772 $self->enter_map ($map, $x, $y); 2548 $self->enter_map ($map, $x, $y);
1773} 2549}
1774 2550
1775cf::player->attach ( 2551=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1776 on_logout => sub {
1777 my ($pl) = @_;
1778 2552
1779 # abort map switching before logout 2553Moves the player to the given map-path and coordinates by first freezing
1780 if ($pl->ob->{_link_pos}) { 2554her, loading and preparing them map, calling the provided $check callback
1781 cf::sync_job { 2555that has to return the map if sucecssful, and then unfreezes the player on
1782 $pl->ob->leave_link 2556the new (success) or old (failed) map position. In either case, $done will
1783 }; 2557be called at the end of this process.
1784 }
1785 },
1786 on_login => sub {
1787 my ($pl) = @_;
1788 2558
1789 # try to abort aborted map switching on player login :) 2559Note that $check will be called with a potentially non-loaded map, so if
1790 # should happen only on crashes 2560it 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 2561
1807=item $player_object->goto ($path, $x, $y)
1808
1809=cut 2562=cut
2563
2564our $GOTOGEN;
1810 2565
1811sub cf::object::player::goto { 2566sub cf::object::player::goto {
1812 my ($self, $path, $x, $y) = @_; 2567 my ($self, $path, $x, $y, $check, $done) = @_;
1813 2568
1814 $path = new cf::path $path; 2569 # do generation counting so two concurrent goto's will be executed in-order
1815 $path ne "/" or Carp::cluck ("oy");#d# 2570 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1816 2571
1817 $self->enter_link; 2572 $self->enter_link;
1818 2573
1819 (async { 2574 (async {
1820 my $map = cf::map::find $path->as_string; 2575 $Coro::current->{desc} = "player::goto $path $x $y";
2576
2577 # *tag paths override both path and x|y
2578 if ($path =~ /^\*(.*)$/) {
2579 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2580 my $ob = $obs[rand @obs];
2581
2582 # see if we actually can go there
2583 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2584 $ob = $obs[rand @obs];
2585 } else {
2586 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2587 }
2588 # else put us there anyways for now #d#
2589
2590 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2591 } else {
2592 ($path, $x, $y) = (undef, undef, undef);
2593 }
2594 }
2595
2596 my $map = eval {
2597 my $map = defined $path ? cf::map::find $path : undef;
2598
2599 if ($map) {
1821 $map = $map->customise_for ($self) if $map; 2600 $map = $map->customise_for ($self);
1822 2601 $map = $check->($map) if $check && $map;
1823# warn "entering ", $map->path, " at ($x, $y)\n" 2602 } else {
1824# if $map;
1825
1826 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2603 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2604 }
1827 2605
2606 $map
2607 };
2608
2609 if ($@) {
2610 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2611 LOG llevError | logBacktrace, Carp::longmess $@;
2612 }
2613
2614 if ($gen == $self->{_goto_generation}) {
2615 delete $self->{_goto_generation};
1828 $self->leave_link ($map, $x, $y); 2616 $self->leave_link ($map, $x, $y);
2617 }
2618
2619 $done->() if $done;
1829 })->prio (1); 2620 })->prio (1);
1830} 2621}
1831 2622
1832=item $player_object->enter_exit ($exit_object) 2623=item $player_object->enter_exit ($exit_object)
1833 2624
1835 2626
1836sub parse_random_map_params { 2627sub parse_random_map_params {
1837 my ($spec) = @_; 2628 my ($spec) = @_;
1838 2629
1839 my $rmp = { # defaults 2630 my $rmp = { # defaults
1840 xsize => 10, 2631 xsize => (cf::rndm 15, 40),
1841 ysize => 10, 2632 ysize => (cf::rndm 15, 40),
2633 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2634 #layout => string,
1842 }; 2635 };
1843 2636
1844 for (split /\n/, $spec) { 2637 for (split /\n/, $spec) {
1845 my ($k, $v) = split /\s+/, $_, 2; 2638 my ($k, $v) = split /\s+/, $_, 2;
1846 2639
1858 # that depends on the exit object 2651 # that depends on the exit object
1859 2652
1860 my $rmp = parse_random_map_params $exit->msg; 2653 my $rmp = parse_random_map_params $exit->msg;
1861 2654
1862 if ($exit->map) { 2655 if ($exit->map) {
1863 $rmp->{region} = $exit->map->region_name; 2656 $rmp->{region} = $exit->region->name;
1864 $rmp->{origin_map} = $exit->map->path; 2657 $rmp->{origin_map} = $exit->map->path;
1865 $rmp->{origin_x} = $exit->x; 2658 $rmp->{origin_x} = $exit->x;
1866 $rmp->{origin_y} = $exit->y; 2659 $rmp->{origin_y} = $exit->y;
2660
2661 $exit->map->touch;
1867 } 2662 }
1868 2663
1869 $rmp->{random_seed} ||= $exit->random_seed; 2664 $rmp->{random_seed} ||= $exit->random_seed;
1870 2665
1871 my $data = cf::to_json $rmp; 2666 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1872 my $md5 = Digest::MD5::md5_hex $data; 2667 my $md5 = Digest::MD5::md5_hex $data;
2668 my $meta = "$RANDOMDIR/$md5.meta";
1873 2669
1874 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2670 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1875 aio_write $fh, 0, (length $data), $data, 0; 2671 aio_write $fh, 0, (length $data), $data, 0;
2672 undef $fh;
2673 aio_rename "$meta~", $meta;
1876 2674
2675 my $slaying = "?random/$md5";
2676
2677 if ($exit->valid) {
1877 $exit->slaying ("?random/$md5"); 2678 $exit->slaying ("?random/$md5");
1878 $exit->msg (undef); 2679 $exit->msg (undef);
2680 }
1879 } 2681 }
1880} 2682}
1881 2683
1882sub cf::object::player::enter_exit { 2684sub cf::object::player::enter_exit {
1883 my ($self, $exit) = @_; 2685 my ($self, $exit) = @_;
1885 return unless $self->type == cf::PLAYER; 2687 return unless $self->type == cf::PLAYER;
1886 2688
1887 $self->enter_link; 2689 $self->enter_link;
1888 2690
1889 (async { 2691 (async {
1890 $self->deactivate_recursive; # just to be sure 2692 $Coro::current->{desc} = "enter_exit";
2693
1891 unless (eval { 2694 unless (eval {
2695 $self->deactivate_recursive; # just to be sure
2696
2697 # random map handling
2698 {
2699 my $guard = cf::lock_acquire "exit_prepare:$exit";
2700
1892 prepare_random_map $exit 2701 prepare_random_map $exit
1893 if $exit->slaying eq "/!"; 2702 if $exit->slaying eq "/!";
2703 }
1894 2704
1895 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2705 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1896 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2706 my $x = $exit->stats->hp;
2707 my $y = $exit->stats->sp;
1897 2708
2709 $self->goto ($map, $x, $y);
2710
2711 # if exit is damned, update players death & WoR home-position
2712 $self->contr->savebed ($map, $x, $y)
2713 if $exit->flag (cf::FLAG_DAMNED);
2714
1898 1; 2715 1
1899 }) { 2716 }) {
1900 $self->message ("Something went wrong deep within the crossfire server. " 2717 $self->message ("Something went wrong deep within the deliantra server. "
1901 . "I'll try to bring you back to the map you were before. " 2718 . "I'll try to bring you back to the map you were before. "
1902 . "Please report this to the dungeon master", 2719 . "Please report this to the dungeon master!",
1903 cf::NDI_UNIQUE | cf::NDI_RED); 2720 cf::NDI_UNIQUE | cf::NDI_RED);
1904 2721
1905 warn "ERROR in enter_exit: $@"; 2722 warn "ERROR in enter_exit: $@";
1906 $self->leave_link; 2723 $self->leave_link;
1907 } 2724 }
1908 })->prio (1); 2725 })->prio (1);
1921 2738
1922sub cf::client::send_drawinfo { 2739sub cf::client::send_drawinfo {
1923 my ($self, $text, $flags) = @_; 2740 my ($self, $text, $flags) = @_;
1924 2741
1925 utf8::encode $text; 2742 utf8::encode $text;
1926 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2743 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1927} 2744}
1928 2745
2746=item $client->send_msg ($channel, $msg, $color, [extra...])
2747
2748Send a drawinfo or msg packet to the client, formatting the msg for the
2749client if neccessary. C<$type> should be a string identifying the type of
2750the message, with C<log> being the default. If C<$color> is negative, suppress
2751the message unless the client supports the msg packet.
2752
2753=cut
2754
2755# non-persistent channels (usually the info channel)
2756our %CHANNEL = (
2757 "c/identify" => {
2758 id => "infobox",
2759 title => "Identify",
2760 reply => undef,
2761 tooltip => "Items recently identified",
2762 },
2763 "c/examine" => {
2764 id => "infobox",
2765 title => "Examine",
2766 reply => undef,
2767 tooltip => "Signs and other items you examined",
2768 },
2769 "c/book" => {
2770 id => "infobox",
2771 title => "Book",
2772 reply => undef,
2773 tooltip => "The contents of a note or book",
2774 },
2775 "c/lookat" => {
2776 id => "infobox",
2777 title => "Look",
2778 reply => undef,
2779 tooltip => "What you saw there",
2780 },
2781 "c/who" => {
2782 id => "infobox",
2783 title => "Players",
2784 reply => undef,
2785 tooltip => "Shows players who are currently online",
2786 },
2787 "c/body" => {
2788 id => "infobox",
2789 title => "Body Parts",
2790 reply => undef,
2791 tooltip => "Shows which body parts you posess and are available",
2792 },
2793 "c/skills" => {
2794 id => "infobox",
2795 title => "Skills",
2796 reply => undef,
2797 tooltip => "Shows your experience per skill and item power",
2798 },
2799 "c/uptime" => {
2800 id => "infobox",
2801 title => "Uptime",
2802 reply => undef,
2803 tooltip => "How long the server has been running since last restart",
2804 },
2805 "c/mapinfo" => {
2806 id => "infobox",
2807 title => "Map Info",
2808 reply => undef,
2809 tooltip => "Information related to the maps",
2810 },
2811 "c/party" => {
2812 id => "party",
2813 title => "Party",
2814 reply => "gsay ",
2815 tooltip => "Messages and chat related to your party",
2816 },
2817);
2818
2819sub cf::client::send_msg {
2820 my ($self, $channel, $msg, $color, @extra) = @_;
2821
2822 $msg = $self->pl->expand_cfpod ($msg)
2823 unless $color & cf::NDI_VERBATIM;
2824
2825 $color &= cf::NDI_CLIENT_MASK; # just in case...
2826
2827 # check predefined channels, for the benefit of C
2828 if ($CHANNEL{$channel}) {
2829 $channel = $CHANNEL{$channel};
2830
2831 $self->ext_msg (channel_info => $channel)
2832 if $self->can_msg;
2833
2834 $channel = $channel->{id};
2835
2836 } elsif (ref $channel) {
2837 # send meta info to client, if not yet sent
2838 unless (exists $self->{channel}{$channel->{id}}) {
2839 $self->{channel}{$channel->{id}} = $channel;
2840 $self->ext_msg (channel_info => $channel)
2841 if $self->can_msg;
2842 }
2843
2844 $channel = $channel->{id};
2845 }
2846
2847 return unless @extra || length $msg;
2848
2849 if ($self->can_msg) {
2850 # default colour, mask it out
2851 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2852 if $color & cf::NDI_DEF;
2853
2854 my $pkt = "msg "
2855 . $self->{json_coder}->encode (
2856 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2857 );
2858
2859 # try lzf for large packets
2860 $pkt = "lzf " . Compress::LZF::compress $pkt
2861 if 1024 <= length $pkt and $self->{can_lzf};
2862
2863 # split very large packets
2864 if (8192 < length $pkt and $self->{can_lzf}) {
2865 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2866 $pkt = "frag";
2867 }
2868
2869 $self->send_packet ($pkt);
2870 } else {
2871 if ($color >= 0) {
2872 # replace some tags by gcfclient-compatible ones
2873 for ($msg) {
2874 1 while
2875 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2876 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2877 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2878 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2879 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2880 }
2881
2882 $color &= cf::NDI_COLOR_MASK;
2883
2884 utf8::encode $msg;
2885
2886 if (0 && $msg =~ /\[/) {
2887 # COMMAND/INFO
2888 $self->send_packet ("drawextinfo $color 10 8 $msg")
2889 } else {
2890 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2891 $self->send_packet ("drawinfo $color $msg")
2892 }
2893 }
2894 }
2895}
2896
2897=item $client->ext_msg ($type, @msg)
2898
2899Sends an ext event to the client.
2900
2901=cut
2902
2903sub cf::client::ext_msg($$@) {
2904 my ($self, $type, @msg) = @_;
2905
2906 if ($self->extcmd == 2) {
2907 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2908 } elsif ($self->extcmd == 1) { # TODO: remove
2909 push @msg, msgtype => "event_$type";
2910 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2911 }
2912}
2913
2914=item $client->ext_reply ($msgid, @msg)
2915
2916Sends an ext reply to the client.
2917
2918=cut
2919
2920sub cf::client::ext_reply($$@) {
2921 my ($self, $id, @msg) = @_;
2922
2923 if ($self->extcmd == 2) {
2924 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2925 } elsif ($self->extcmd == 1) {
2926 #TODO: version 1, remove
2927 unshift @msg, msgtype => "reply", msgid => $id;
2928 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2929 }
2930}
1929 2931
1930=item $success = $client->query ($flags, "text", \&cb) 2932=item $success = $client->query ($flags, "text", \&cb)
1931 2933
1932Queues a query to the client, calling the given callback with 2934Queues a query to the client, calling the given callback with
1933the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2935the 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>. 2936C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1935 2937
1936Queries can fail, so check the return code. Or don't, as queries will become 2938Queries can fail, so check the return code. Or don't, as queries will
1937reliable at some point in the future. 2939become reliable at some point in the future.
1938 2940
1939=cut 2941=cut
1940 2942
1941sub cf::client::query { 2943sub cf::client::query {
1942 my ($self, $flags, $text, $cb) = @_; 2944 my ($self, $flags, $text, $cb) = @_;
1950 utf8::encode $text; 2952 utf8::encode $text;
1951 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2953 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1952 2954
1953 $self->send_packet ($self->{query_queue}[0][0]) 2955 $self->send_packet ($self->{query_queue}[0][0])
1954 if @{ $self->{query_queue} } == 1; 2956 if @{ $self->{query_queue} } == 1;
2957
2958 1
1955} 2959}
1956 2960
1957cf::client->attach ( 2961cf::client->attach (
2962 on_connect => sub {
2963 my ($ns) = @_;
2964
2965 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2966 },
1958 on_reply => sub { 2967 on_reply => sub {
1959 my ($ns, $msg) = @_; 2968 my ($ns, $msg) = @_;
1960 2969
1961 # this weird shuffling is so that direct followup queries 2970 # this weird shuffling is so that direct followup queries
1962 # get handled first 2971 # get handled first
1963 my $queue = delete $ns->{query_queue} 2972 my $queue = delete $ns->{query_queue}
1964 or return; # be conservative, not sure how that can happen, but we saw a crash here 2973 or return; # be conservative, not sure how that can happen, but we saw a crash here
1965 2974
1966 (shift @$queue)->[1]->($msg); 2975 (shift @$queue)->[1]->($msg);
2976 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1967 2977
1968 push @{ $ns->{query_queue} }, @$queue; 2978 push @{ $ns->{query_queue} }, @$queue;
1969 2979
1970 if (@{ $ns->{query_queue} } == @$queue) { 2980 if (@{ $ns->{query_queue} } == @$queue) {
1971 if (@$queue) { 2981 if (@$queue) {
1973 } else { 2983 } else {
1974 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2984 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1975 } 2985 }
1976 } 2986 }
1977 }, 2987 },
2988 on_exticmd => sub {
2989 my ($ns, $buf) = @_;
2990
2991 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2992
2993 if (ref $msg) {
2994 my ($type, $reply, @payload) =
2995 "ARRAY" eq ref $msg
2996 ? @$msg
2997 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2998
2999 my @reply;
3000
3001 if (my $cb = $EXTICMD{$type}) {
3002 @reply = $cb->($ns, @payload);
3003 }
3004
3005 $ns->ext_reply ($reply, @reply)
3006 if $reply;
3007
3008 } else {
3009 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3010 }
3011
3012 cf::override;
3013 },
1978); 3014);
1979 3015
1980=item $client->async (\&cb) 3016=item $client->async (\&cb)
1981 3017
1982Create a new coroutine, running the specified callback. The coroutine will 3018Create a new coroutine, running the specified callback. The coroutine will
2023our $safe = new Safe "safe"; 3059our $safe = new Safe "safe";
2024our $safe_hole = new Safe::Hole; 3060our $safe_hole = new Safe::Hole;
2025 3061
2026$SIG{FPE} = 'IGNORE'; 3062$SIG{FPE} = 'IGNORE';
2027 3063
2028$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3064$safe->permit_only (Opcode::opset qw(
3065 :base_core :base_mem :base_orig :base_math
3066 grepstart grepwhile mapstart mapwhile
3067 sort time
3068));
2029 3069
2030# here we export the classes and methods available to script code 3070# here we export the classes and methods available to script code
2031 3071
2032=pod 3072=pod
2033 3073
2034The following fucntions and emthods are available within a safe environment: 3074The following functions and methods are available within a safe environment:
2035 3075
2036 cf::object contr pay_amount pay_player map 3076 cf::object
3077 contr pay_amount pay_player map x y force_find force_add destroy
3078 insert remove name archname title slaying race decrease split
3079
2037 cf::object::player player 3080 cf::object::player
2038 cf::player peaceful 3081 player
2039 cf::map trigger 3082
3083 cf::player
3084 peaceful
3085
3086 cf::map
3087 trigger
2040 3088
2041=cut 3089=cut
2042 3090
2043for ( 3091for (
2044 ["cf::object" => qw(contr pay_amount pay_player map)], 3092 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3093 insert remove inv nrof name archname title slaying race
3094 decrease split destroy change_exp)],
2045 ["cf::object::player" => qw(player)], 3095 ["cf::object::player" => qw(player)],
2046 ["cf::player" => qw(peaceful)], 3096 ["cf::player" => qw(peaceful)],
2047 ["cf::map" => qw(trigger)], 3097 ["cf::map" => qw(trigger)],
2048) { 3098) {
2049 no strict 'refs'; 3099 no strict 'refs';
2120=back 3170=back
2121 3171
2122=cut 3172=cut
2123 3173
2124############################################################################# 3174#############################################################################
3175# the server's init and main functions
2125 3176
2126=head2 EXTENSION DATABASE SUPPORT 3177sub load_facedata($) {
3178 my ($path) = @_;
2127 3179
2128Crossfire maintains a very simple database for extension use. It can 3180 # HACK to clear player env face cache, we need some signal framework
2129currently store anything that can be serialised using Storable, which 3181 # for this (global event?)
2130excludes objects. 3182 %ext::player_env::MUSIC_FACE_CACHE = ();
2131 3183
2132The parameter C<$family> should best start with the name of the extension 3184 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2133using it, it should be unique.
2134 3185
2135=over 4 3186 warn "loading facedata from $path\n";
2136 3187
2137=item $hashref = cf::db_get $family 3188 my $facedata;
3189 0 < aio_load $path, $facedata
3190 or die "$path: $!";
2138 3191
2139Return a hashref for use by the extension C<$family>, which can be 3192 $facedata = Coro::Storable::thaw $facedata;
2140modified. After modifications, you have to call C<cf::db_dirty> or
2141C<cf::db_sync>.
2142 3193
2143=item $value = cf::db_get $family => $key 3194 $facedata->{version} == 2
3195 or cf::cleanup "$path: version mismatch, cannot proceed.";
2144 3196
2145Returns a single value from the database 3197 # patch in the exptable
2146 3198 $facedata->{resource}{"res/exp_table"} = {
2147=item cf::db_put $family => $hashref 3199 type => FT_RSRC,
2148 3200 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 }); 3201 };
3202 cf::cede_to_tick;
2198 3203
2199 sub db_dirty() {
2200 $dirty = 1;
2201 $idle->start;
2202 } 3204 {
3205 my $faces = $facedata->{faceinfo};
2203 3206
2204 sub db_get($;$) { 3207 while (my ($face, $info) = each %$faces) {
2205 @_ >= 2 3208 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2206 ? $DB->{$_[0]}{$_[1]}
2207 : ($DB->{$_[0]} ||= { })
2208 }
2209 3209
2210 sub db_put($$;$) { 3210 cf::face::set_visibility $idx, $info->{visibility};
2211 if (@_ >= 3) { 3211 cf::face::set_magicmap $idx, $info->{magicmap};
2212 $DB->{$_[0]}{$_[1]} = $_[2]; 3212 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2213 } else { 3213 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2214 $DB->{$_[0]} = $_[1];
2215 }
2216 db_dirty;
2217 }
2218 3214
2219 cf::global->attach ( 3215 cf::cede_to_tick;
2220 prio => 10000,
2221 on_cleanup => sub {
2222 db_sync;
2223 }, 3216 }
2224 );
2225}
2226 3217
2227############################################################################# 3218 while (my ($face, $info) = each %$faces) {
2228# the server's main() 3219 next unless $info->{smooth};
2229 3220
2230sub cfg_load { 3221 my $idx = cf::face::find $face
3222 or next;
3223
3224 if (my $smooth = cf::face::find $info->{smooth}) {
3225 cf::face::set_smooth $idx, $smooth;
3226 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3227 } else {
3228 warn "smooth face '$info->{smooth}' not found for face '$face'";
3229 }
3230
3231 cf::cede_to_tick;
3232 }
3233 }
3234
3235 {
3236 my $anims = $facedata->{animinfo};
3237
3238 while (my ($anim, $info) = each %$anims) {
3239 cf::anim::set $anim, $info->{frames}, $info->{facings};
3240 cf::cede_to_tick;
3241 }
3242
3243 cf::anim::invalidate_all; # d'oh
3244 }
3245
3246 {
3247 # TODO: for gcfclient pleasure, we should give resources
3248 # that gcfclient doesn't grok a >10000 face index.
3249 my $res = $facedata->{resource};
3250
3251 while (my ($name, $info) = each %$res) {
3252 if (defined $info->{type}) {
3253 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3254 my $data;
3255
3256 if ($info->{type} & 1) {
3257 # prepend meta info
3258
3259 my $meta = $enc->encode ({
3260 name => $name,
3261 %{ $info->{meta} || {} },
3262 });
3263
3264 $data = pack "(w/a*)*", $meta, $info->{data};
3265 } else {
3266 $data = $info->{data};
3267 }
3268
3269 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3270 cf::face::set_type $idx, $info->{type};
3271 } else {
3272 $RESOURCE{$name} = $info;
3273 }
3274
3275 cf::cede_to_tick;
3276 }
3277 }
3278
3279 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3280
3281 1
3282}
3283
3284cf::global->attach (on_resource_update => sub {
3285 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3286 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3287
3288 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3289 my $sound = $soundconf->{compat}[$_]
3290 or next;
3291
3292 my $face = cf::face::find "sound/$sound->[1]";
3293 cf::sound::set $sound->[0] => $face;
3294 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3295 }
3296
3297 while (my ($k, $v) = each %{$soundconf->{event}}) {
3298 my $face = cf::face::find "sound/$v";
3299 cf::sound::set $k => $face;
3300 }
3301 }
3302});
3303
3304register_exticmd fx_want => sub {
3305 my ($ns, $want) = @_;
3306
3307 while (my ($k, $v) = each %$want) {
3308 $ns->fx_want ($k, $v);
3309 }
3310};
3311
3312sub load_resource_file($) {
3313 my $guard = lock_acquire "load_resource_file";
3314
3315 my $status = load_resource_file_ $_[0];
3316 get_slot 0.1, 100;
3317 cf::arch::commit_load;
3318
3319 $status
3320}
3321
3322sub reload_regions {
3323 # HACK to clear player env face cache, we need some signal framework
3324 # for this (global event?)
3325 %ext::player_env::MUSIC_FACE_CACHE = ();
3326
3327 load_resource_file "$MAPDIR/regions"
3328 or die "unable to load regions file\n";
3329
3330 for (cf::region::list) {
3331 $_->{match} = qr/$_->{match}/
3332 if exists $_->{match};
3333 }
3334}
3335
3336sub reload_facedata {
3337 load_facedata "$DATADIR/facedata"
3338 or die "unable to load facedata\n";
3339}
3340
3341sub reload_archetypes {
3342 load_resource_file "$DATADIR/archetypes"
3343 or die "unable to load archetypes\n";
3344}
3345
3346sub reload_treasures {
3347 load_resource_file "$DATADIR/treasures"
3348 or die "unable to load treasurelists\n";
3349}
3350
3351sub reload_resources {
3352 warn "reloading resource files...\n";
3353
3354 reload_facedata;
3355 reload_archetypes;
3356 reload_regions;
3357 reload_treasures;
3358
3359 warn "finished reloading resource files\n";
3360}
3361
3362sub reload_config {
2231 open my $fh, "<:utf8", cf::confdir . "/config" 3363 open my $fh, "<:utf8", "$CONFDIR/config"
2232 or return; 3364 or return;
2233 3365
2234 local $/; 3366 local $/;
2235 *CFG = YAML::Syck::Load <$fh>; 3367 *CFG = YAML::Load <$fh>;
2236 3368
2237 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3369 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2238 3370
2239 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3371 $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}; 3372 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2246 }; 3378 };
2247 warn $@ if $@; 3379 warn $@ if $@;
2248 } 3380 }
2249} 3381}
2250 3382
3383sub pidfile() {
3384 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3385 or die "$PIDFILE: $!";
3386 flock $fh, &Fcntl::LOCK_EX
3387 or die "$PIDFILE: flock: $!";
3388 $fh
3389}
3390
3391# make sure only one server instance is running at any one time
3392sub atomic {
3393 my $fh = pidfile;
3394
3395 my $pid = <$fh>;
3396 kill 9, $pid if $pid > 0;
3397
3398 seek $fh, 0, 0;
3399 print $fh $$;
3400}
3401
2251sub main { 3402sub main {
3403 cf::init_globals; # initialise logging
3404
3405 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3406 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3407 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3408 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3409
3410 cf::init_experience;
3411 cf::init_anim;
3412 cf::init_attackmess;
3413 cf::init_dynamic;
3414 cf::init_block;
3415
3416 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3417
2252 # we must not ever block the main coroutine 3418 # we must not ever block the main coroutine
2253 local $Coro::idle = sub { 3419 local $Coro::idle = sub {
2254 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3420 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2255 async { Event::one_event }; 3421 (async {
3422 $Coro::current->{desc} = "IDLE BUG HANDLER";
3423 EV::loop EV::LOOP_ONESHOT;
3424 })->prio (Coro::PRIO_MAX);
2256 }; 3425 };
2257 3426
2258 cfg_load; 3427 evthread_start IO::AIO::poll_fileno;
2259 db_load; 3428
3429 cf::sync_job {
3430 reload_resources;
3431 reload_config;
3432 db_init;
3433
3434 cf::load_settings;
3435 cf::load_materials;
3436 cf::init_uuid;
3437 cf::init_signals;
3438 cf::init_commands;
3439 cf::init_skills;
3440
3441 cf::init_beforeplay;
3442
3443 atomic;
3444
2260 load_extensions; 3445 load_extensions;
3446
3447 utime time, time, $RUNTIMEFILE;
3448
3449 # no (long-running) fork's whatsoever before this point(!)
3450 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3451
3452 (pop @POST_INIT)->(0) while @POST_INIT;
3453 };
3454
2261 Event::loop; 3455 EV::loop;
2262} 3456}
2263 3457
2264############################################################################# 3458#############################################################################
2265# initialisation and cleanup 3459# initialisation and cleanup
2266 3460
2267# install some emergency cleanup handlers 3461# install some emergency cleanup handlers
2268BEGIN { 3462BEGIN {
3463 our %SIGWATCHER = ();
2269 for my $signal (qw(INT HUP TERM)) { 3464 for my $signal (qw(INT HUP TERM)) {
2270 Event->signal ( 3465 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2271 data => WF_AUTOCANCEL,
2272 signal => $signal,
2273 cb => sub {
2274 cf::cleanup "SIG$signal"; 3466 cf::cleanup "SIG$signal";
2275 },
2276 ); 3467 };
3468 }
3469}
3470
3471sub write_runtime_sync {
3472 # first touch the runtime file to show we are still running:
3473 # the fsync below can take a very very long time.
3474
3475 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3476
3477 my $guard = cf::lock_acquire "write_runtime";
3478
3479 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3480 or return;
3481
3482 my $value = $cf::RUNTIME + 90 + 10;
3483 # 10 is the runtime save interval, for a monotonic clock
3484 # 60 allows for the watchdog to kill the server.
3485
3486 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3487 and return;
3488
3489 # always fsync - this file is important
3490 aio_fsync $fh
3491 and return;
3492
3493 # touch it again to show we are up-to-date
3494 aio_utime $fh, undef, undef;
3495
3496 close $fh
3497 or return;
3498
3499 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3500 and return;
3501
3502 warn "runtime file written.\n";
3503
2277 } 3504 1
3505}
3506
3507our $uuid_lock;
3508our $uuid_skip;
3509
3510sub write_uuid_sync($) {
3511 $uuid_skip ||= $_[0];
3512
3513 return if $uuid_lock;
3514 local $uuid_lock = 1;
3515
3516 my $uuid = "$LOCALDIR/uuid";
3517
3518 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3519 or return;
3520
3521 my $value = uuid_seq uuid_cur;
3522
3523 if ($value < 1024) {
3524 warn "cowardly refusing to write low uuid value ($value)!\n";
3525 return;
3526 }
3527
3528 my $value = uuid_str $value + $uuid_skip;
3529 $uuid_skip = 0;
3530
3531 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3532 and return;
3533
3534 # always fsync - this file is important
3535 aio_fsync $fh
3536 and return;
3537
3538 close $fh
3539 or return;
3540
3541 aio_rename "$uuid~", $uuid
3542 and return;
3543
3544 warn "uuid file written ($value).\n";
3545
3546 1
3547
3548}
3549
3550sub write_uuid($$) {
3551 my ($skip, $sync) = @_;
3552
3553 $sync ? write_uuid_sync $skip
3554 : async { write_uuid_sync $skip };
2278} 3555}
2279 3556
2280sub emergency_save() { 3557sub emergency_save() {
2281 my $freeze_guard = cf::freeze_mainloop; 3558 my $freeze_guard = cf::freeze_mainloop;
2282 3559
2283 warn "enter emergency perl save\n"; 3560 warn "enter emergency perl save\n";
2284 3561
2285 cf::sync_job { 3562 cf::sync_job {
2286 # use a peculiar iteration method to avoid tripping on perl 3563 # use a peculiar iteration method to avoid tripping on perl
2287 # refcount bugs in for. also avoids problems with players 3564 # refcount bugs in for. also avoids problems with players
2288 # and maps saved/Destroyed asynchronously. 3565 # and maps saved/destroyed asynchronously.
2289 warn "begin emergency player save\n"; 3566 warn "begin emergency player save\n";
2290 for my $login (keys %cf::PLAYER) { 3567 for my $login (keys %cf::PLAYER) {
2291 my $pl = $cf::PLAYER{$login} or next; 3568 my $pl = $cf::PLAYER{$login} or next;
2292 $pl->valid or next; 3569 $pl->valid or next;
3570 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2293 $pl->save; 3571 $pl->save;
2294 } 3572 }
2295 warn "end emergency player save\n"; 3573 warn "end emergency player save\n";
2296 3574
2297 warn "begin emergency map save\n"; 3575 warn "begin emergency map save\n";
2299 my $map = $cf::MAP{$path} or next; 3577 my $map = $cf::MAP{$path} or next;
2300 $map->valid or next; 3578 $map->valid or next;
2301 $map->save; 3579 $map->save;
2302 } 3580 }
2303 warn "end emergency map save\n"; 3581 warn "end emergency map save\n";
3582
3583 warn "begin emergency database checkpoint\n";
3584 BDB::db_env_txn_checkpoint $DB_ENV;
3585 warn "end emergency database checkpoint\n";
3586
3587 warn "begin write uuid\n";
3588 write_uuid_sync 1;
3589 warn "end write uuid\n";
2304 }; 3590 };
2305 3591
2306 warn "leave emergency perl save\n"; 3592 warn "leave emergency perl save\n";
2307} 3593}
2308 3594
3595sub post_cleanup {
3596 my ($make_core) = @_;
3597
3598 warn Carp::longmess "post_cleanup backtrace"
3599 if $make_core;
3600
3601 my $fh = pidfile;
3602 unlink $PIDFILE if <$fh> == $$;
3603}
3604
3605# a safer delete_package, copied from Symbol
3606sub clear_package($) {
3607 my $pkg = shift;
3608
3609 # expand to full symbol table name if needed
3610 unless ($pkg =~ /^main::.*::$/) {
3611 $pkg = "main$pkg" if $pkg =~ /^::/;
3612 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3613 $pkg .= '::' unless $pkg =~ /::$/;
3614 }
3615
3616 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3617 my $stem_symtab = *{$stem}{HASH};
3618
3619 defined $stem_symtab and exists $stem_symtab->{$leaf}
3620 or return;
3621
3622 # clear all symbols
3623 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3624 for my $name (keys %$leaf_symtab) {
3625 _gv_clear *{"$pkg$name"};
3626# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3627 }
3628 warn "cleared package $pkg\n";#d#
3629}
3630
2309sub reload() { 3631sub do_reload_perl() {
2310 # can/must only be called in main 3632 # can/must only be called in main
2311 if ($Coro::current != $Coro::main) { 3633 if ($Coro::current != $Coro::main) {
2312 warn "can only reload from main coroutine\n"; 3634 warn "can only reload from main coroutine";
2313 return; 3635 return;
2314 } 3636 }
2315 3637
3638 return if $RELOAD++;
3639
3640 while ($RELOAD) {
2316 warn "reloading..."; 3641 warn "reloading...";
2317 3642
2318 my $guard = freeze_mainloop; 3643 warn "entering sync_job";
3644
3645 cf::sync_job {
3646 cf::write_runtime_sync; # external watchdog should not bark
2319 cf::emergency_save; 3647 cf::emergency_save;
3648 cf::write_runtime_sync; # external watchdog should not bark
2320 3649
2321 eval { 3650 warn "syncing database to disk";
3651 BDB::db_env_txn_checkpoint $DB_ENV;
3652
2322 # if anything goes wrong in here, we should simply crash as we already saved 3653 # if anything goes wrong in here, we should simply crash as we already saved
2323 3654
2324 # cancel all watchers 3655 warn "flushing outstanding aio requests";
2325 for (Event::all_watchers) { 3656 while (IO::AIO::nreqs || BDB::nreqs) {
2326 $_->cancel if $_->data & WF_AUTOCANCEL; 3657 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 } 3658 }
2352 3659
2353 Symbol::delete_package $k; 3660 warn "cancelling all extension coros";
3661 $_->cancel for values %EXT_CORO;
3662 %EXT_CORO = ();
3663
3664 warn "removing commands";
3665 %COMMAND = ();
3666
3667 warn "removing ext/exti commands";
3668 %EXTCMD = ();
3669 %EXTICMD = ();
3670
3671 warn "unloading/nuking all extensions";
3672 for my $pkg (@EXTS) {
3673 warn "... unloading $pkg";
3674
3675 if (my $cb = $pkg->can ("unload")) {
3676 eval {
3677 $cb->($pkg);
3678 1
3679 } or warn "$pkg unloaded, but with errors: $@";
3680 }
3681
3682 warn "... clearing $pkg";
3683 clear_package $pkg;
2354 } 3684 }
2355 3685
2356 # sync database to disk 3686 warn "unloading all perl modules loaded from $LIBDIR";
2357 cf::db_sync; 3687 while (my ($k, $v) = each %INC) {
2358 IO::AIO::flush; 3688 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2359 3689
3690 warn "... unloading $k";
3691 delete $INC{$k};
3692
3693 $k =~ s/\.pm$//;
3694 $k =~ s/\//::/g;
3695
3696 if (my $cb = $k->can ("unload_module")) {
3697 $cb->();
3698 }
3699
3700 clear_package $k;
3701 }
3702
2360 # get rid of safe::, as good as possible 3703 warn "getting rid of safe::, as good as possible";
2361 Symbol::delete_package "safe::$_" 3704 clear_package "safe::$_"
2362 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3705 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2363 3706
2364 # remove register_script_function callbacks 3707 warn "unloading cf.pm \"a bit\"";
2365 # TODO
2366
2367 # unload cf.pm "a bit"
2368 delete $INC{"cf.pm"}; 3708 delete $INC{"cf.pm"};
3709 delete $INC{"cf/pod.pm"};
2369 3710
2370 # don't, removes xs symbols, too, 3711 # don't, removes xs symbols, too,
2371 # and global variables created in xs 3712 # and global variables created in xs
2372 #Symbol::delete_package __PACKAGE__; 3713 #clear_package __PACKAGE__;
2373 3714
2374 # reload cf.pm 3715 warn "unload completed, starting to reload now";
3716
2375 warn "reloading cf.pm"; 3717 warn "reloading cf.pm";
2376 require cf; 3718 require cf;
2377 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3719 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2378 3720
2379 # load config and database again 3721 warn "loading config and database again";
2380 cf::cfg_load; 3722 cf::reload_config;
2381 cf::db_load;
2382 3723
2383 # load extensions
2384 warn "load extensions"; 3724 warn "loading extensions";
2385 cf::load_extensions; 3725 cf::load_extensions;
2386 3726
2387 # reattach attachments to objects 3727 warn "reattaching attachments to objects/players";
2388 warn "reattach"; 3728 _global_reattach; # objects, sockets
2389 _global_reattach; 3729 warn "reattaching attachments to maps";
2390 reattach $_ for values %MAP; 3730 reattach $_ for values %MAP;
3731 warn "reattaching attachments to players";
3732 reattach $_ for values %PLAYER;
3733
3734 warn "running post_load";
3735 (pop @POST_INIT)->(1) while @POST_INIT;
3736
3737 warn "leaving sync_job";
3738
3739 1
3740 } or do {
3741 warn $@;
3742 cf::cleanup "error while reloading, exiting.";
3743 };
3744
3745 warn "reloaded";
3746 --$RELOAD;
3747 }
3748};
3749
3750our $RELOAD_WATCHER; # used only during reload
3751
3752sub reload_perl() {
3753 # doing reload synchronously and two reloads happen back-to-back,
3754 # coro crashes during coro_state_free->destroy here.
3755
3756 $RELOAD_WATCHER ||= EV::timer $TICK * 1.5, 0, sub {
3757 do_reload_perl;
3758 undef $RELOAD_WATCHER;
2391 }; 3759 };
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} 3760}
2444
2445register "<global>", __PACKAGE__;
2446 3761
2447register_command "reload" => sub { 3762register_command "reload" => sub {
2448 my ($who, $arg) = @_; 3763 my ($who, $arg) = @_;
2449 3764
2450 if ($who->flag (FLAG_WIZ)) { 3765 if ($who->flag (FLAG_WIZ)) {
2451 $who->message ("start of reload.");
2452 reload;
2453 $who->message ("end of reload."); 3766 $who->message ("reloading server.");
3767 async {
3768 $Coro::current->{desc} = "perl_reload";
3769 reload_perl;
3770 };
2454 } 3771 }
2455}; 3772};
2456 3773
2457unshift @INC, $LIBDIR; 3774unshift @INC, $LIBDIR;
2458 3775
2459$TICK_WATCHER = Event->timer ( 3776my $bug_warning = 0;
2460 reentrant => 0, 3777
2461 prio => 0, 3778our @WAIT_FOR_TICK;
2462 at => $NEXT_TICK || $TICK, 3779our @WAIT_FOR_TICK_BEGIN;
2463 data => WF_AUTOCANCEL, 3780
2464 cb => sub { 3781sub wait_for_tick {
3782 return if tick_inhibit || $Coro::current == $Coro::main;
3783
3784 my $signal = new Coro::Signal;
3785 push @WAIT_FOR_TICK, $signal;
3786 $signal->wait;
3787}
3788
3789sub wait_for_tick_begin {
3790 return if tick_inhibit || $Coro::current == $Coro::main;
3791
3792 my $signal = new Coro::Signal;
3793 push @WAIT_FOR_TICK_BEGIN, $signal;
3794 $signal->wait;
3795}
3796
3797sub tick {
3798 if ($Coro::current != $Coro::main) {
3799 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3800 unless ++$bug_warning > 10;
3801 return;
3802 }
3803
2465 cf::server_tick; # one server iteration 3804 cf::server_tick; # one server iteration
2466 $RUNTIME += $TICK;
2467 $NEXT_TICK += $TICK;
2468 3805
2469 $WAIT_FOR_TICK->broadcast; 3806 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2470 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3807 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2471 3808 Coro::async_pool {
2472 # if we are delayed by four ticks or more, skip them all 3809 $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 3810 write_runtime_sync
2497 or warn "ERROR: unable to write runtime file: $!"; 3811 or warn "ERROR: unable to write runtime file: $!";
2498 })->(); 3812 };
2499 }, 3813 }
2500); 3814
3815 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3816 $sig->send;
3817 }
3818 while (my $sig = shift @WAIT_FOR_TICK) {
3819 $sig->send;
3820 }
3821
3822 $LOAD = ($NOW - $TICK_START) / $TICK;
3823 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3824
3825 if (0) {
3826 if ($NEXT_TICK) {
3827 my $jitter = $TICK_START - $NEXT_TICK;
3828 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3829 warn "jitter $JITTER\n";#d#
3830 }
3831 }
3832}
3833
3834{
3835 # configure BDB
3836
3837 BDB::min_parallel 8;
3838 BDB::max_poll_reqs $TICK * 0.1;
3839 $AnyEvent::BDB::WATCHER->priority (1);
3840
3841 unless ($DB_ENV) {
3842 $DB_ENV = BDB::db_env_create;
3843 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3844 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3845 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3846 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3847 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3848
3849 cf::sync_job {
3850 eval {
3851 BDB::db_env_open
3852 $DB_ENV,
3853 $BDBDIR,
3854 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3855 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3856 0666;
3857
3858 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3859 };
3860
3861 cf::cleanup "db_env_open(db): $@" if $@;
3862 };
3863 }
3864
3865 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3866 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3867 };
3868 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3869 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3870 };
3871 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3872 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3873 };
3874}
3875
3876{
3877 # configure IO::AIO
3878
3879 IO::AIO::min_parallel 8;
3880 IO::AIO::max_poll_time $TICK * 0.1;
3881 undef $AnyEvent::AIO::WATCHER;
3882}
3883
3884my $_log_backtrace;
3885
3886sub _log_backtrace {
3887 my ($msg, @addr) = @_;
3888
3889 $msg =~ s/\n//;
3890
3891 # limit the # of concurrent backtraces
3892 if ($_log_backtrace < 2) {
3893 ++$_log_backtrace;
3894 my $perl_bt = Carp::longmess $msg;
3895 async {
3896 $Coro::current->{desc} = "abt $msg";
3897
3898 my @bt = fork_call {
3899 @addr = map { sprintf "%x", $_ } @addr;
3900 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3901 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3902 or die "addr2line: $!";
3903
3904 my @funcs;
3905 my @res = <$fh>;
3906 chomp for @res;
3907 while (@res) {
3908 my ($func, $line) = splice @res, 0, 2, ();
3909 push @funcs, "[$func] $line";
3910 }
3911
3912 @funcs
3913 };
3914
3915 LOG llevInfo, "[ABT] $perl_bt\n";
3916 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3917 LOG llevInfo, "[ABT] $_\n" for @bt;
3918 --$_log_backtrace;
3919 };
3920 } else {
3921 LOG llevInfo, "[ABT] $msg\n";
3922 LOG llevInfo, "[ABT] [suppressed]\n";
3923 }
3924}
3925
3926# load additional modules
3927use cf::pod;
2501 3928
2502END { cf::emergency_save } 3929END { cf::emergency_save }
2503 3930
25041 39311
2505 3932

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines