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.163 by root, Thu Jan 11 01:01:56 2007 UTC vs.
Revision 1.459 by root, Sat Dec 13 21:46:12 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines