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.133 by root, Thu Jan 4 16:19:32 2007 UTC vs.
Revision 1.326 by root, Tue Jul 31 17:33:15 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
26use BDB ();
27use Data::Dumper;
20use Digest::MD5; 28use Digest::MD5;
21use Fcntl; 29use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 30use YAML::Syck ();
31use IO::AIO 2.32 ();
24use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
25 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
27 43
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
30 46
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 48
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 50
35our %COMMAND = (); 51our %COMMAND = ();
36our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
53
54our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
57our %EXT_CORO = (); # coroutines bound to extensions
58our %EXT_MAP = (); # pluggable maps
38 59
60our $RELOAD; # number of reloads so far
39our @EVENT; 61our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 62
42our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 76our $TICK_WATCHER;
77our $AIO_POLL_WATCHER;
78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 79our $NEXT_TICK;
45our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
46 85
47our %CFG; 86our %CFG;
48 87
49our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 89our $RUNTIME;
51 90
91our %PLAYER; # all users
52our %MAP; # all maps 92our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 93our $LINK_MAP; # the special {link} map, which is always available
54our $RANDOM_MAPS = cf::localdir . "/random"; 94
55our %EXT_CORO; 95# used to convert map paths into valid unix filenames by replacing / by ∕
96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
56 101
57binmode STDOUT; 102binmode STDOUT;
58binmode STDERR; 103binmode STDERR;
59 104
60# read virtual server time, if available 105# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
63 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
65} 110}
66 111
67mkdir cf::localdir; 112mkdir $_
68mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 114
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
76 118
77############################################################################# 119#############################################################################
78 120
79=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
80 122
87=item $cf::RUNTIME 129=item $cf::RUNTIME
88 130
89The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
90every server tick. 132every server tick.
91 133
92=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93 137
94The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
95be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
96 142
97=item $cf::NOW 143=item $cf::NOW
98 144
99The time of the last (current) server tick. 145The time of the last (current) server tick.
100 146
101=item $cf::TICK 147=item $cf::TICK
102 148
103The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
104 160
105=item %cf::CFG 161=item %cf::CFG
106 162
107Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 164from wherever your confdir points to.
165
166=item cf::wait_for_tick, cf::wait_for_tick_begin
167
168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
169returns directly I<after> the tick processing (and consequently, can only wake one process
170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
109 177
110=back 178=back
111 179
112=cut 180=cut
113 181
114BEGIN { 182BEGIN {
115 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 184 my $msg = join "", @_;
117 utf8::encode $msg;
118 185
119 $msg .= "\n" 186 $msg .= "\n"
120 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
121 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
122 LOG llevError, "cfperl: $msg"; 192 LOG llevError, $msg;
123 }; 193 };
124} 194}
125 195
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
131@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
132 203
133# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
134# within the Safe compartment. 205# within the Safe compartment.
135for my $pkg (qw( 206for my $pkg (qw(
136 cf::global cf::attachable 207 cf::global cf::attachable
145 216
146$Event::DIED = sub { 217$Event::DIED = sub {
147 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
148}; 219};
149 220
150my %ext_pkg; 221#############################################################################
151my @exts;
152my @hook;
153 222
154=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
155 224
156=over 4 225=over 4
157 226
158=cut 227=item dumpval $ref
159 228
160use JSON::Syck (); # TODO# replace by JSON::PC once working 229=cut
230
231sub dumpval {
232 eval {
233 local $SIG{__DIE__};
234 my $d;
235 if (1) {
236 $d = new Data::Dumper([$_[0]], ["*var"]);
237 $d->Terse(1);
238 $d->Indent(2);
239 $d->Quotekeys(0);
240 $d->Useqq(1);
241 #$d->Bless(...);
242 $d->Seen($_[1]) if @_ > 1;
243 $d = $d->Dump();
244 }
245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
246 $d
247 } || "[unable to dump $_[0]: '$@']";
248}
161 249
162=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
163 251
164Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
165 253
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
174 255
175Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
176 257
177=cut 258=cut
178 259
179sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181 JSON::Syck::Dump $_[0]
182}
183 261
184=item my $guard = cf::guard { BLOCK } 262sub to_json ($) { $json_coder->encode ($_[0]) }
185 263sub from_json ($) { $json_coder->decode ($_[0]) }
186Run the given callback when the guard object gets destroyed (useful for
187coroutine cancellations).
188
189You can call C<< ->cancel >> on the guard object to stop the block from
190being executed.
191
192=cut
193
194sub guard(&) {
195 bless \(my $cb = $_[0]), cf::guard::;
196}
197
198sub cf::guard::cancel {
199 ${$_[0]} = sub { };
200}
201
202sub cf::guard::DESTROY {
203 ${$_[0]}->();
204}
205 264
206=item cf::lock_wait $string 265=item cf::lock_wait $string
207 266
208Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
209 268
210=item my $lock = cf::lock_acquire $string 269=item my $lock = cf::lock_acquire $string
211 270
212Wait until the given lock is available and then acquires it and returns 271Wait until the given lock is available and then acquires it and returns
213a guard object. If the guard object gets destroyed (goes out of scope, 272a Coro::guard object. If the guard object gets destroyed (goes out of scope,
214for example when the coroutine gets canceled), the lock is automatically 273for example when the coroutine gets canceled), the lock is automatically
215returned. 274returned.
216 275
217Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
218uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
219 282
220=cut 283=cut
221 284
222our %LOCK; 285our %LOCK;
223 286
237 # wait, to be sure we are not locked 300 # wait, to be sure we are not locked
238 lock_wait $key; 301 lock_wait $key;
239 302
240 $LOCK{$key} = []; 303 $LOCK{$key} = [];
241 304
242 cf::guard { 305 Coro::guard {
243 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
244 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
245 } 308 }
246} 309}
247 310
248=item cf::async { BLOCK } 311sub lock_active($) {
249
250Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
251error instead of exiting the server in case of a problem.
252
253=cut
254
255sub async(&) {
256 my ($cb) = @_; 312 my ($key) = @_;
257 313
258 Coro::async { 314 ! ! $LOCK{$key}
259 eval { $cb->() };
260 warn $@ if $@;
261 }
262} 315}
263 316
264sub freeze_mainloop { 317sub freeze_mainloop {
265 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
266 319
267 my $guard = guard { $TICK_WATCHER->start }; 320 my $guard = Coro::guard {
321 $TICK_WATCHER->start;
322 };
268 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
269 $guard 324 $guard
270} 325}
271 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
383=item cf::async { BLOCK }
384
385Currently the same as Coro::async_pool, meaning you cannot use
386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
387thing you are allowed to do is call C<prio> on it.
388
389=cut
390
391BEGIN { *async = \&Coro::async_pool }
392
272=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
273 394
274The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
275always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
276reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
277 399
278If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
279the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
280server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
281fast or be very important. 403fast or be very important.
284 406
285sub sync_job(&) { 407sub sync_job(&) {
286 my ($job) = @_; 408 my ($job) = @_;
287 409
288 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
289 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
290 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
291 415
292 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
293 # (but this is cancel-safe) 417 # (but this is cancel-safe)
294 my $freeze_guard = freeze_mainloop; 418 my $freeze_guard = freeze_mainloop;
295 419
296 my $busy = 1; 420 my $busy = 1;
297 my @res; 421 my @res;
298 422
299 (Coro::async { 423 (async {
300 @res = eval { $job->() }; 424 @res = eval { $job->() };
301 warn $@ if $@; 425 warn $@ if $@;
302 undef $busy; 426 undef $busy;
303 })->prio (Coro::PRIO_MAX); 427 })->prio (Coro::PRIO_MAX);
304 428
305 while ($busy) { 429 while ($busy) {
306 Coro::cede_notself; 430 Coro::cede or Event::one_event;
307 Event::one_event unless Coro::nready;
308 } 431 }
432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
309 439
310 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
311 } else { 441 } else {
312 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
313 443
314 $job->() 444 $job->()
315 } 445 }
316} 446}
317 447
318=item $coro = cf::coro { BLOCK } 448=item $coro = cf::async_ext { BLOCK }
319 449
320Creates and returns a new coro. This coro is automcatially being canceled 450Like async, but this coro is automatically being canceled when the
321when the extension calling this is being unloaded. 451extension calling this is being unloaded.
322 452
323=cut 453=cut
324 454
325sub coro(&) { 455sub async_ext(&) {
326 my $cb = shift; 456 my $cb = shift;
327 457
328 my $coro = &cf::async ($cb); 458 my $coro = &Coro::async ($cb);
329 459
330 $coro->on_destroy (sub { 460 $coro->on_destroy (sub {
331 delete $EXT_CORO{$coro+0}; 461 delete $EXT_CORO{$coro+0};
332 }); 462 });
333 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
334 464
335 $coro 465 $coro
336} 466}
337 467
338sub write_runtime { 468=item fork_call { }, $args
339 my $runtime = cf::localdir . "/runtime";
340 469
341 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
342 or return; 471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
343 474
344 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
345 (aio_write $fh, 0, (length $value), $value, 0) <= 0
346 and return;
347 476
348 aio_fsync $fh 477sub _store_scalar {
349 and return; 478 open my $fh, ">", \my $buf
350 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
351 close $fh 481 close $fh;
352 or return;
353 482
354 aio_rename "$runtime~", $runtime 483 $buf
355 and return; 484}
356 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
357 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
358} 655}
359 656
360=back 657=back
361 658
362=cut 659=cut
363
364#############################################################################
365
366package cf::path;
367
368sub new {
369 my ($class, $path, $base) = @_;
370
371 $path = $path->as_string if ref $path;
372
373 my $self = bless { }, $class;
374
375 # {... are special paths that are not touched
376 # ?xxx/... are special absolute paths
377 # ?random/... random maps
378 # /! non-realised random map exit
379 # /... normal maps
380 # ~/... per-player maps without a specific player (DO NOT USE)
381 # ~user/... per-player map of a specific user
382
383 if ($path =~ /^{/) {
384 # fine as it is
385 } elsif ($path =~ s{^\?random/}{}) {
386 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387 $self->{random} = cf::from_json $data;
388 } else {
389 if ($path =~ s{^~([^/]+)?}{}) {
390 $self->{user_rel} = 1;
391
392 if (defined $1) {
393 $self->{user} = $1;
394 } elsif ($base =~ m{^~([^/]+)/}) {
395 $self->{user} = $1;
396 } else {
397 warn "cannot resolve user-relative path without user <$path,$base>\n";
398 }
399 } elsif ($path =~ /^\//) {
400 # already absolute
401 } else {
402 $base =~ s{[^/]+/?$}{};
403 return $class->new ("$base/$path");
404 }
405
406 for ($path) {
407 redo if s{/\.?/}{/};
408 redo if s{/[^/]+/\.\./}{/};
409 }
410 }
411
412 $self->{path} = $path;
413
414 $self
415}
416
417# the name / primary key / in-game path
418sub as_string {
419 my ($self) = @_;
420
421 $self->{user_rel} ? "~$self->{user}$self->{path}"
422 : $self->{random} ? "?random/$self->{path}"
423 : $self->{path}
424}
425
426# the displayed name, this is a one way mapping
427sub visible_name {
428 my ($self) = @_;
429
430# if (my $rmp = $self->{random}) {
431# # todo: be more intelligent about this
432# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433# } else {
434 $self->as_string
435# }
436}
437
438# escape the /'s in the path
439sub _escaped_path {
440 # ∕ is U+2215
441 (my $path = $_[0]{path}) =~ s/\//∕/g;
442 $path
443}
444
445# the original (read-only) location
446sub load_path {
447 my ($self) = @_;
448
449 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450}
451
452# the temporary/swap location
453sub save_path {
454 my ($self) = @_;
455
456 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459}
460
461# the unique path, might be eq to save_path
462sub uniq_path {
463 my ($self) = @_;
464
465 $self->{user_rel} || $self->{random}
466 ? undef
467 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468}
469
470# return random map parameters, or undef
471sub random_map_params {
472 my ($self) = @_;
473
474 $self->{random}
475}
476
477# this is somewhat ugly, but style maps do need special treatment
478sub is_style_map {
479 $_[0]{path} =~ m{^/styles/}
480}
481
482package cf;
483 660
484############################################################################# 661#############################################################################
485 662
486=head2 ATTACHABLE OBJECTS 663=head2 ATTACHABLE OBJECTS
487 664
489attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
490to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
491 668
492In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
493C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
494crossfire+). 671Crossfire TRT).
495 672
496=over 4 673=over 4
497 674
498=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
499 676
613our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
614our @CB_MAP = (); 791our @CB_MAP = ();
615 792
616my %attachment; 793my %attachment;
617 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
618sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
619 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
620 803
621 use sort 'stable'; 804 use sort 'stable';
622 805
656 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
657 840
658 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
659 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
660 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
661 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662 845
663 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
664 my $pkg = shift @arg; 847 my $pkg = shift @arg;
665 848
666 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
695 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
696 } 879 }
697 880
698 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
699 } else { 882 } else {
700 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
701 } 884 }
702 885
703 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
704} 887}
705 888
707 if (ref $_[0]) { 890 if (ref $_[0]) {
708 _object_attach @_; 891 _object_attach @_;
709 } else { 892 } else {
710 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
711 } 894 }
895 _recalc_want;
712}; 896};
713 897
714# all those should be optimised 898# all those should be optimised
715sub cf::attachable::detach { 899sub cf::attachable::detach {
716 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
719 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
720 reattach ($obj); 904 reattach ($obj);
721 } else { 905 } else {
722 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
723 } 907 }
908 _recalc_want;
724}; 909};
725 910
726sub cf::attachable::attached { 911sub cf::attachable::attached {
727 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
728 913
743 "; 928 ";
744 die if $@; 929 die if $@;
745} 930}
746 931
747our $override; 932our $override;
748our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
749 934
750sub override { 935sub override {
751 $override = 1; 936 $override = 1;
752 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
753} 938}
754 939
755sub do_invoke { 940sub do_invoke {
756 my $event = shift; 941 my $event = shift;
757 my $callbacks = shift; 942 my $callbacks = shift;
758 943
759 @invoke_results = (); 944 @INVOKE_RESULTS = ();
760 945
761 local $override; 946 local $override;
762 947
763 for (@$callbacks) { 948 for (@$callbacks) {
764 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
781 966
782Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
783 968
784This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
785removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
786results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
787 972
788=back 973=back
789 974
790=cut 975=cut
791 976
792############################################################################# 977#############################################################################
793# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
794 990
795sub reattach { 991sub reattach {
796 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
797 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
798 996
799 my $registry = $obj->registry; 997 my $registry = $obj->registry;
800 998
801 @$registry = (); 999 @$registry = ();
802 1000
849 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
850 1048
851 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
853 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
854 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
855 close $fh; 1053 close $fh;
856 1054
857 if (@$objs) { 1055 if (@$objs) {
858 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1056 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
859 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
860 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
861 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
862 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
863 close $fh; 1061 close $fh;
864 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
865 } 1063 }
866 } else { 1064 } else {
867 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
899 or return; 1097 or return;
900 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
901 } 1099 }
902 1100
903 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
904 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
905 return ($data, $av); 1103 return ($data, $av);
906} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
907 1111
908############################################################################# 1112#############################################################################
909# command handling &c 1113# command handling &c
910 1114
911=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
924 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
925} 1129}
926 1130
927=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
928 1132
929Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
930 1138
931If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
932called. 1140called.
933 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
934=cut 1153=cut
935 1154
936sub register_extcmd { 1155sub register_extcmd {
937 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
938 1157
939 my $caller = caller;
940 #warn "registering extcmd '$name' to '$caller'";
941
942 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
943} 1165}
944 1166
945cf::player->attach ( 1167cf::player->attach (
946 on_command => sub { 1168 on_command => sub {
947 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
956 cf::override; 1178 cf::override;
957 }, 1179 },
958 on_extcmd => sub { 1180 on_extcmd => sub {
959 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
960 1182
961 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
962 1184
963 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
964 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
965 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
966 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
967 } 1195 if $reply;
968 } 1196 }
969 } else { 1197 } else {
970 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
971 } 1199 }
972 1200
973 cf::override; 1201 cf::override;
974 }, 1202 },
975); 1203);
976 1204
977sub register {
978 my ($base, $pkg) = @_;
979
980 #TODO
981}
982
983sub load_extension { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
1209 for my $path (<$LIBDIR/*.ext>) {
1210 next unless -r $path;
1211
1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
1269 }
1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
1275 };
1276}
1277
1278#############################################################################
1279
1280=back
1281
1282=head2 CORE EXTENSIONS
1283
1284Functions and methods that extend core crossfire objects.
1285
1286=cut
1287
1288package cf::player;
1289
1290use Coro::AIO;
1291
1292=head3 cf::player
1293
1294=over 4
1295
1296=item cf::player::find $login
1297
1298Returns the given player object, loading it if necessary (might block).
1299
1300=cut
1301
1302sub playerdir($) {
1303 "$PLAYERDIR/"
1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1305}
1306
1307sub path($) {
1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1309
1310 (playerdir $login) . "/playerdata"
1311}
1312
1313sub find_active($) {
1314 $cf::PLAYER{$_[0]}
1315 and $cf::PLAYER{$_[0]}->active
1316 and $cf::PLAYER{$_[0]}
1317}
1318
1319sub exists($) {
1320 my ($login) = @_;
1321
1322 $cf::PLAYER{$login}
1323 or cf::sync_job { !aio_stat path $login }
1324}
1325
1326sub find($) {
1327 return $cf::PLAYER{$_[0]} || do {
1328 my $login = $_[0];
1329
1330 my $guard = cf::lock_acquire "user_find:$login";
1331
1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
1340 my $pl = load_pl path $login
1341 or return;
1342 $cf::PLAYER{$login} = $pl
1343 }
1344 }
1345}
1346
1347sub save($) {
1348 my ($pl) = @_;
1349
1350 return if $pl->{deny_save};
1351
1352 my $path = path $pl;
1353 my $guard = cf::lock_acquire "user_save:$path";
1354
1355 return if $pl->{deny_save};
1356
1357 aio_mkdir playerdir $pl, 0770;
1358 $pl->{last_save} = $cf::RUNTIME;
1359
1360 $pl->save_pl ($path);
1361 Coro::cede;
1362}
1363
1364sub new($) {
1365 my ($login) = @_;
1366
1367 my $self = create;
1368
1369 $self->ob->name ($login);
1370 $self->{deny_save} = 1;
1371
1372 $cf::PLAYER{$login} = $self;
1373
1374 $self
1375}
1376
1377=item $pl->quit_character
1378
1379Nukes the player without looking back. If logged in, the connection will
1380be destroyed. May block for a long time.
1381
1382=cut
1383
1384sub quit_character {
1385 my ($pl) = @_;
1386
1387 my $name = $pl->ob->name;
1388
1389 $pl->{deny_save} = 1;
1390 $pl->password ("*"); # this should lock out the player until we nuked the dir
1391
1392 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1393 $pl->deactivate;
1394 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1395 $pl->ns->destroy if $pl->ns;
1396
1397 my $path = playerdir $pl;
1398 my $temp = "$path~$cf::RUNTIME~deleting~";
1399 aio_rename $path, $temp;
1400 delete $cf::PLAYER{$pl->ob->name};
1401 $pl->destroy;
1402
1403 my $prefix = qr<^~\Q$name\E/>;
1404
1405 # nuke player maps
1406 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1407
1408 IO::AIO::aio_rmtree $temp;
1409}
1410
1411=item $pl->kick
1412
1413Kicks a player out of the game. This destroys the connection.
1414
1415=cut
1416
1417sub kick {
1418 my ($pl, $kicker) = @_;
1419
1420 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1421 $pl->killer ("kicked");
1422 $pl->ns->destroy;
1423}
1424
1425=item cf::player::list_logins
1426
1427Returns am arrayref of all valid playernames in the system, can take a
1428while and may block, so not sync_job-capable, ever.
1429
1430=cut
1431
1432sub list_logins {
1433 my $dirs = aio_readdir $PLAYERDIR
1434 or return [];
1435
1436 my @logins;
1437
1438 for my $login (@$dirs) {
1439 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1440 aio_read $fh, 0, 512, my $buf, 0 or next;
1441 $buf !~ /^password -------------$/m or next; # official not-valid tag
1442
1443 utf8::decode $login;
1444 push @logins, $login;
1445 }
1446
1447 \@logins
1448}
1449
1450=item $player->maps
1451
1452Returns an arrayref of map paths that are private for this
1453player. May block.
1454
1455=cut
1456
1457sub maps($) {
1458 my ($pl) = @_;
1459
1460 $pl = ref $pl ? $pl->ob->name : $pl;
1461
1462 my $files = aio_readdir playerdir $pl
1463 or return;
1464
1465 my @paths;
1466
1467 for (@$files) {
1468 utf8::decode $_;
1469 next if /\.(?:pl|pst)$/;
1470 next unless /^$PATH_SEP/o;
1471
1472 push @paths, cf::map::normalise "~$pl/$_";
1473 }
1474
1475 \@paths
1476}
1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1528=item $player->ext_reply ($msgid, @msg)
1529
1530Sends an ext reply to the player.
1531
1532=cut
1533
1534sub ext_reply($$@) {
1535 my ($self, $id, @msg) = @_;
1536
1537 if ($self->ns->extcmd == 2) {
1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1544}
1545
1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
984 my ($path) = @_; 1573 my ($path) = @_;
985 1574
986 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1575 my ($match, $specificity);
987 my $base = $1;
988 my $pkg = $1;
989 $pkg =~ s/[^[:word:]]/_/g;
990 $pkg = "ext::$pkg";
991 1576
992 warn "loading '$path' into '$pkg'\n"; 1577 for my $region (list) {
993 1578 if ($region->{match} && $path =~ $region->{match}) {
994 open my $fh, "<:utf8", $path 1579 ($match, $specificity) = ($region, $region->specificity)
995 or die "$path: $!"; 1580 if $region->specificity > $specificity;
996 1581 }
997 my $source =
998 "package $pkg; use strict; use utf8;\n"
999 . "#line 1 \"$path\"\n{\n"
1000 . (do { local $/; <$fh> })
1001 . "\n};\n1";
1002
1003 eval $source
1004 or die $@ ? "$path: $@\n"
1005 : "extension disabled.\n";
1006
1007 push @exts, $pkg;
1008 $ext_pkg{$base} = $pkg;
1009
1010# no strict 'refs';
1011# @{"$pkg\::ISA"} = ext::;
1012
1013 register $base, $pkg;
1014}
1015
1016sub unload_extension {
1017 my ($pkg) = @_;
1018
1019 warn "removing extension $pkg\n";
1020
1021 # remove hooks
1022 #TODO
1023# for my $idx (0 .. $#PLUGIN_EVENT) {
1024# delete $hook[$idx]{$pkg};
1025# } 1582 }
1026 1583
1027 # remove commands 1584 $match
1028 for my $name (keys %COMMAND) {
1029 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031 if (@cb) {
1032 $COMMAND{$name} = \@cb;
1033 } else {
1034 delete $COMMAND{$name};
1035 }
1036 }
1037
1038 # remove extcmds
1039 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1040 delete $EXTCMD{$name};
1041 }
1042
1043 if (my $cb = $pkg->can ("unload")) {
1044 eval {
1045 $cb->($pkg);
1046 1
1047 } or warn "$pkg unloaded, but with errors: $@";
1048 }
1049
1050 Symbol::delete_package $pkg;
1051}
1052
1053sub load_extensions {
1054 for my $ext (<$LIBDIR/*.ext>) {
1055 next unless -r $ext;
1056 eval {
1057 load_extension $ext;
1058 1
1059 } or warn "$ext not loaded: $@";
1060 }
1061}
1062
1063#############################################################################
1064# load/save/clean perl data associated with a map
1065
1066*cf::mapsupport::on_clean = sub {
1067 my ($map) = @_;
1068
1069 my $path = $map->tmpname;
1070 defined $path or return;
1071
1072 unlink "$path.pst";
1073};
1074
1075cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077#############################################################################
1078# load/save perl data associated with player->ob objects
1079
1080sub all_objects(@) {
1081 @_, map all_objects ($_->inv), @_
1082}
1083
1084# TODO: compatibility cruft, remove when no longer needed
1085cf::player->attach (
1086 on_load => sub {
1087 my ($pl, $path) = @_;
1088
1089 for my $o (all_objects $pl->ob) {
1090 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1091 $o->set_ob_key_value ("_perl_data");
1092
1093 %$o = %{ Storable::thaw pack "H*", $value };
1094 }
1095 }
1096 },
1097);
1098
1099#############################################################################
1100
1101=head2 CORE EXTENSIONS
1102
1103Functions and methods that extend core crossfire objects.
1104
1105=head3 cf::player
1106
1107=over 4
1108
1109=item cf::player::exists $login
1110
1111Returns true when the given account exists.
1112
1113=cut
1114
1115sub cf::player::exists($) {
1116 cf::player::find $_[0]
1117 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118}
1119
1120=item $player->ext_reply ($msgid, $msgtype, %msg)
1121
1122Sends an ext reply to the player.
1123
1124=cut
1125
1126sub cf::player::ext_reply($$$%) {
1127 my ($self, $id, %msg) = @_;
1128
1129 $msg{msgid} = $id;
1130
1131 $self->send ("ext " . to_json \%msg);
1132} 1585}
1133 1586
1134=back 1587=back
1135
1136 1588
1137=head3 cf::map 1589=head3 cf::map
1138 1590
1139=over 4 1591=over 4
1140 1592
1143package cf::map; 1595package cf::map;
1144 1596
1145use Fcntl; 1597use Fcntl;
1146use Coro::AIO; 1598use Coro::AIO;
1147 1599
1600use overload
1601 '""' => \&as_string,
1602 fallback => 1;
1603
1148our $MAX_RESET = 3600; 1604our $MAX_RESET = 3600;
1149our $DEFAULT_RESET = 3000; 1605our $DEFAULT_RESET = 3000;
1150 1606
1151sub generate_random_map { 1607sub generate_random_map {
1152 my ($path, $rmp) = @_; 1608 my ($self, $rmp) = @_;
1153
1154 # mit "rum" bekleckern, nicht 1609 # mit "rum" bekleckern, nicht
1155 cf::map::_create_random_map 1610 $self->_create_random_map (
1156 $path,
1157 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1611 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1612 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1613 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160 $rmp->{exit_on_final_map}, 1614 $rmp->{exit_on_final_map},
1161 $rmp->{xsize}, $rmp->{ysize}, 1615 $rmp->{xsize}, $rmp->{ysize},
1162 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1616 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1617 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1618 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1619 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1166 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167 (cf::region::find $rmp->{region}) 1621 (cf::region::find $rmp->{region}), $rmp->{custom}
1622 )
1623}
1624
1625=item cf::map->register ($regex, $prio)
1626
1627Register a handler for the map path matching the given regex at the
1628givne priority (higher is better, built-in handlers have priority 0, the
1629default).
1630
1631=cut
1632
1633sub register {
1634 my (undef, $regex, $prio) = @_;
1635 my $pkg = caller;
1636
1637 no strict;
1638 push @{"$pkg\::ISA"}, __PACKAGE__;
1639
1640 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1641}
1642
1643# also paths starting with '/'
1644$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1645
1646sub thawer_merge {
1647 my ($self, $merge) = @_;
1648
1649 # we have to keep some variables in memory intact
1650 local $self->{path};
1651 local $self->{load_path};
1652
1653 $self->SUPER::thawer_merge ($merge);
1654}
1655
1656sub normalise {
1657 my ($path, $base) = @_;
1658
1659 $path = "$path"; # make sure its a string
1660
1661 $path =~ s/\.map$//;
1662
1663 # map plan:
1664 #
1665 # /! non-realised random map exit (special hack!)
1666 # {... are special paths that are not being touched
1667 # ?xxx/... are special absolute paths
1668 # ?random/... random maps
1669 # /... normal maps
1670 # ~user/... per-player map of a specific user
1671
1672 $path =~ s/$PATH_SEP/\//go;
1673
1674 # treat it as relative path if it starts with
1675 # something that looks reasonable
1676 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1677 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1678
1679 $base =~ s{[^/]+/?$}{};
1680 $path = "$base/$path";
1681 }
1682
1683 for ($path) {
1684 redo if s{//}{/};
1685 redo if s{/\.?/}{/};
1686 redo if s{/[^/]+/\.\./}{/};
1687 }
1688
1689 $path
1690}
1691
1692sub new_from_path {
1693 my (undef, $path, $base) = @_;
1694
1695 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1696
1697 $path = normalise $path, $base;
1698
1699 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1700 if ($path =~ $EXT_MAP{$pkg}[1]) {
1701 my $self = bless cf::map::new, $pkg;
1702 $self->{path} = $path; $self->path ($path);
1703 $self->init; # pass $1 etc.
1704 return $self;
1705 }
1706 }
1707
1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1709 ()
1710}
1711
1712sub init {
1713 my ($self) = @_;
1714
1715 $self
1716}
1717
1718sub as_string {
1719 my ($self) = @_;
1720
1721 "$self->{path}"
1722}
1723
1724# the displayed name, this is a one way mapping
1725sub visible_name {
1726 &as_string
1727}
1728
1729# the original (read-only) location
1730sub load_path {
1731 my ($self) = @_;
1732
1733 "$MAPDIR/$self->{path}.map"
1734}
1735
1736# the temporary/swap location
1737sub save_path {
1738 my ($self) = @_;
1739
1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1741 "$TMPDIR/$path.map"
1742}
1743
1744# the unique path, undef == no special unique path
1745sub uniq_path {
1746 my ($self) = @_;
1747
1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1749 "$UNIQUEDIR/$path"
1168} 1750}
1169 1751
1170# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1171# all maps in C++... 1753# all maps in C++...
1172sub change_all_map_light { 1754sub change_all_map_light {
1174 1756
1175 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1176 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1177} 1759}
1178 1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1767}
1768
1769sub unlink_save {
1770 my ($self) = @_;
1771
1772 utf8::encode (my $save = $self->save_path);
1773 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1774 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1775}
1776
1179sub try_load_header($) { 1777sub load_header_from($) {
1180 my ($path) = @_; 1778 my ($self, $path) = @_;
1181 1779
1182 utf8::encode $path; 1780 utf8::encode $path;
1183 aio_open $path, O_RDONLY, 0 1781 #aio_open $path, O_RDONLY, 0
1782 # or return;
1783
1784 $self->_load_header ($path)
1184 or return; 1785 or return;
1185 1786
1186 my $map = cf::map::new 1787 $self->{load_path} = $path;
1788
1789 1
1790}
1791
1792sub load_header_orig {
1793 my ($self) = @_;
1794
1795 $self->load_header_from ($self->load_path)
1796}
1797
1798sub load_header_temp {
1799 my ($self) = @_;
1800
1801 $self->load_header_from ($self->save_path)
1802}
1803
1804sub prepare_temp {
1805 my ($self) = @_;
1806
1807 $self->last_access ((delete $self->{last_access})
1808 || $cf::RUNTIME); #d#
1809 # safety
1810 $self->{instantiate_time} = $cf::RUNTIME
1811 if $self->{instantiate_time} > $cf::RUNTIME;
1812}
1813
1814sub prepare_orig {
1815 my ($self) = @_;
1816
1817 $self->{load_original} = 1;
1818 $self->{instantiate_time} = $cf::RUNTIME;
1819 $self->last_access ($cf::RUNTIME);
1820 $self->instantiate;
1821}
1822
1823sub load_header {
1824 my ($self) = @_;
1825
1826 if ($self->load_header_temp) {
1827 $self->prepare_temp;
1828 } else {
1829 $self->load_header_orig
1187 or return; 1830 or return;
1831 $self->prepare_orig;
1832 }
1188 1833
1189 $map->load_header ($path) 1834 $self->{deny_reset} = 1
1190 or return; 1835 if $self->no_reset;
1191 1836
1192 $map->{load_path} = $path; 1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1193 1839
1194 $map 1840 1
1195} 1841}
1196 1842
1197sub find; 1843sub find;
1198sub find { 1844sub find {
1199 my ($path, $origin) = @_; 1845 my ($path, $origin) = @_;
1200 1846
1201 #warn "find<$path,$origin>\n";#d#
1202
1203 $path = new cf::path $path, $origin && $origin->path; 1847 $path = normalise $path, $origin && $origin->path;
1204 my $key = $path->as_string;
1205 1848
1206 cf::lock_wait "map_find:$key"; 1849 cf::lock_wait "map_find:$path";
1207 1850
1208 $cf::MAP{$key} || do { 1851 $cf::MAP{$path} || do {
1209 my $guard = cf::lock_acquire "map_find:$key"; 1852 my $guard = cf::lock_acquire "map_find:$path";
1210 1853 my $map = new_from_path cf::map $path
1211 # do it the slow way
1212 my $map = try_load_header $path->save_path;
1213
1214 if ($map) {
1215 $map->last_access ((delete $map->{last_access})
1216 || $cf::RUNTIME); #d#
1217 # safety
1218 $map->{instantiate_time} = $cf::RUNTIME
1219 if $map->{instantiate_time} > $cf::RUNTIME;
1220 } else {
1221 if (my $rmp = $path->random_map_params) {
1222 $map = generate_random_map $key, $rmp;
1223 } else {
1224 $map = try_load_header $path->load_path;
1225 }
1226
1227 $map or return; 1854 or return;
1228 1855
1229 $map->{load_original} = 1;
1230 $map->{instantiate_time} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME);
1232 $map->instantiate;
1233
1234 # per-player maps become, after loading, normal maps
1235 $map->per_player (0) if $path->{user_rel};
1236 }
1237
1238 $map->path ($key);
1239 $map->{path} = $path;
1240 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1241 1857
1242 if ($map->should_reset) { 1858 $map->load_header
1859 or return;
1860
1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1862 # doing this can freeze the server in a sync job, obviously
1863 #$cf::WAIT_FOR_TICK->wait;
1243 $map->reset; 1864 $map->reset;
1244 undef $guard; 1865 undef $guard;
1245 $map = find $path 1866 return find $path;
1246 or return;
1247 } 1867 }
1248 1868
1249 $cf::MAP{$key} = $map 1869 $cf::MAP{$path} = $map
1250 } 1870 }
1251} 1871}
1872
1873sub pre_load { }
1874sub post_load { }
1252 1875
1253sub load { 1876sub load {
1254 my ($self) = @_; 1877 my ($self) = @_;
1255 1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1256 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1257 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1884 my $guard = cf::lock_acquire "map_load:$path";
1258 1885
1259 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1260 1887
1261 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1262 1889
1263 $self->alloc; 1890 $self->alloc;
1891
1892 $self->pre_load;
1893 Coro::cede;
1894
1264 $self->load_objects ($self->{load_path}, 1) 1895 $self->_load_objects ($self->{load_path}, 1)
1265 or return; 1896 or return;
1266 1897
1267 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1268 if delete $self->{load_original}; 1899 if delete $self->{load_original};
1269 1900
1270 if (my $uniq = $path->uniq_path) { 1901 if (my $uniq = $self->uniq_path) {
1271 utf8::encode $uniq; 1902 utf8::encode $uniq;
1272 if (aio_open $uniq, O_RDONLY, 0) { 1903 if (aio_open $uniq, O_RDONLY, 0) {
1273 $self->clear_unique_items; 1904 $self->clear_unique_items;
1274 $self->load_objects ($uniq, 0); 1905 $self->_load_objects ($uniq, 0);
1275 } 1906 }
1276 } 1907 }
1277 1908
1909 Coro::cede;
1278 # now do the right thing for maps 1910 # now do the right thing for maps
1279 $self->link_multipart_objects; 1911 $self->link_multipart_objects;
1280
1281 if ($self->{path}->is_style_map) {
1282 $self->{deny_save} = 1;
1283 $self->{deny_reset} = 1;
1284 } else {
1285 $self->fix_auto_apply;
1286 $self->decay_objects;
1287 $self->update_buttons;
1288 $self->set_darkness_map;
1289 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1290 unless $self->difficulty; 1913 unless $self->difficulty;
1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1291 $self->activate; 1923 $self->activate;
1292 } 1924 }
1293 1925
1926 $self->{last_save} = $cf::RUNTIME;
1927 $self->last_access ($cf::RUNTIME);
1928
1294 $self->in_memory (cf::MAP_IN_MEMORY); 1929 $self->in_memory (cf::MAP_IN_MEMORY);
1930 }
1931
1932 $self->post_load;
1933}
1934
1935sub customise_for {
1936 my ($self, $ob) = @_;
1937
1938 return find "~" . $ob->name . "/" . $self->{path}
1939 if $self->per_player;
1940
1941# return find "?party/" . $ob->name . "/" . $self->{path}
1942# if $self->per_party;
1943
1944 $self
1945}
1946
1947# find and load all maps in the 3x3 area around a map
1948sub load_diag {
1949 my ($map) = @_;
1950
1951 my @diag; # diagonal neighbours
1952
1953 for (0 .. 3) {
1954 my $neigh = $map->tile_path ($_)
1955 or next;
1956 $neigh = find $neigh, $map
1957 or next;
1958 $neigh->load;
1959
1960 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1961 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1962 }
1963
1964 for (@diag) {
1965 my $neigh = find @$_
1966 or next;
1967 $neigh->load;
1968 }
1295} 1969}
1296 1970
1297sub find_sync { 1971sub find_sync {
1298 my ($path, $origin) = @_; 1972 my ($path, $origin) = @_;
1299 1973
1300 cf::sync_job { cf::map::find $path, $origin } 1974 cf::sync_job { find $path, $origin }
1301} 1975}
1302 1976
1303sub do_load_sync { 1977sub do_load_sync {
1304 my ($map) = @_; 1978 my ($map) = @_;
1305 1979
1306 cf::sync_job { $map->load }; 1980 cf::sync_job { $map->load };
1307} 1981}
1308 1982
1983our %MAP_PREFETCH;
1984our $MAP_PREFETCHER = undef;
1985
1986sub find_async {
1987 my ($path, $origin) = @_;
1988
1989 $path = normalise $path, $origin && $origin->{path};
1990
1991 if (my $map = $cf::MAP{$path}) {
1992 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1993 }
1994
1995 undef $MAP_PREFETCH{$path};
1996 $MAP_PREFETCHER ||= cf::async {
1997 while (%MAP_PREFETCH) {
1998 for my $path (keys %MAP_PREFETCH) {
1999 if (my $map = find $path) {
2000 $map->load;
2001 }
2002
2003 delete $MAP_PREFETCH{$path};
2004 }
2005 }
2006 undef $MAP_PREFETCHER;
2007 };
2008 $MAP_PREFETCHER->prio (6);
2009
2010 ()
2011}
2012
1309sub save { 2013sub save {
1310 my ($self) = @_; 2014 my ($self) = @_;
1311 2015
2016 my $lock = cf::lock_acquire "map_data:" . $self->path;
2017
1312 $self->{last_save} = $cf::RUNTIME; 2018 $self->{last_save} = $cf::RUNTIME;
1313 2019
1314 return unless $self->dirty; 2020 return unless $self->dirty;
1315 2021
1316 my $save = $self->{path}->save_path; utf8::encode $save; 2022 my $save = $self->save_path; utf8::encode $save;
1317 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2023 my $uniq = $self->uniq_path; utf8::encode $uniq;
1318 2024
1319 $self->{load_path} = $save; 2025 $self->{load_path} = $save;
1320 2026
1321 return if $self->{deny_save}; 2027 return if $self->{deny_save};
1322 2028
1323 local $self->{last_access} = $self->last_access;#d# 2029 local $self->{last_access} = $self->last_access;#d#
1324 2030
2031 cf::async {
2032 $_->contr->save for $self->players;
2033 };
2034
1325 if ($uniq) { 2035 if ($uniq) {
1326 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2036 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1327 $self->save_objects ($uniq, cf::IO_UNIQUES); 2037 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1328 } else { 2038 } else {
1329 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2039 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1330 } 2040 }
1331} 2041}
1332 2042
1333sub swap_out { 2043sub swap_out {
1334 my ($self) = @_; 2044 my ($self) = @_;
1335 2045
1336 # save first because save cedes 2046 # save first because save cedes
1337 $self->save; 2047 $self->save;
2048
2049 my $lock = cf::lock_acquire "map_data:" . $self->path;
1338 2050
1339 return if $self->players; 2051 return if $self->players;
1340 return if $self->in_memory != cf::MAP_IN_MEMORY; 2052 return if $self->in_memory != cf::MAP_IN_MEMORY;
1341 return if $self->{deny_save}; 2053 return if $self->{deny_save};
1342 2054
1346 2058
1347sub reset_at { 2059sub reset_at {
1348 my ($self) = @_; 2060 my ($self) = @_;
1349 2061
1350 # TODO: safety, remove and allow resettable per-player maps 2062 # TODO: safety, remove and allow resettable per-player maps
1351 return 1e99 if $self->{path}{user_rel};
1352 return 1e99 if $self->{deny_reset}; 2063 return 1e99 if $self->{deny_reset};
1353 2064
1354 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2065 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1355 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2066 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1356 2067
1361 my ($self) = @_; 2072 my ($self) = @_;
1362 2073
1363 $self->reset_at <= $cf::RUNTIME 2074 $self->reset_at <= $cf::RUNTIME
1364} 2075}
1365 2076
1366sub unlink_save {
1367 my ($self) = @_;
1368
1369 utf8::encode (my $save = $self->{path}->save_path);
1370 aioreq_pri 3; IO::AIO::aio_unlink $save;
1371 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1372}
1373
1374sub rename {
1375 my ($self, $new_path) = @_;
1376
1377 $self->unlink_save;
1378
1379 delete $cf::MAP{$self->path};
1380 $self->{path} = new cf::path $new_path;
1381 $self->path ($self->{path}->as_string);
1382 $cf::MAP{$self->path} = $self;
1383
1384 $self->save;
1385}
1386
1387sub reset { 2077sub reset {
1388 my ($self) = @_; 2078 my ($self) = @_;
1389 2079
2080 my $lock = cf::lock_acquire "map_data:$self->{path}";
2081
1390 return if $self->players; 2082 return if $self->players;
1391 return if $self->{path}{user_rel};#d#
1392 2083
1393 warn "resetting map ", $self->path;#d# 2084 warn "resetting map ", $self->path;
2085
2086 $self->in_memory (cf::MAP_SWAPPED);
2087
2088 # need to save uniques path
2089 unless ($self->{deny_save}) {
2090 my $uniq = $self->uniq_path; utf8::encode $uniq;
2091
2092 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2093 if $uniq;
2094 }
1394 2095
1395 delete $cf::MAP{$self->path}; 2096 delete $cf::MAP{$self->path};
2097
2098 $self->clear;
1396 2099
1397 $_->clear_links_to ($self) for values %cf::MAP; 2100 $_->clear_links_to ($self) for values %cf::MAP;
1398 2101
1399 $self->unlink_save; 2102 $self->unlink_save;
1400 $self->destroy; 2103 $self->destroy;
1403my $nuke_counter = "aaaa"; 2106my $nuke_counter = "aaaa";
1404 2107
1405sub nuke { 2108sub nuke {
1406 my ($self) = @_; 2109 my ($self) = @_;
1407 2110
2111 delete $cf::MAP{$self->path};
2112
2113 $self->unlink_save;
2114
2115 bless $self, "cf::map";
2116 delete $self->{deny_reset};
1408 $self->{deny_save} = 1; 2117 $self->{deny_save} = 1;
1409 $self->reset_timeout (1); 2118 $self->reset_timeout (1);
1410 $self->rename ("{nuke}/" . ($nuke_counter++)); 2119 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2120
2121 $cf::MAP{$self->path} = $self;
2122
1411 $self->reset; # polite request, might not happen 2123 $self->reset; # polite request, might not happen
1412} 2124}
1413 2125
1414sub customise_for { 2126=item $maps = cf::map::tmp_maps
1415 my ($map, $ob) = @_;
1416 2127
1417 if ($map->per_player) { 2128Returns an arrayref with all map paths of currently instantiated and saved
1418 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2129maps. May block.
2130
2131=cut
2132
2133sub tmp_maps() {
1419 } 2134 [
1420 2135 map {
1421 $map 2136 utf8::decode $_;
2137 /\.map$/
2138 ? normalise $_
2139 : ()
2140 } @{ aio_readdir $TMPDIR or [] }
2141 ]
1422} 2142}
1423 2143
1424sub emergency_save { 2144=item $maps = cf::map::random_maps
1425 my $freeze_guard = cf::freeze_mainloop;
1426 2145
1427 warn "enter emergency map save\n"; 2146Returns an arrayref with all map paths of currently instantiated and saved
2147random maps. May block.
1428 2148
1429 cf::sync_job { 2149=cut
1430 warn "begin emergency map save\n";
1431 $_->save for values %cf::MAP;
1432 };
1433 2150
1434 warn "end emergency map save\n"; 2151sub random_maps() {
2152 [
2153 map {
2154 utf8::decode $_;
2155 /\.map$/
2156 ? normalise "?random/$_"
2157 : ()
2158 } @{ aio_readdir $RANDOMDIR or [] }
2159 ]
2160}
2161
2162=item cf::map::unique_maps
2163
2164Returns an arrayref of paths of all shared maps that have
2165instantiated unique items. May block.
2166
2167=cut
2168
2169sub unique_maps() {
2170 [
2171 map {
2172 utf8::decode $_;
2173 /\.map$/
2174 ? normalise $_
2175 : ()
2176 } @{ aio_readdir $UNIQUEDIR or [] }
2177 ]
1435} 2178}
1436 2179
1437package cf; 2180package cf;
1438 2181
1439=back 2182=back
1440 2183
2184=head3 cf::object
2185
2186=cut
2187
2188package cf::object;
2189
2190=over 4
2191
2192=item $ob->inv_recursive
2193
2194Returns the inventory of the object _and_ their inventories, recursively.
2195
2196=cut
2197
2198sub inv_recursive_;
2199sub inv_recursive_ {
2200 map { $_, inv_recursive_ $_->inv } @_
2201}
2202
2203sub inv_recursive {
2204 inv_recursive_ inv $_[0]
2205}
2206
2207package cf;
2208
2209=back
1441 2210
1442=head3 cf::object::player 2211=head3 cf::object::player
1443 2212
1444=over 4 2213=over 4
1445 2214
1459 2228
1460 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2229 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1461 2230
1462 if ($self->{record_replies}) { 2231 if ($self->{record_replies}) {
1463 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2232 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2233
1464 } else { 2234 } else {
2235 my $pl = $self->contr;
2236
2237 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2238 my $dialog = $pl->{npc_dialog};
2239 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2240
2241 } else {
1465 $msg = $npc->name . " says: $msg" if $npc; 2242 $msg = $npc->name . " says: $msg" if $npc;
1466 $self->message ($msg, $flags); 2243 $self->message ($msg, $flags);
2244 }
1467 } 2245 }
1468} 2246}
1469 2247
1470=item $player_object->may ("access") 2248=item $player_object->may ("access")
1471 2249
1485 2263
1486=item $player_object->enter_link 2264=item $player_object->enter_link
1487 2265
1488Freezes the player and moves him/her to a special map (C<{link}>). 2266Freezes the player and moves him/her to a special map (C<{link}>).
1489 2267
1490The player should be reaosnably safe there for short amounts of time. You 2268The player should be reasonably safe there for short amounts of time. You
1491I<MUST> call C<leave_link> as soon as possible, though. 2269I<MUST> call C<leave_link> as soon as possible, though.
1492 2270
2271Will never block.
2272
1493=item $player_object->leave_link ($map, $x, $y) 2273=item $player_object->leave_link ($map, $x, $y)
1494 2274
1495Moves the player out of the specila link map onto the given map. If the 2275Moves the player out of the special C<{link}> map onto the specified
1496map is not valid (or omitted), the player will be moved back to the 2276map. If the map is not valid (or omitted), the player will be moved back
1497location he/she was before the call to C<enter_link>, or, if that fails, 2277to the location he/she was before the call to C<enter_link>, or, if that
1498to the emergency map position. 2278fails, to the emergency map position.
1499 2279
1500Might block. 2280Might block.
1501 2281
1502=cut 2282=cut
2283
2284sub link_map {
2285 unless ($LINK_MAP) {
2286 $LINK_MAP = cf::map::find "{link}"
2287 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2288 $LINK_MAP->load;
2289 }
2290
2291 $LINK_MAP
2292}
1503 2293
1504sub cf::object::player::enter_link { 2294sub cf::object::player::enter_link {
1505 my ($self) = @_; 2295 my ($self) = @_;
1506 2296
1507 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1508 2298
1509 return if $self->map == $LINK_MAP; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1510 2300
1511 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1512 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1513 2303
1514 $self->enter_map ($LINK_MAP, 20, 20); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1515} 2305}
1516 2306
1517sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1518 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1519 2311
1520 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1521 2313
1522 unless ($map) { 2314 unless ($map) {
1523 # restore original map position 2315 # restore original map position
1537 # use -1 or undef as default coordinates, not 0, 0 2329 # use -1 or undef as default coordinates, not 0, 0
1538 ($x, $y) = ($map->enter_x, $map->enter_y) 2330 ($x, $y) = ($map->enter_x, $map->enter_y)
1539 if $x <=0 && $y <= 0; 2331 if $x <=0 && $y <= 0;
1540 2332
1541 $map->load; 2333 $map->load;
2334 $map->load_diag;
1542 2335
2336 return unless $self->contr->active;
1543 $self->activate_recursive; 2337 $self->activate_recursive;
2338
2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1544 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1545} 2341}
1546 2342
1547cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1548 on_logout => sub {
1549 my ($pl) = @_;
1550 2344
1551 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1552 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1553 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1554 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1555 }; 2349be called at the end of this process.
1556 }
1557 },
1558 on_login => sub {
1559 my ($pl) = @_;
1560 2350
1561 # try to abort aborted map switching on player login :)
1562 # should happen only on crashes
1563 if ($pl->ob->{_link_pos}) {
1564 $pl->ob->enter_link;
1565 cf::async {
1566 # we need this sleep as the login has a concurrent enter_exit running
1567 # and this sleep increases chances of the player not ending up in scorn
1568 Coro::Timer::sleep 1;
1569 $pl->ob->leave_link;
1570 };
1571 }
1572 },
1573);
1574
1575=item $player_object->goto_map ($path, $x, $y)
1576
1577=cut 2351=cut
1578 2352
2353our $GOTOGEN;
2354
1579sub cf::object::player::goto_map { 2355sub cf::object::player::goto {
1580 my ($self, $path, $x, $y) = @_; 2356 my ($self, $path, $x, $y, $check, $done) = @_;
2357
2358 # do generation counting so two concurrent goto's will be executed in-order
2359 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1581 2360
1582 $self->enter_link; 2361 $self->enter_link;
1583 2362
1584 (cf::async { 2363 (async {
1585 $path = new cf::path $path; 2364 my $map = eval {
1586
1587 my $map = cf::map::find $path->as_string; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1588 $map = $map->customise_for ($self) if $map; 2368 $map = $map->customise_for ($self);
1589 2369 $map = $check->($map) if $check && $map;
1590# warn "entering ", $map->path, " at ($x, $y)\n" 2370 } else {
1591# if $map;
1592
1593 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2371 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2372 }
1594 2373
2374 $map
2375 };
2376
2377 if ($@) {
2378 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2379 LOG llevError | logBacktrace, Carp::longmess $@;
2380 }
2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1595 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1596 })->prio (1); 2388 })->prio (1);
1597} 2389}
1598 2390
1599=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1600 2392
1602 2394
1603sub parse_random_map_params { 2395sub parse_random_map_params {
1604 my ($spec) = @_; 2396 my ($spec) = @_;
1605 2397
1606 my $rmp = { # defaults 2398 my $rmp = { # defaults
1607 xsize => 10, 2399 xsize => (cf::rndm 15, 40),
1608 ysize => 10, 2400 ysize => (cf::rndm 15, 40),
2401 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2402 #layout => string,
1609 }; 2403 };
1610 2404
1611 for (split /\n/, $spec) { 2405 for (split /\n/, $spec) {
1612 my ($k, $v) = split /\s+/, $_, 2; 2406 my ($k, $v) = split /\s+/, $_, 2;
1613 2407
1617 $rmp 2411 $rmp
1618} 2412}
1619 2413
1620sub prepare_random_map { 2414sub prepare_random_map {
1621 my ($exit) = @_; 2415 my ($exit) = @_;
2416
2417 my $guard = cf::lock_acquire "exit_prepare:$exit";
1622 2418
1623 # all this does is basically replace the /! path by 2419 # all this does is basically replace the /! path by
1624 # a new random map path (?random/...) with a seed 2420 # a new random map path (?random/...) with a seed
1625 # that depends on the exit object 2421 # that depends on the exit object
1626 2422
1627 my $rmp = parse_random_map_params $exit->msg; 2423 my $rmp = parse_random_map_params $exit->msg;
1628 2424
1629 if ($exit->map) { 2425 if ($exit->map) {
1630 $rmp->{region} = $exit->map->region_name; 2426 $rmp->{region} = $exit->region->name;
1631 $rmp->{origin_map} = $exit->map->path; 2427 $rmp->{origin_map} = $exit->map->path;
1632 $rmp->{origin_x} = $exit->x; 2428 $rmp->{origin_x} = $exit->x;
1633 $rmp->{origin_y} = $exit->y; 2429 $rmp->{origin_y} = $exit->y;
1634 } 2430 }
1635 2431
1636 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1637 2433
1638 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1639 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
2436 my $meta = "$RANDOMDIR/$md5.meta";
1640 2437
1641 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1642 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
2440 undef $fh;
2441 aio_rename "$meta~", $meta;
1643 2442
1644 $exit->slaying ("?random/$md5"); 2443 $exit->slaying ("?random/$md5");
1645 $exit->msg (undef); 2444 $exit->msg (undef);
1646 } 2445 }
1647} 2446}
1649sub cf::object::player::enter_exit { 2448sub cf::object::player::enter_exit {
1650 my ($self, $exit) = @_; 2449 my ($self, $exit) = @_;
1651 2450
1652 return unless $self->type == cf::PLAYER; 2451 return unless $self->type == cf::PLAYER;
1653 2452
2453 if ($exit->slaying eq "/!") {
2454 #TODO: this should de-fi-ni-te-ly not be a sync-job
2455 # the problem is that $exit might not survive long enough
2456 # so it needs to be done right now, right here
2457 cf::sync_job { prepare_random_map $exit };
2458 }
2459
2460 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2461 my $hp = $exit->stats->hp;
2462 my $sp = $exit->stats->sp;
2463
1654 $self->enter_link; 2464 $self->enter_link;
1655 2465
2466 # if exit is damned, update players death & WoR home-position
2467 $self->contr->savebed ($slaying, $hp, $sp)
2468 if $exit->flag (FLAG_DAMNED);
2469
1656 (cf::async { 2470 (async {
1657 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
1658 unless (eval { 2472 unless (eval {
1659 prepare_random_map $exit 2473 $self->goto ($slaying, $hp, $sp);
1660 if $exit->slaying eq "/!";
1661
1662 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1663 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1664 2474
1665 1; 2475 1;
1666 }) { 2476 }) {
1667 $self->message ("Something went wrong deep within the crossfire server. " 2477 $self->message ("Something went wrong deep within the crossfire server. "
1668 . "I'll try to bring you back to the map you were before. " 2478 . "I'll try to bring you back to the map you were before. "
1669 . "Please report this to the dungeon master", 2479 . "Please report this to the dungeon master!",
1670 cf::NDI_UNIQUE | cf::NDI_RED); 2480 cf::NDI_UNIQUE | cf::NDI_RED);
1671 2481
1672 warn "ERROR in enter_exit: $@"; 2482 warn "ERROR in enter_exit: $@";
1673 $self->leave_link; 2483 $self->leave_link;
1674 } 2484 }
1675 })->prio (1); 2485 })->prio (1);
1688 2498
1689sub cf::client::send_drawinfo { 2499sub cf::client::send_drawinfo {
1690 my ($self, $text, $flags) = @_; 2500 my ($self, $text, $flags) = @_;
1691 2501
1692 utf8::encode $text; 2502 utf8::encode $text;
1693 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1694} 2504}
1695 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515sub cf::client::send_msg {
2516 my ($self, $channel, $msg, $color, @extra) = @_;
2517
2518 $msg = $self->pl->expand_cfpod ($msg);
2519
2520 $color &= cf::NDI_CLIENT_MASK; # just in case...
2521
2522 if (ref $channel) {
2523 # send meta info to client, if not yet sent
2524 unless (exists $self->{channel}{$channel->{id}}) {
2525 $self->{channel}{$channel->{id}} = $channel;
2526 $self->ext_msg (channel_info => $channel);
2527 }
2528
2529 $channel = $channel->{id};
2530 }
2531
2532 return unless @extra || length $msg;
2533
2534 if ($self->can_msg) {
2535 # default colour, mask it out
2536 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2537 if $color & cf::NDI_DEF;
2538
2539 $self->send_packet ("msg " . $self->{json_coder}->encode (
2540 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2541 } else {
2542 if ($color >= 0) {
2543 # replace some tags by gcfclient-compatible ones
2544 for ($msg) {
2545 1 while
2546 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2547 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2548 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2549 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2550 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2551 }
2552
2553 $color &= cf::NDI_COLOR_MASK;
2554
2555 if (0 && $msg =~ /\[/) {
2556 $self->send_packet ("drawextinfo $color 4 0 $msg")
2557 } else {
2558 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2559 $self->send_packet ("drawinfo $color $msg")
2560 }
2561 }
2562 }
2563}
2564
2565=item $client->ext_msg ($type, @msg)
2566
2567Sends an ext event to the client.
2568
2569=cut
2570
2571sub cf::client::ext_msg($$@) {
2572 my ($self, $type, @msg) = @_;
2573
2574 my $extcmd = $self->extcmd;
2575
2576 if ($extcmd == 2) {
2577 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2578 } elsif ($extcmd == 1) { # TODO: remove
2579 push @msg, msgtype => "event_$type";
2580 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2581 }
2582}
1696 2583
1697=item $success = $client->query ($flags, "text", \&cb) 2584=item $success = $client->query ($flags, "text", \&cb)
1698 2585
1699Queues a query to the client, calling the given callback with 2586Queues a query to the client, calling the given callback with
1700the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2587the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1701C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2588C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1702 2589
1703Queries can fail, so check the return code. Or don't, as queries will become 2590Queries can fail, so check the return code. Or don't, as queries will
1704reliable at some point in the future. 2591become reliable at some point in the future.
1705 2592
1706=cut 2593=cut
1707 2594
1708sub cf::client::query { 2595sub cf::client::query {
1709 my ($self, $flags, $text, $cb) = @_; 2596 my ($self, $flags, $text, $cb) = @_;
1717 utf8::encode $text; 2604 utf8::encode $text;
1718 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2605 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1719 2606
1720 $self->send_packet ($self->{query_queue}[0][0]) 2607 $self->send_packet ($self->{query_queue}[0][0])
1721 if @{ $self->{query_queue} } == 1; 2608 if @{ $self->{query_queue} } == 1;
2609
2610 1
1722} 2611}
1723 2612
1724cf::client->attach ( 2613cf::client->attach (
2614 on_connect => sub {
2615 my ($ns) = @_;
2616
2617 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2618 },
1725 on_reply => sub { 2619 on_reply => sub {
1726 my ($ns, $msg) = @_; 2620 my ($ns, $msg) = @_;
1727 2621
1728 # this weird shuffling is so that direct followup queries 2622 # this weird shuffling is so that direct followup queries
1729 # get handled first 2623 # get handled first
1730 my $queue = delete $ns->{query_queue} 2624 my $queue = delete $ns->{query_queue}
1731 or return; # be conservative, not sure how that can happen, but we saw a crash here 2625 or return; # be conservative, not sure how that can happen, but we saw a crash here
1732 2626
1733 (shift @$queue)->[1]->($msg); 2627 (shift @$queue)->[1]->($msg);
2628 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1734 2629
1735 push @{ $ns->{query_queue} }, @$queue; 2630 push @{ $ns->{query_queue} }, @$queue;
1736 2631
1737 if (@{ $ns->{query_queue} } == @$queue) { 2632 if (@{ $ns->{query_queue} } == @$queue) {
1738 if (@$queue) { 2633 if (@$queue) {
1740 } else { 2635 } else {
1741 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2636 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1742 } 2637 }
1743 } 2638 }
1744 }, 2639 },
2640 on_exticmd => sub {
2641 my ($ns, $buf) = @_;
2642
2643 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2644
2645 if (ref $msg) {
2646 my ($type, $reply, @payload) =
2647 "ARRAY" eq ref $msg
2648 ? @$msg
2649 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2650
2651 if (my $cb = $EXTICMD{$type}) {
2652 my @reply = $cb->($ns, @payload);
2653
2654 $ns->ext_reply ($reply, @reply)
2655 if $reply;
2656 }
2657 } else {
2658 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2659 }
2660
2661 cf::override;
2662 },
1745); 2663);
1746 2664
1747=item $client->coro (\&cb) 2665=item $client->async (\&cb)
1748 2666
1749Create a new coroutine, running the specified callback. The coroutine will 2667Create a new coroutine, running the specified callback. The coroutine will
1750be automatically cancelled when the client gets destroyed (e.g. on logout, 2668be automatically cancelled when the client gets destroyed (e.g. on logout,
1751or loss of connection). 2669or loss of connection).
1752 2670
1753=cut 2671=cut
1754 2672
1755sub cf::client::coro { 2673sub cf::client::async {
1756 my ($self, $cb) = @_; 2674 my ($self, $cb) = @_;
1757 2675
1758 my $coro = &cf::async ($cb); 2676 my $coro = &Coro::async ($cb);
1759 2677
1760 $coro->on_destroy (sub { 2678 $coro->on_destroy (sub {
1761 delete $self->{_coro}{$coro+0}; 2679 delete $self->{_coro}{$coro+0};
1762 }); 2680 });
1763 2681
1796 2714
1797# here we export the classes and methods available to script code 2715# here we export the classes and methods available to script code
1798 2716
1799=pod 2717=pod
1800 2718
1801The following fucntions and emthods are available within a safe environment: 2719The following functions and methods are available within a safe environment:
1802 2720
1803 cf::object contr pay_amount pay_player map 2721 cf::object
2722 contr pay_amount pay_player map x y force_find force_add
2723 insert remove
2724
1804 cf::object::player player 2725 cf::object::player
1805 cf::player peaceful 2726 player
1806 cf::map trigger 2727
2728 cf::player
2729 peaceful
2730
2731 cf::map
2732 trigger
1807 2733
1808=cut 2734=cut
1809 2735
1810for ( 2736for (
1811 ["cf::object" => qw(contr pay_amount pay_player map)], 2737 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2738 insert remove)],
1812 ["cf::object::player" => qw(player)], 2739 ["cf::object::player" => qw(player)],
1813 ["cf::player" => qw(peaceful)], 2740 ["cf::player" => qw(peaceful)],
1814 ["cf::map" => qw(trigger)], 2741 ["cf::map" => qw(trigger)],
1815) { 2742) {
1816 no strict 'refs'; 2743 no strict 'refs';
1887=back 2814=back
1888 2815
1889=cut 2816=cut
1890 2817
1891############################################################################# 2818#############################################################################
2819# the server's init and main functions
1892 2820
1893=head2 EXTENSION DATABASE SUPPORT 2821sub load_facedata($) {
2822 my ($path) = @_;
1894 2823
1895Crossfire maintains a very simple database for extension use. It can 2824 warn "loading facedata from $path\n";
1896currently store anything that can be serialised using Storable, which
1897excludes objects.
1898 2825
1899The parameter C<$family> should best start with the name of the extension 2826 my $facedata;
1900using it, it should be unique. 2827 0 < aio_load $path, $facedata
2828 or die "$path: $!";
1901 2829
1902=over 4 2830 $facedata = Coro::Storable::thaw $facedata;
1903 2831
1904=item $hashref = cf::db_get $family 2832 $facedata->{version} == 2
2833 or cf::cleanup "$path: version mismatch, cannot proceed.";
1905 2834
1906Return a hashref for use by the extension C<$family>, which can be
1907modified. After modifications, you have to call C<cf::db_dirty> or
1908C<cf::db_sync>.
1909
1910=item $value = cf::db_get $family => $key
1911
1912Returns a single value from the database
1913
1914=item cf::db_put $family => $hashref
1915
1916Stores the given family hashref into the database. Updates are delayed, if
1917you want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919=item cf::db_put $family => $key => $value
1920
1921Stores the given C<$value> in the family hash. Updates are delayed, if you
1922want the data to be synced to disk immediately, use C<cf::db_sync>.
1923
1924=item cf::db_dirty
1925
1926Marks the database as dirty, to be updated at a later time.
1927
1928=item cf::db_sync
1929
1930Immediately write the database to disk I<if it is dirty>.
1931
1932=cut
1933
1934our $DB;
1935
1936{
1937 my $path = cf::localdir . "/database.pst";
1938
1939 sub db_load() {
1940 $DB = stat $path ? Storable::retrieve $path : { };
1941 } 2835 {
2836 my $faces = $facedata->{faceinfo};
1942 2837
1943 my $pid; 2838 while (my ($face, $info) = each %$faces) {
2839 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2840 cf::face::set_visibility $idx, $info->{visibility};
2841 cf::face::set_magicmap $idx, $info->{magicmap};
2842 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2843 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1944 2844
1945 sub db_save() { 2845 cf::cede_to_tick;
1946 waitpid $pid, 0 if $pid;
1947 if (0 == ($pid = fork)) {
1948 $DB->{_meta}{version} = 1;
1949 Storable::nstore $DB, "$path~";
1950 rename "$path~", $path;
1951 cf::_exit 0 if defined $pid;
1952 }
1953 }
1954
1955 my $dirty;
1956
1957 sub db_sync() {
1958 db_save if $dirty;
1959 undef $dirty;
1960 }
1961
1962 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1963 db_sync;
1964 });
1965
1966 sub db_dirty() {
1967 $dirty = 1;
1968 $idle->start;
1969 }
1970
1971 sub db_get($;$) {
1972 @_ >= 2
1973 ? $DB->{$_[0]}{$_[1]}
1974 : ($DB->{$_[0]} ||= { })
1975 }
1976
1977 sub db_put($$;$) {
1978 if (@_ >= 3) {
1979 $DB->{$_[0]}{$_[1]} = $_[2];
1980 } else {
1981 $DB->{$_[0]} = $_[1];
1982 }
1983 db_dirty;
1984 }
1985
1986 cf::global->attach (
1987 prio => 10000,
1988 on_cleanup => sub {
1989 db_sync;
1990 }, 2846 }
1991 );
1992}
1993 2847
1994############################################################################# 2848 while (my ($face, $info) = each %$faces) {
1995# the server's main() 2849 next unless $info->{smooth};
2850 my $idx = cf::face::find $face
2851 or next;
2852 if (my $smooth = cf::face::find $info->{smooth}) {
2853 cf::face::set_smooth $idx, $smooth;
2854 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2855 } else {
2856 warn "smooth face '$info->{smooth}' not found for face '$face'";
2857 }
2858
2859 cf::cede_to_tick;
2860 }
2861 }
2862
2863 {
2864 my $anims = $facedata->{animinfo};
2865
2866 while (my ($anim, $info) = each %$anims) {
2867 cf::anim::set $anim, $info->{frames}, $info->{facings};
2868 cf::cede_to_tick;
2869 }
2870
2871 cf::anim::invalidate_all; # d'oh
2872 }
2873
2874 {
2875 # TODO: for gcfclient pleasure, we should give resources
2876 # that gcfclient doesn't grok a >10000 face index.
2877 my $res = $facedata->{resource};
2878 my $enc = JSON::XS->new->utf8->canonical;
2879
2880 my $soundconf = delete $res->{"res/sound.conf"};
2881
2882 while (my ($name, $info) = each %$res) {
2883 my $meta = $enc->encode ({
2884 name => $name,
2885 %{ $info->{meta} || {} },
2886 });
2887
2888 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2889
2890 if ($info->{type} & 1) {
2891 # prepend meta info
2892
2893 my $data = pack "(w/a*)*", $meta, $info->{data};
2894 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2895
2896 cf::face::set_data $idx, 0, $data, $chk;
2897 } else {
2898 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2899 }
2900
2901 cf::face::set_type $idx, $info->{type};
2902
2903 cf::cede_to_tick;
2904 }
2905
2906 if ($soundconf) {
2907 $soundconf = $enc->decode (delete $soundconf->{data});
2908
2909 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2910 my $sound = $soundconf->{compat}[$_]
2911 or next;
2912
2913 my $face = cf::face::find "sound/$sound->[1]";
2914 cf::sound::set $sound->[0] => $face;
2915 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2916 }
2917
2918 while (my ($k, $v) = each %{$soundconf->{event}}) {
2919 my $face = cf::face::find "sound/$v";
2920 cf::sound::set $k => $face;
2921 }
2922 }
2923 }
2924
2925 1
2926}
2927
2928register_exticmd fx_want => sub {
2929 my ($ns, $want) = @_;
2930
2931 while (my ($k, $v) = each %$want) {
2932 $ns->fx_want ($k, $v);
2933 }
2934};
2935
2936sub reload_regions {
2937 load_resource_file "$MAPDIR/regions"
2938 or die "unable to load regions file\n";
2939
2940 for (cf::region::list) {
2941 $_->{match} = qr/$_->{match}/
2942 if exists $_->{match};
2943 }
2944}
2945
2946sub reload_facedata {
2947 load_facedata "$DATADIR/facedata"
2948 or die "unable to load facedata\n";
2949}
2950
2951sub reload_archetypes {
2952 load_resource_file "$DATADIR/archetypes"
2953 or die "unable to load archetypes\n";
2954 #d# NEED to laod twice to resolve forward references
2955 # this really needs to be done in an extra post-pass
2956 # (which needs to be synchronous, so solve it differently)
2957 load_resource_file "$DATADIR/archetypes"
2958 or die "unable to load archetypes\n";
2959}
2960
2961sub reload_treasures {
2962 load_resource_file "$DATADIR/treasures"
2963 or die "unable to load treasurelists\n";
2964}
2965
2966sub reload_resources {
2967 warn "reloading resource files...\n";
2968
2969 reload_regions;
2970 reload_facedata;
2971 #reload_archetypes;#d#
2972 reload_archetypes;
2973 reload_treasures;
2974
2975 warn "finished reloading resource files\n";
2976}
2977
2978sub init {
2979 reload_resources;
2980}
1996 2981
1997sub cfg_load { 2982sub cfg_load {
1998 open my $fh, "<:utf8", cf::confdir . "/config" 2983 open my $fh, "<:utf8", "$CONFDIR/config"
1999 or return; 2984 or return;
2000 2985
2001 local $/; 2986 local $/;
2002 *CFG = YAML::Syck::Load <$fh>; 2987 *CFG = YAML::Syck::Load <$fh>;
2003 2988
2004 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2989 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2005 2990
2991 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2992 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2993
2006 if (exists $CFG{mlockall}) { 2994 if (exists $CFG{mlockall}) {
2007 eval { 2995 eval {
2008 $CFG{mlockall} ? &mlockall : &munlockall 2996 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2009 and die "WARNING: m(un)lockall failed: $!\n"; 2997 and die "WARNING: m(un)lockall failed: $!\n";
2010 }; 2998 };
2011 warn $@ if $@; 2999 warn $@ if $@;
2012 } 3000 }
2013} 3001}
2014 3002
2015sub main { 3003sub main {
2016 # we must not ever block the main coroutine 3004 # we must not ever block the main coroutine
2017 local $Coro::idle = sub { 3005 local $Coro::idle = sub {
2018 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3006 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2019 (Coro::unblock_sub { 3007 (async {
2020 Event::one_event; 3008 Event::one_event;
2021 })->(); 3009 })->prio (Coro::PRIO_MAX);
2022 }; 3010 };
2023 3011
2024 cfg_load; 3012 cfg_load;
2025 db_load; 3013 db_init;
2026 load_extensions; 3014 load_extensions;
3015
3016 $TICK_WATCHER->start;
2027 Event::loop; 3017 Event::loop;
2028} 3018}
2029 3019
2030############################################################################# 3020#############################################################################
2031# initialisation 3021# initialisation and cleanup
2032 3022
3023# install some emergency cleanup handlers
3024BEGIN {
3025 for my $signal (qw(INT HUP TERM)) {
3026 Event->signal (
3027 reentrant => 0,
3028 data => WF_AUTOCANCEL,
3029 signal => $signal,
3030 prio => 0,
3031 cb => sub {
3032 cf::cleanup "SIG$signal";
3033 },
3034 );
3035 }
3036}
3037
3038sub write_runtime {
3039 my $runtime = "$LOCALDIR/runtime";
3040
3041 # first touch the runtime file to show we are still running:
3042 # the fsync below can take a very very long time.
3043
3044 IO::AIO::aio_utime $runtime, undef, undef;
3045
3046 my $guard = cf::lock_acquire "write_runtime";
3047
3048 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3049 or return;
3050
3051 my $value = $cf::RUNTIME + 90 + 10;
3052 # 10 is the runtime save interval, for a monotonic clock
3053 # 60 allows for the watchdog to kill the server.
3054
3055 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3056 and return;
3057
3058 # always fsync - this file is important
3059 aio_fsync $fh
3060 and return;
3061
3062 # touch it again to show we are up-to-date
3063 aio_utime $fh, undef, undef;
3064
3065 close $fh
3066 or return;
3067
3068 aio_rename "$runtime~", $runtime
3069 and return;
3070
3071 warn "runtime file written.\n";
3072
3073 1
3074}
3075
3076sub emergency_save() {
3077 my $freeze_guard = cf::freeze_mainloop;
3078
3079 warn "enter emergency perl save\n";
3080
3081 cf::sync_job {
3082 # use a peculiar iteration method to avoid tripping on perl
3083 # refcount bugs in for. also avoids problems with players
3084 # and maps saved/destroyed asynchronously.
3085 warn "begin emergency player save\n";
3086 for my $login (keys %cf::PLAYER) {
3087 my $pl = $cf::PLAYER{$login} or next;
3088 $pl->valid or next;
3089 $pl->save;
3090 }
3091 warn "end emergency player save\n";
3092
3093 warn "begin emergency map save\n";
3094 for my $path (keys %cf::MAP) {
3095 my $map = $cf::MAP{$path} or next;
3096 $map->valid or next;
3097 $map->save;
3098 }
3099 warn "end emergency map save\n";
3100
3101 warn "begin emergency database checkpoint\n";
3102 BDB::db_env_txn_checkpoint $DB_ENV;
3103 warn "end emergency database checkpoint\n";
3104 };
3105
3106 warn "leave emergency perl save\n";
3107}
3108
3109sub post_cleanup {
3110 my ($make_core) = @_;
3111
3112 warn Carp::longmess "post_cleanup backtrace"
3113 if $make_core;
3114}
3115
2033sub reload() { 3116sub do_reload_perl() {
2034 # can/must only be called in main 3117 # can/must only be called in main
2035 if ($Coro::current != $Coro::main) { 3118 if ($Coro::current != $Coro::main) {
2036 warn "can only reload from main coroutine\n"; 3119 warn "can only reload from main coroutine";
2037 return; 3120 return;
2038 } 3121 }
2039 3122
2040 warn "reloading..."; 3123 warn "reloading...";
2041 3124
2042 my $guard = freeze_mainloop; 3125 warn "entering sync_job";
3126
3127 cf::sync_job {
3128 cf::write_runtime; # external watchdog should not bark
2043 cf::emergency_save; 3129 cf::emergency_save;
3130 cf::write_runtime; # external watchdog should not bark
2044 3131
2045 eval { 3132 warn "syncing database to disk";
3133 BDB::db_env_txn_checkpoint $DB_ENV;
3134
2046 # if anything goes wrong in here, we should simply crash as we already saved 3135 # if anything goes wrong in here, we should simply crash as we already saved
2047 3136
2048 # cancel all watchers 3137 warn "cancelling all WF_AUTOCANCEL watchers";
2049 for (Event::all_watchers) { 3138 for (Event::all_watchers) {
2050 $_->cancel if $_->data & WF_AUTOCANCEL; 3139 $_->cancel if $_->data & WF_AUTOCANCEL;
2051 } 3140 }
2052 3141
3142 warn "flushing outstanding aio requests";
3143 for (;;) {
3144 BDB::flush;
3145 IO::AIO::flush;
3146 Coro::cede;
3147 last unless IO::AIO::nreqs || BDB::nreqs;
3148 warn "iterate...";
3149 }
3150
3151 ++$RELOAD;
3152
2053 # cancel all extension coros 3153 warn "cancelling all extension coros";
2054 $_->cancel for values %EXT_CORO; 3154 $_->cancel for values %EXT_CORO;
2055 %EXT_CORO = (); 3155 %EXT_CORO = ();
2056 3156
2057 # unload all extensions 3157 warn "removing commands";
2058 for (@exts) { 3158 %COMMAND = ();
3159
3160 warn "removing ext/exti commands";
3161 %EXTCMD = ();
3162 %EXTICMD = ();
3163
3164 warn "unloading/nuking all extensions";
3165 for my $pkg (@EXTS) {
2059 warn "unloading <$_>"; 3166 warn "... unloading $pkg";
2060 unload_extension $_; 3167
3168 if (my $cb = $pkg->can ("unload")) {
3169 eval {
3170 $cb->($pkg);
3171 1
3172 } or warn "$pkg unloaded, but with errors: $@";
2061 } 3173 }
2062 3174
3175 warn "... nuking $pkg";
3176 Symbol::delete_package $pkg;
3177 }
3178
2063 # unload all modules loaded from $LIBDIR 3179 warn "unloading all perl modules loaded from $LIBDIR";
2064 while (my ($k, $v) = each %INC) { 3180 while (my ($k, $v) = each %INC) {
2065 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3181 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2066 3182
2067 warn "removing <$k>"; 3183 warn "... unloading $k";
2068 delete $INC{$k}; 3184 delete $INC{$k};
2069 3185
2070 $k =~ s/\.pm$//; 3186 $k =~ s/\.pm$//;
2071 $k =~ s/\//::/g; 3187 $k =~ s/\//::/g;
2072 3188
2075 } 3191 }
2076 3192
2077 Symbol::delete_package $k; 3193 Symbol::delete_package $k;
2078 } 3194 }
2079 3195
2080 # sync database to disk
2081 cf::db_sync;
2082 IO::AIO::flush;
2083
2084 # get rid of safe::, as good as possible 3196 warn "getting rid of safe::, as good as possible";
2085 Symbol::delete_package "safe::$_" 3197 Symbol::delete_package "safe::$_"
2086 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3198 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2087 3199
2088 # remove register_script_function callbacks
2089 # TODO
2090
2091 # unload cf.pm "a bit" 3200 warn "unloading cf.pm \"a bit\"";
2092 delete $INC{"cf.pm"}; 3201 delete $INC{"cf.pm"};
3202 delete $INC{"cf/pod.pm"};
2093 3203
2094 # don't, removes xs symbols, too, 3204 # don't, removes xs symbols, too,
2095 # and global variables created in xs 3205 # and global variables created in xs
2096 #Symbol::delete_package __PACKAGE__; 3206 #Symbol::delete_package __PACKAGE__;
2097 3207
2098 # reload cf.pm 3208 warn "unload completed, starting to reload now";
3209
2099 warn "reloading cf.pm"; 3210 warn "reloading cf.pm";
2100 require cf; 3211 require cf;
2101 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3212 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2102 3213
2103 # load config and database again 3214 warn "loading config and database again";
2104 cf::cfg_load; 3215 cf::cfg_load;
2105 cf::db_load;
2106 3216
2107 # load extensions
2108 warn "load extensions"; 3217 warn "loading extensions";
2109 cf::load_extensions; 3218 cf::load_extensions;
2110 3219
2111 # reattach attachments to objects 3220 warn "reattaching attachments to objects/players";
2112 warn "reattach"; 3221 _global_reattach; # objects, sockets
2113 _global_reattach; 3222 warn "reattaching attachments to maps";
2114 }; 3223 reattach $_ for values %MAP;
3224 warn "reattaching attachments to players";
3225 reattach $_ for values %PLAYER;
2115 3226
2116 if ($@) { 3227 warn "leaving sync_job";
3228
3229 1
3230 } or do {
2117 warn $@; 3231 warn $@;
2118 warn "error while reloading, exiting."; 3232 warn "error while reloading, exiting.";
2119 exit 1; 3233 exit 1;
2120 } 3234 };
2121 3235
2122 warn "reloaded successfully"; 3236 warn "reloaded";
2123}; 3237};
2124 3238
2125############################################################################# 3239our $RELOAD_WATCHER; # used only during reload
2126 3240
2127unless ($LINK_MAP) { 3241sub reload_perl() {
2128 $LINK_MAP = cf::map::new; 3242 # doing reload synchronously and two reloads happen back-to-back,
3243 # coro crashes during coro_state_free->destroy here.
2129 3244
2130 $LINK_MAP->width (41); 3245 $RELOAD_WATCHER ||= Event->timer (
2131 $LINK_MAP->height (41); 3246 reentrant => 0,
2132 $LINK_MAP->alloc;
2133 $LINK_MAP->path ("{link}");
2134 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2135 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2136
2137 # dirty hack because... archetypes are not yet loaded
2138 Event->timer (
2139 after => 2, 3247 after => 0,
3248 data => WF_AUTOCANCEL,
2140 cb => sub { 3249 cb => sub {
2141 $_[0]->w->cancel; 3250 do_reload_perl;
2142 3251 undef $RELOAD_WATCHER;
2143 # provide some exits "home"
2144 my $exit = cf::object::new "exit";
2145
2146 $exit->slaying ($EMERGENCY_POSITION->[0]);
2147 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2148 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2149
2150 $LINK_MAP->insert ($exit->clone, 19, 19);
2151 $LINK_MAP->insert ($exit->clone, 19, 20);
2152 $LINK_MAP->insert ($exit->clone, 19, 21);
2153 $LINK_MAP->insert ($exit->clone, 20, 19);
2154 $LINK_MAP->insert ($exit->clone, 20, 21);
2155 $LINK_MAP->insert ($exit->clone, 21, 19);
2156 $LINK_MAP->insert ($exit->clone, 21, 20);
2157 $LINK_MAP->insert ($exit->clone, 21, 21);
2158
2159 $exit->destroy;
2160 }); 3252 },
2161 3253 );
2162 $LINK_MAP->{deny_save} = 1;
2163 $LINK_MAP->{deny_reset} = 1;
2164
2165 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2166} 3254}
2167
2168register "<global>", __PACKAGE__;
2169 3255
2170register_command "reload" => sub { 3256register_command "reload" => sub {
2171 my ($who, $arg) = @_; 3257 my ($who, $arg) = @_;
2172 3258
2173 if ($who->flag (FLAG_WIZ)) { 3259 if ($who->flag (FLAG_WIZ)) {
2174 $who->message ("start of reload.");
2175 reload;
2176 $who->message ("end of reload."); 3260 $who->message ("reloading server.");
3261 async { reload_perl };
2177 } 3262 }
2178}; 3263};
2179 3264
2180unshift @INC, $LIBDIR; 3265unshift @INC, $LIBDIR;
2181 3266
3267my $bug_warning = 0;
3268
3269our @WAIT_FOR_TICK;
3270our @WAIT_FOR_TICK_BEGIN;
3271
3272sub wait_for_tick {
3273 return unless $TICK_WATCHER->is_active;
3274 return if $Coro::current == $Coro::main;
3275
3276 my $signal = new Coro::Signal;
3277 push @WAIT_FOR_TICK, $signal;
3278 $signal->wait;
3279}
3280
3281sub wait_for_tick_begin {
3282 return unless $TICK_WATCHER->is_active;
3283 return if $Coro::current == $Coro::main;
3284
3285 my $signal = new Coro::Signal;
3286 push @WAIT_FOR_TICK_BEGIN, $signal;
3287 $signal->wait;
3288}
3289
3290 my $min = 1e6;#d#
3291 my $avg = 10;
2182$TICK_WATCHER = Event->timer ( 3292$TICK_WATCHER = Event->timer (
2183 reentrant => 0, 3293 reentrant => 0,
3294 parked => 1,
2184 prio => 0, 3295 prio => 0,
2185 at => $NEXT_TICK || $TICK, 3296 at => $NEXT_TICK || $TICK,
2186 data => WF_AUTOCANCEL, 3297 data => WF_AUTOCANCEL,
2187 cb => sub { 3298 cb => sub {
3299 if ($Coro::current != $Coro::main) {
3300 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3301 unless ++$bug_warning > 10;
3302 return;
3303 }
3304
3305 $NOW = $tick_start = Event::time;
3306
2188 cf::server_tick; # one server iteration 3307 cf::server_tick; # one server iteration
3308
3309 0 && sync_job {#d#
3310 for(1..10) {
3311 my $t = Event::time;
3312 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3313 or die;
3314
3315 $map->width (50);
3316 $map->height (50);
3317 $map->alloc;
3318 $map->_load_objects ("/tmp/x.map", 1);
3319 my $t = Event::time - $t;
3320
3321 #next unless $t < 0.0013;#d#
3322 if ($t < $min) {
3323 $min = $t;
3324 }
3325 $avg = $avg * 0.99 + $t * 0.01;
3326 }
3327 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3328 exit 0;
3329 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3330 };
3331
2189 $RUNTIME += $TICK; 3332 $RUNTIME += $TICK;
2190 $NEXT_TICK += $TICK; 3333 $NEXT_TICK += $TICK;
2191 3334
3335 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3336 $NEXT_RUNTIME_WRITE = $NOW + 10;
3337 Coro::async_pool {
3338 write_runtime
3339 or warn "ERROR: unable to write runtime file: $!";
3340 };
3341 }
3342
3343# my $AFTER = Event::time;
3344# warn $AFTER - $NOW;#d#
3345
3346 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3347 $sig->send;
3348 }
3349 while (my $sig = shift @WAIT_FOR_TICK) {
3350 $sig->send;
3351 }
3352
3353 $NOW = Event::time;
3354
2192 # if we are delayed by four ticks or more, skip them all 3355 # if we are delayed by four ticks or more, skip them all
2193 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3356 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2194 3357
2195 $TICK_WATCHER->at ($NEXT_TICK); 3358 $TICK_WATCHER->at ($NEXT_TICK);
2196 $TICK_WATCHER->start; 3359 $TICK_WATCHER->start;
3360
3361 $LOAD = ($NOW - $tick_start) / $TICK;
3362 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3363
3364 _post_tick;
3365
3366
2197 }, 3367 },
2198); 3368);
2199 3369
3370{
2200IO::AIO::max_poll_time $TICK * 0.2; 3371 BDB::max_poll_time $TICK * 0.1;
2201 3372 $BDB_POLL_WATCHER = Event->io (
2202Event->io ( 3373 reentrant => 0,
2203 fd => IO::AIO::poll_fileno, 3374 fd => BDB::poll_fileno,
2204 poll => 'r', 3375 poll => 'r',
2205 prio => 5, 3376 prio => 0,
2206 data => WF_AUTOCANCEL,
2207 cb => \&IO::AIO::poll_cb,
2208);
2209
2210Event->timer (
2211 data => WF_AUTOCANCEL, 3377 data => WF_AUTOCANCEL,
2212 after => 0, 3378 cb => \&BDB::poll_cb,
2213 interval => 10, 3379 );
2214 cb => sub { 3380 BDB::min_parallel 8;
2215 (Coro::unblock_sub { 3381
2216 write_runtime 3382 BDB::set_sync_prepare {
2217 or warn "ERROR: unable to write runtime file: $!"; 3383 my $status;
3384 my $current = $Coro::current;
3385 (
3386 sub {
3387 $status = $!;
3388 $current->ready; undef $current;
3389 },
3390 sub {
3391 Coro::schedule while defined $current;
3392 $! = $status;
3393 },
3394 )
3395 };
3396
3397 unless ($DB_ENV) {
3398 $DB_ENV = BDB::db_env_create;
3399
3400 cf::sync_job {
3401 eval {
3402 BDB::db_env_open
3403 $DB_ENV,
3404 $BDBDIR,
3405 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3406 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3407 0666;
3408
3409 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3410
3411 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3412 $DB_ENV->set_lk_detect;
3413 };
3414
3415 cf::cleanup "db_env_open(db): $@" if $@;
2218 })->(); 3416 };
2219 }, 3417 }
2220); 3418}
3419
3420{
3421 IO::AIO::min_parallel 8;
3422
3423 undef $Coro::AIO::WATCHER;
3424 IO::AIO::max_poll_time $TICK * 0.1;
3425 $AIO_POLL_WATCHER = Event->io (
3426 reentrant => 0,
3427 data => WF_AUTOCANCEL,
3428 fd => IO::AIO::poll_fileno,
3429 poll => 'r',
3430 prio => 6,
3431 cb => \&IO::AIO::poll_cb,
3432 );
3433}
3434
3435my $_log_backtrace;
3436
3437sub _log_backtrace {
3438 my ($msg, @addr) = @_;
3439
3440 $msg =~ s/\n//;
3441
3442 # limit the # of concurrent backtraces
3443 if ($_log_backtrace < 2) {
3444 ++$_log_backtrace;
3445 async {
3446 my @bt = fork_call {
3447 @addr = map { sprintf "%x", $_ } @addr;
3448 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3449 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3450 or die "addr2line: $!";
3451
3452 my @funcs;
3453 my @res = <$fh>;
3454 chomp for @res;
3455 while (@res) {
3456 my ($func, $line) = splice @res, 0, 2, ();
3457 push @funcs, "[$func] $line";
3458 }
3459
3460 @funcs
3461 };
3462
3463 LOG llevInfo, "[ABT] $msg\n";
3464 LOG llevInfo, "[ABT] $_\n" for @bt;
3465 --$_log_backtrace;
3466 };
3467 } else {
3468 LOG llevInfo, "[ABT] $msg\n";
3469 LOG llevInfo, "[ABT] [suppressed]\n";
3470 }
3471}
3472
3473# load additional modules
3474use cf::pod;
2221 3475
2222END { cf::emergency_save } 3476END { cf::emergency_save }
2223 3477
22241 34781
2225 3479

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines