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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.465 by root, Thu Jan 8 00:54:55 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines