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.134 by root, Thu Jan 4 17:28:49 2007 UTC vs.
Revision 1.319 by root, Tue Jul 24 15:56:45 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 Coro::cede;
1215
1216 if ($map) {
1217 $map->last_access ((delete $map->{last_access})
1218 || $cf::RUNTIME); #d#
1219 # safety
1220 $map->{instantiate_time} = $cf::RUNTIME
1221 if $map->{instantiate_time} > $cf::RUNTIME;
1222 } else {
1223 if (my $rmp = $path->random_map_params) {
1224 $map = generate_random_map $key, $rmp;
1225 } else {
1226 $map = try_load_header $path->load_path;
1227 }
1228
1229 $map or return; 1854 or return;
1230 1855
1231 $map->{load_original} = 1;
1232 $map->{instantiate_time} = $cf::RUNTIME;
1233 $map->last_access ($cf::RUNTIME);
1234 $map->instantiate;
1235
1236 # per-player maps become, after loading, normal maps
1237 $map->per_player (0) if $path->{user_rel};
1238 }
1239
1240 $map->path ($key);
1241 $map->{path} = $path;
1242 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1243 1857
1244 Coro::cede; 1858 $map->load_header
1859 or return;
1245 1860
1246 if ($map->should_reset) { 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;
1247 $map->reset; 1864 $map->reset;
1248 undef $guard; 1865 undef $guard;
1249 $map = find $path 1866 return find $path;
1250 or return;
1251 } 1867 }
1252 1868
1253 $cf::MAP{$key} = $map 1869 $cf::MAP{$path} = $map
1254 } 1870 }
1255} 1871}
1872
1873sub pre_load { }
1874sub post_load { }
1256 1875
1257sub load { 1876sub load {
1258 my ($self) = @_; 1877 my ($self) = @_;
1259 1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1260 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1261 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1884 my $guard = cf::lock_acquire "map_load:$path";
1262 1885
1263 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1264 1887
1265 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1266 1889
1267 $self->alloc; 1890 $self->alloc;
1891
1892 $self->pre_load;
1893 Coro::cede;
1894
1268 $self->load_objects ($self->{load_path}, 1) 1895 $self->_load_objects ($self->{load_path}, 1)
1269 or return; 1896 or return;
1270 1897
1271 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1272 if delete $self->{load_original}; 1899 if delete $self->{load_original};
1273 1900
1274 if (my $uniq = $path->uniq_path) { 1901 if (my $uniq = $self->uniq_path) {
1275 utf8::encode $uniq; 1902 utf8::encode $uniq;
1276 if (aio_open $uniq, O_RDONLY, 0) { 1903 if (aio_open $uniq, O_RDONLY, 0) {
1277 $self->clear_unique_items; 1904 $self->clear_unique_items;
1278 $self->load_objects ($uniq, 0); 1905 $self->_load_objects ($uniq, 0);
1279 } 1906 }
1280 } 1907 }
1281 1908
1282 Coro::cede; 1909 Coro::cede;
1283
1284 # now do the right thing for maps 1910 # now do the right thing for maps
1285 $self->link_multipart_objects; 1911 $self->link_multipart_objects;
1286
1287 if ($self->{path}->is_style_map) {
1288 $self->{deny_save} = 1;
1289 $self->{deny_reset} = 1;
1290 } else {
1291 $self->fix_auto_apply;
1292 $self->decay_objects;
1293 $self->update_buttons;
1294 $self->set_darkness_map;
1295 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1296 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;
1297 $self->activate; 1923 $self->activate;
1298 } 1924 }
1299 1925
1300 Coro::cede;
1301
1302 $self->in_memory (cf::MAP_IN_MEMORY); 1926 $self->in_memory (cf::MAP_IN_MEMORY);
1927 }
1928
1929 $self->post_load;
1930}
1931
1932sub customise_for {
1933 my ($self, $ob) = @_;
1934
1935 return find "~" . $ob->name . "/" . $self->{path}
1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1940
1941 $self
1942}
1943
1944# find and load all maps in the 3x3 area around a map
1945sub load_diag {
1946 my ($map) = @_;
1947
1948 my @diag; # diagonal neighbours
1949
1950 for (0 .. 3) {
1951 my $neigh = $map->tile_path ($_)
1952 or next;
1953 $neigh = find $neigh, $map
1954 or next;
1955 $neigh->load;
1956
1957 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1958 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1959 }
1960
1961 for (@diag) {
1962 my $neigh = find @$_
1963 or next;
1964 $neigh->load;
1965 }
1303} 1966}
1304 1967
1305sub find_sync { 1968sub find_sync {
1306 my ($path, $origin) = @_; 1969 my ($path, $origin) = @_;
1307 1970
1308 cf::sync_job { cf::map::find $path, $origin } 1971 cf::sync_job { find $path, $origin }
1309} 1972}
1310 1973
1311sub do_load_sync { 1974sub do_load_sync {
1312 my ($map) = @_; 1975 my ($map) = @_;
1313 1976
1314 cf::sync_job { $map->load }; 1977 cf::sync_job { $map->load };
1315} 1978}
1316 1979
1980our %MAP_PREFETCH;
1981our $MAP_PREFETCHER = undef;
1982
1983sub find_async {
1984 my ($path, $origin) = @_;
1985
1986 $path = normalise $path, $origin && $origin->{path};
1987
1988 if (my $map = $cf::MAP{$path}) {
1989 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1990 }
1991
1992 undef $MAP_PREFETCH{$path};
1993 $MAP_PREFETCHER ||= cf::async {
1994 while (%MAP_PREFETCH) {
1995 for my $path (keys %MAP_PREFETCH) {
1996 if (my $map = find $path) {
1997 $map->load;
1998 }
1999
2000 delete $MAP_PREFETCH{$path};
2001 }
2002 }
2003 undef $MAP_PREFETCHER;
2004 };
2005 $MAP_PREFETCHER->prio (6);
2006
2007 ()
2008}
2009
1317sub save { 2010sub save {
1318 my ($self) = @_; 2011 my ($self) = @_;
1319 2012
2013 my $lock = cf::lock_acquire "map_data:" . $self->path;
2014
1320 $self->{last_save} = $cf::RUNTIME; 2015 $self->{last_save} = $cf::RUNTIME;
1321 2016
1322 return unless $self->dirty; 2017 return unless $self->dirty;
1323 2018
1324 my $save = $self->{path}->save_path; utf8::encode $save; 2019 my $save = $self->save_path; utf8::encode $save;
1325 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2020 my $uniq = $self->uniq_path; utf8::encode $uniq;
1326 2021
1327 $self->{load_path} = $save; 2022 $self->{load_path} = $save;
1328 2023
1329 return if $self->{deny_save}; 2024 return if $self->{deny_save};
1330 2025
1331 local $self->{last_access} = $self->last_access;#d# 2026 local $self->{last_access} = $self->last_access;#d#
1332 2027
2028 cf::async {
2029 $_->contr->save for $self->players;
2030 };
2031
1333 if ($uniq) { 2032 if ($uniq) {
1334 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2033 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1335 $self->save_objects ($uniq, cf::IO_UNIQUES); 2034 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1336 } else { 2035 } else {
1337 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2036 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1338 } 2037 }
1339} 2038}
1340 2039
1341sub swap_out { 2040sub swap_out {
1342 my ($self) = @_; 2041 my ($self) = @_;
1343 2042
1344 # save first because save cedes 2043 # save first because save cedes
1345 $self->save; 2044 $self->save;
2045
2046 my $lock = cf::lock_acquire "map_data:" . $self->path;
1346 2047
1347 return if $self->players; 2048 return if $self->players;
1348 return if $self->in_memory != cf::MAP_IN_MEMORY; 2049 return if $self->in_memory != cf::MAP_IN_MEMORY;
1349 return if $self->{deny_save}; 2050 return if $self->{deny_save};
1350 2051
1354 2055
1355sub reset_at { 2056sub reset_at {
1356 my ($self) = @_; 2057 my ($self) = @_;
1357 2058
1358 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1359 return 1e99 if $self->{path}{user_rel};
1360 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1361 2061
1362 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1363 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1364 2064
1369 my ($self) = @_; 2069 my ($self) = @_;
1370 2070
1371 $self->reset_at <= $cf::RUNTIME 2071 $self->reset_at <= $cf::RUNTIME
1372} 2072}
1373 2073
1374sub unlink_save {
1375 my ($self) = @_;
1376
1377 utf8::encode (my $save = $self->{path}->save_path);
1378 aioreq_pri 3; IO::AIO::aio_unlink $save;
1379 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1380}
1381
1382sub rename {
1383 my ($self, $new_path) = @_;
1384
1385 $self->unlink_save;
1386
1387 delete $cf::MAP{$self->path};
1388 $self->{path} = new cf::path $new_path;
1389 $self->path ($self->{path}->as_string);
1390 $cf::MAP{$self->path} = $self;
1391
1392 $self->save;
1393}
1394
1395sub reset { 2074sub reset {
1396 my ($self) = @_; 2075 my ($self) = @_;
1397 2076
2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
2078
1398 return if $self->players; 2079 return if $self->players;
1399 return if $self->{path}{user_rel};#d#
1400 2080
1401 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
2082
2083 $self->in_memory (cf::MAP_SWAPPED);
2084
2085 # need to save uniques path
2086 unless ($self->{deny_save}) {
2087 my $uniq = $self->uniq_path; utf8::encode $uniq;
2088
2089 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2090 if $uniq;
2091 }
1402 2092
1403 delete $cf::MAP{$self->path}; 2093 delete $cf::MAP{$self->path};
2094
2095 $self->clear;
1404 2096
1405 $_->clear_links_to ($self) for values %cf::MAP; 2097 $_->clear_links_to ($self) for values %cf::MAP;
1406 2098
1407 $self->unlink_save; 2099 $self->unlink_save;
1408 $self->destroy; 2100 $self->destroy;
1411my $nuke_counter = "aaaa"; 2103my $nuke_counter = "aaaa";
1412 2104
1413sub nuke { 2105sub nuke {
1414 my ($self) = @_; 2106 my ($self) = @_;
1415 2107
2108 delete $cf::MAP{$self->path};
2109
2110 $self->unlink_save;
2111
2112 bless $self, "cf::map";
2113 delete $self->{deny_reset};
1416 $self->{deny_save} = 1; 2114 $self->{deny_save} = 1;
1417 $self->reset_timeout (1); 2115 $self->reset_timeout (1);
1418 $self->rename ("{nuke}/" . ($nuke_counter++)); 2116 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2117
2118 $cf::MAP{$self->path} = $self;
2119
1419 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1420} 2121}
1421 2122
1422sub customise_for { 2123=item $maps = cf::map::tmp_maps
1423 my ($map, $ob) = @_;
1424 2124
1425 if ($map->per_player) { 2125Returns an arrayref with all map paths of currently instantiated and saved
1426 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
1427 } 2131 [
1428 2132 map {
1429 $map 2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
1430} 2139}
1431 2140
1432sub emergency_save { 2141=item $maps = cf::map::random_maps
1433 my $freeze_guard = cf::freeze_mainloop;
1434 2142
1435 warn "enter emergency map save\n"; 2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
1436 2145
1437 cf::sync_job { 2146=cut
1438 warn "begin emergency map save\n";
1439 $_->save for values %cf::MAP;
1440 };
1441 2147
1442 warn "end emergency map save\n"; 2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
2159=item cf::map::unique_maps
2160
2161Returns an arrayref of paths of all shared maps that have
2162instantiated unique items. May block.
2163
2164=cut
2165
2166sub unique_maps() {
2167 [
2168 map {
2169 utf8::decode $_;
2170 /\.map$/
2171 ? normalise $_
2172 : ()
2173 } @{ aio_readdir $UNIQUEDIR or [] }
2174 ]
1443} 2175}
1444 2176
1445package cf; 2177package cf;
1446 2178
1447=back 2179=back
1448 2180
2181=head3 cf::object
2182
2183=cut
2184
2185package cf::object;
2186
2187=over 4
2188
2189=item $ob->inv_recursive
2190
2191Returns the inventory of the object _and_ their inventories, recursively.
2192
2193=cut
2194
2195sub inv_recursive_;
2196sub inv_recursive_ {
2197 map { $_, inv_recursive_ $_->inv } @_
2198}
2199
2200sub inv_recursive {
2201 inv_recursive_ inv $_[0]
2202}
2203
2204package cf;
2205
2206=back
1449 2207
1450=head3 cf::object::player 2208=head3 cf::object::player
1451 2209
1452=over 4 2210=over 4
1453 2211
1467 2225
1468 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1469 2227
1470 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1471 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1472 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1473 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1474 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1475 } 2242 }
1476} 2243}
1477 2244
1478=item $player_object->may ("access") 2245=item $player_object->may ("access")
1479 2246
1493 2260
1494=item $player_object->enter_link 2261=item $player_object->enter_link
1495 2262
1496Freezes the player and moves him/her to a special map (C<{link}>). 2263Freezes the player and moves him/her to a special map (C<{link}>).
1497 2264
1498The player should be reaosnably safe there for short amounts of time. You 2265The player should be reasonably safe there for short amounts of time. You
1499I<MUST> call C<leave_link> as soon as possible, though. 2266I<MUST> call C<leave_link> as soon as possible, though.
1500 2267
2268Will never block.
2269
1501=item $player_object->leave_link ($map, $x, $y) 2270=item $player_object->leave_link ($map, $x, $y)
1502 2271
1503Moves the player out of the specila link map onto the given map. If the 2272Moves the player out of the special C<{link}> map onto the specified
1504map is not valid (or omitted), the player will be moved back to the 2273map. If the map is not valid (or omitted), the player will be moved back
1505location he/she was before the call to C<enter_link>, or, if that fails, 2274to the location he/she was before the call to C<enter_link>, or, if that
1506to the emergency map position. 2275fails, to the emergency map position.
1507 2276
1508Might block. 2277Might block.
1509 2278
1510=cut 2279=cut
2280
2281sub link_map {
2282 unless ($LINK_MAP) {
2283 $LINK_MAP = cf::map::find "{link}"
2284 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2285 $LINK_MAP->load;
2286 }
2287
2288 $LINK_MAP
2289}
1511 2290
1512sub cf::object::player::enter_link { 2291sub cf::object::player::enter_link {
1513 my ($self) = @_; 2292 my ($self) = @_;
1514 2293
1515 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1516 2295
1517 return if $self->map == $LINK_MAP; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1518 2297
1519 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1520 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1521 2300
1522 $self->enter_map ($LINK_MAP, 20, 20); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1523} 2302}
1524 2303
1525sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1526 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1527 2308
1528 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1529 2310
1530 unless ($map) { 2311 unless ($map) {
1531 # restore original map position 2312 # restore original map position
1545 # use -1 or undef as default coordinates, not 0, 0 2326 # use -1 or undef as default coordinates, not 0, 0
1546 ($x, $y) = ($map->enter_x, $map->enter_y) 2327 ($x, $y) = ($map->enter_x, $map->enter_y)
1547 if $x <=0 && $y <= 0; 2328 if $x <=0 && $y <= 0;
1548 2329
1549 $map->load; 2330 $map->load;
2331 $map->load_diag;
1550 2332
2333 return unless $self->contr->active;
1551 $self->activate_recursive; 2334 $self->activate_recursive;
2335
2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1552 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1553} 2338}
1554 2339
1555cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1556 on_logout => sub {
1557 my ($pl) = @_;
1558 2341
1559 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1560 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1561 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1562 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1563 }; 2346be called at the end of this process.
1564 }
1565 },
1566 on_login => sub {
1567 my ($pl) = @_;
1568 2347
1569 # try to abort aborted map switching on player login :)
1570 # should happen only on crashes
1571 if ($pl->ob->{_link_pos}) {
1572 $pl->ob->enter_link;
1573 cf::async {
1574 # we need this sleep as the login has a concurrent enter_exit running
1575 # and this sleep increases chances of the player not ending up in scorn
1576 Coro::Timer::sleep 1;
1577 $pl->ob->leave_link;
1578 };
1579 }
1580 },
1581);
1582
1583=item $player_object->goto_map ($path, $x, $y)
1584
1585=cut 2348=cut
1586 2349
2350our $GOTOGEN;
2351
1587sub cf::object::player::goto_map { 2352sub cf::object::player::goto {
1588 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1589 2357
1590 $self->enter_link; 2358 $self->enter_link;
1591 2359
1592 (cf::async { 2360 (async {
1593 $path = new cf::path $path; 2361 my $map = eval {
1594
1595 my $map = cf::map::find $path->as_string; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1596 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
1597 2366 $map = $check->($map) if $check && $map;
1598# warn "entering ", $map->path, " at ($x, $y)\n" 2367 } else {
1599# if $map;
1600
1601 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
1602 2370
2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
2377 }
2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1603 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1604 })->prio (1); 2385 })->prio (1);
1605} 2386}
1606 2387
1607=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1608 2389
1610 2391
1611sub parse_random_map_params { 2392sub parse_random_map_params {
1612 my ($spec) = @_; 2393 my ($spec) = @_;
1613 2394
1614 my $rmp = { # defaults 2395 my $rmp = { # defaults
1615 xsize => 10, 2396 xsize => (cf::rndm 15, 40),
1616 ysize => 10, 2397 ysize => (cf::rndm 15, 40),
2398 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2399 #layout => string,
1617 }; 2400 };
1618 2401
1619 for (split /\n/, $spec) { 2402 for (split /\n/, $spec) {
1620 my ($k, $v) = split /\s+/, $_, 2; 2403 my ($k, $v) = split /\s+/, $_, 2;
1621 2404
1625 $rmp 2408 $rmp
1626} 2409}
1627 2410
1628sub prepare_random_map { 2411sub prepare_random_map {
1629 my ($exit) = @_; 2412 my ($exit) = @_;
2413
2414 my $guard = cf::lock_acquire "exit_prepare:$exit";
1630 2415
1631 # all this does is basically replace the /! path by 2416 # all this does is basically replace the /! path by
1632 # a new random map path (?random/...) with a seed 2417 # a new random map path (?random/...) with a seed
1633 # that depends on the exit object 2418 # that depends on the exit object
1634 2419
1635 my $rmp = parse_random_map_params $exit->msg; 2420 my $rmp = parse_random_map_params $exit->msg;
1636 2421
1637 if ($exit->map) { 2422 if ($exit->map) {
1638 $rmp->{region} = $exit->map->region_name; 2423 $rmp->{region} = $exit->region->name;
1639 $rmp->{origin_map} = $exit->map->path; 2424 $rmp->{origin_map} = $exit->map->path;
1640 $rmp->{origin_x} = $exit->x; 2425 $rmp->{origin_x} = $exit->x;
1641 $rmp->{origin_y} = $exit->y; 2426 $rmp->{origin_y} = $exit->y;
1642 } 2427 }
1643 2428
1644 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1645 2430
1646 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1647 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
2433 my $meta = "$RANDOMDIR/$md5.meta";
1648 2434
1649 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1650 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
2437 undef $fh;
2438 aio_rename "$meta~", $meta;
1651 2439
1652 $exit->slaying ("?random/$md5"); 2440 $exit->slaying ("?random/$md5");
1653 $exit->msg (undef); 2441 $exit->msg (undef);
1654 } 2442 }
1655} 2443}
1657sub cf::object::player::enter_exit { 2445sub cf::object::player::enter_exit {
1658 my ($self, $exit) = @_; 2446 my ($self, $exit) = @_;
1659 2447
1660 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1661 2449
2450 if ($exit->slaying eq "/!") {
2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
2454 cf::sync_job { prepare_random_map $exit };
2455 }
2456
2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2458 my $hp = $exit->stats->hp;
2459 my $sp = $exit->stats->sp;
2460
1662 $self->enter_link; 2461 $self->enter_link;
1663 2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
2466
1664 (cf::async { 2467 (async {
1665 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1666 unless (eval { 2469 unless (eval {
1667 prepare_random_map $exit 2470 $self->goto ($slaying, $hp, $sp);
1668 if $exit->slaying eq "/!";
1669
1670 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1671 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1672 2471
1673 1; 2472 1;
1674 }) { 2473 }) {
1675 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1676 . "I'll try to bring you back to the map you were before. " 2475 . "I'll try to bring you back to the map you were before. "
1677 . "Please report this to the dungeon master", 2476 . "Please report this to the dungeon master!",
1678 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1679 2478
1680 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1681 $self->leave_link; 2480 $self->leave_link;
1682 } 2481 }
1683 })->prio (1); 2482 })->prio (1);
1696 2495
1697sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1698 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1699 2498
1700 utf8::encode $text; 2499 utf8::encode $text;
1701 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1702} 2501}
1703 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
1704 2573
1705=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
1706 2575
1707Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
1708the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1709C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1710 2579
1711Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
1712reliable at some point in the future. 2581become reliable at some point in the future.
1713 2582
1714=cut 2583=cut
1715 2584
1716sub cf::client::query { 2585sub cf::client::query {
1717 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
1725 utf8::encode $text; 2594 utf8::encode $text;
1726 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1727 2596
1728 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
1729 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
1730} 2601}
1731 2602
1732cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
1733 on_reply => sub { 2609 on_reply => sub {
1734 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
1735 2611
1736 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
1737 # get handled first 2613 # get handled first
1738 my $queue = delete $ns->{query_queue} 2614 my $queue = delete $ns->{query_queue}
1739 or return; # be conservative, not sure how that can happen, but we saw a crash here 2615 or return; # be conservative, not sure how that can happen, but we saw a crash here
1740 2616
1741 (shift @$queue)->[1]->($msg); 2617 (shift @$queue)->[1]->($msg);
2618 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1742 2619
1743 push @{ $ns->{query_queue} }, @$queue; 2620 push @{ $ns->{query_queue} }, @$queue;
1744 2621
1745 if (@{ $ns->{query_queue} } == @$queue) { 2622 if (@{ $ns->{query_queue} } == @$queue) {
1746 if (@$queue) { 2623 if (@$queue) {
1748 } else { 2625 } else {
1749 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1750 } 2627 }
1751 } 2628 }
1752 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
1753); 2653);
1754 2654
1755=item $client->coro (\&cb) 2655=item $client->async (\&cb)
1756 2656
1757Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
1758be automatically cancelled when the client gets destroyed (e.g. on logout, 2658be automatically cancelled when the client gets destroyed (e.g. on logout,
1759or loss of connection). 2659or loss of connection).
1760 2660
1761=cut 2661=cut
1762 2662
1763sub cf::client::coro { 2663sub cf::client::async {
1764 my ($self, $cb) = @_; 2664 my ($self, $cb) = @_;
1765 2665
1766 my $coro = &cf::async ($cb); 2666 my $coro = &Coro::async ($cb);
1767 2667
1768 $coro->on_destroy (sub { 2668 $coro->on_destroy (sub {
1769 delete $self->{_coro}{$coro+0}; 2669 delete $self->{_coro}{$coro+0};
1770 }); 2670 });
1771 2671
1804 2704
1805# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
1806 2706
1807=pod 2707=pod
1808 2708
1809The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
1810 2710
1811 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
1812 cf::object::player player 2715 cf::object::player
1813 cf::player peaceful 2716 player
1814 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
1815 2723
1816=cut 2724=cut
1817 2725
1818for ( 2726for (
1819 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
1820 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
1821 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
1822 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
1823) { 2732) {
1824 no strict 'refs'; 2733 no strict 'refs';
1895=back 2804=back
1896 2805
1897=cut 2806=cut
1898 2807
1899############################################################################# 2808#############################################################################
2809# the server's init and main functions
1900 2810
1901=head2 EXTENSION DATABASE SUPPORT 2811sub load_facedata($) {
2812 my ($path) = @_;
1902 2813
1903Crossfire maintains a very simple database for extension use. It can 2814 warn "loading facedata from $path\n";
1904currently store anything that can be serialised using Storable, which
1905excludes objects.
1906 2815
1907The parameter C<$family> should best start with the name of the extension 2816 my $facedata;
1908using it, it should be unique. 2817 0 < aio_load $path, $facedata
2818 or die "$path: $!";
1909 2819
1910=over 4 2820 $facedata = Coro::Storable::thaw $facedata;
1911 2821
1912=item $hashref = cf::db_get $family 2822 $facedata->{version} == 2
2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
1913 2824
1914Return a hashref for use by the extension C<$family>, which can be
1915modified. After modifications, you have to call C<cf::db_dirty> or
1916C<cf::db_sync>.
1917
1918=item $value = cf::db_get $family => $key
1919
1920Returns a single value from the database
1921
1922=item cf::db_put $family => $hashref
1923
1924Stores the given family hashref into the database. Updates are delayed, if
1925you want the data to be synced to disk immediately, use C<cf::db_sync>.
1926
1927=item cf::db_put $family => $key => $value
1928
1929Stores the given C<$value> in the family hash. Updates are delayed, if you
1930want the data to be synced to disk immediately, use C<cf::db_sync>.
1931
1932=item cf::db_dirty
1933
1934Marks the database as dirty, to be updated at a later time.
1935
1936=item cf::db_sync
1937
1938Immediately write the database to disk I<if it is dirty>.
1939
1940=cut
1941
1942our $DB;
1943
1944{
1945 my $path = cf::localdir . "/database.pst";
1946
1947 sub db_load() {
1948 $DB = stat $path ? Storable::retrieve $path : { };
1949 } 2825 {
2826 my $faces = $facedata->{faceinfo};
1950 2827
1951 my $pid; 2828 while (my ($face, $info) = each %$faces) {
2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1952 2834
1953 sub db_save() { 2835 cf::cede_to_tick;
1954 waitpid $pid, 0 if $pid;
1955 if (0 == ($pid = fork)) {
1956 $DB->{_meta}{version} = 1;
1957 Storable::nstore $DB, "$path~";
1958 rename "$path~", $path;
1959 cf::_exit 0 if defined $pid;
1960 }
1961 }
1962
1963 my $dirty;
1964
1965 sub db_sync() {
1966 db_save if $dirty;
1967 undef $dirty;
1968 }
1969
1970 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1971 db_sync;
1972 });
1973
1974 sub db_dirty() {
1975 $dirty = 1;
1976 $idle->start;
1977 }
1978
1979 sub db_get($;$) {
1980 @_ >= 2
1981 ? $DB->{$_[0]}{$_[1]}
1982 : ($DB->{$_[0]} ||= { })
1983 }
1984
1985 sub db_put($$;$) {
1986 if (@_ >= 3) {
1987 $DB->{$_[0]}{$_[1]} = $_[2];
1988 } else {
1989 $DB->{$_[0]} = $_[1];
1990 }
1991 db_dirty;
1992 }
1993
1994 cf::global->attach (
1995 prio => 10000,
1996 on_cleanup => sub {
1997 db_sync;
1998 }, 2836 }
1999 );
2000}
2001 2837
2002############################################################################# 2838 while (my ($face, $info) = each %$faces) {
2003# the server's main() 2839 next unless $info->{smooth};
2840 my $idx = cf::face::find $face
2841 or next;
2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2845 } else {
2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2847 }
2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 while (my ($name, $info) = each %$res) {
2871 my $meta = $enc->encode ({
2872 name => $name,
2873 copyright => $info->{copyright}, #TODO#
2874 });
2875
2876 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2877
2878 if ($info->{type} & 1) {
2879 # prepend meta info
2880
2881 my $data = pack "(w/a*)*", $meta, $info->{data};
2882 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2883
2884 cf::face::set_data $idx, 0, $data, $chk;
2885 } else {
2886 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2887 }
2888
2889 cf::face::set_type $idx, $info->{type};
2890
2891 cf::cede_to_tick;
2892 }
2893 }
2894
2895 1
2896}
2897
2898register_exticmd fx_want => sub {
2899 my ($ns, $want) = @_;
2900
2901 while (my ($k, $v) = each %$want) {
2902 $ns->fx_want ($k, $v);
2903 }
2904};
2905
2906sub reload_regions {
2907 load_resource_file "$MAPDIR/regions"
2908 or die "unable to load regions file\n";
2909
2910 for (cf::region::list) {
2911 $_->{match} = qr/$_->{match}/
2912 if exists $_->{match};
2913 }
2914}
2915
2916sub reload_facedata {
2917 load_facedata "$DATADIR/facedata"
2918 or die "unable to load facedata\n";
2919}
2920
2921sub reload_archetypes {
2922 load_resource_file "$DATADIR/archetypes"
2923 or die "unable to load archetypes\n";
2924 #d# NEED to laod twice to resolve forward references
2925 # this really needs to be done in an extra post-pass
2926 # (which needs to be synchronous, so solve it differently)
2927 load_resource_file "$DATADIR/archetypes"
2928 or die "unable to load archetypes\n";
2929}
2930
2931sub reload_treasures {
2932 load_resource_file "$DATADIR/treasures"
2933 or die "unable to load treasurelists\n";
2934}
2935
2936sub reload_resources {
2937 warn "reloading resource files...\n";
2938
2939 reload_regions;
2940 reload_facedata;
2941 #reload_archetypes;#d#
2942 reload_archetypes;
2943 reload_treasures;
2944
2945 warn "finished reloading resource files\n";
2946}
2947
2948sub init {
2949 reload_resources;
2950}
2004 2951
2005sub cfg_load { 2952sub cfg_load {
2006 open my $fh, "<:utf8", cf::confdir . "/config" 2953 open my $fh, "<:utf8", "$CONFDIR/config"
2007 or return; 2954 or return;
2008 2955
2009 local $/; 2956 local $/;
2010 *CFG = YAML::Syck::Load <$fh>; 2957 *CFG = YAML::Syck::Load <$fh>;
2011 2958
2012 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2959 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2013 2960
2961 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2962 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2963
2014 if (exists $CFG{mlockall}) { 2964 if (exists $CFG{mlockall}) {
2015 eval { 2965 eval {
2016 $CFG{mlockall} ? &mlockall : &munlockall 2966 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2017 and die "WARNING: m(un)lockall failed: $!\n"; 2967 and die "WARNING: m(un)lockall failed: $!\n";
2018 }; 2968 };
2019 warn $@ if $@; 2969 warn $@ if $@;
2020 } 2970 }
2021} 2971}
2022 2972
2023sub main { 2973sub main {
2024 # we must not ever block the main coroutine 2974 # we must not ever block the main coroutine
2025 local $Coro::idle = sub { 2975 local $Coro::idle = sub {
2026 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2976 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2027 (Coro::unblock_sub { 2977 (async {
2028 Event::one_event; 2978 Event::one_event;
2029 })->(); 2979 })->prio (Coro::PRIO_MAX);
2030 }; 2980 };
2031 2981
2032 cfg_load; 2982 cfg_load;
2033 db_load; 2983 db_init;
2034 load_extensions; 2984 load_extensions;
2985
2986 $TICK_WATCHER->start;
2035 Event::loop; 2987 Event::loop;
2036} 2988}
2037 2989
2038############################################################################# 2990#############################################################################
2039# initialisation 2991# initialisation and cleanup
2040 2992
2993# install some emergency cleanup handlers
2994BEGIN {
2995 for my $signal (qw(INT HUP TERM)) {
2996 Event->signal (
2997 reentrant => 0,
2998 data => WF_AUTOCANCEL,
2999 signal => $signal,
3000 prio => 0,
3001 cb => sub {
3002 cf::cleanup "SIG$signal";
3003 },
3004 );
3005 }
3006}
3007
3008sub write_runtime {
3009 my $runtime = "$LOCALDIR/runtime";
3010
3011 # first touch the runtime file to show we are still running:
3012 # the fsync below can take a very very long time.
3013
3014 IO::AIO::aio_utime $runtime, undef, undef;
3015
3016 my $guard = cf::lock_acquire "write_runtime";
3017
3018 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3019 or return;
3020
3021 my $value = $cf::RUNTIME + 90 + 10;
3022 # 10 is the runtime save interval, for a monotonic clock
3023 # 60 allows for the watchdog to kill the server.
3024
3025 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3026 and return;
3027
3028 # always fsync - this file is important
3029 aio_fsync $fh
3030 and return;
3031
3032 # touch it again to show we are up-to-date
3033 aio_utime $fh, undef, undef;
3034
3035 close $fh
3036 or return;
3037
3038 aio_rename "$runtime~", $runtime
3039 and return;
3040
3041 warn "runtime file written.\n";
3042
3043 1
3044}
3045
3046sub emergency_save() {
3047 my $freeze_guard = cf::freeze_mainloop;
3048
3049 warn "enter emergency perl save\n";
3050
3051 cf::sync_job {
3052 # use a peculiar iteration method to avoid tripping on perl
3053 # refcount bugs in for. also avoids problems with players
3054 # and maps saved/destroyed asynchronously.
3055 warn "begin emergency player save\n";
3056 for my $login (keys %cf::PLAYER) {
3057 my $pl = $cf::PLAYER{$login} or next;
3058 $pl->valid or next;
3059 $pl->save;
3060 }
3061 warn "end emergency player save\n";
3062
3063 warn "begin emergency map save\n";
3064 for my $path (keys %cf::MAP) {
3065 my $map = $cf::MAP{$path} or next;
3066 $map->valid or next;
3067 $map->save;
3068 }
3069 warn "end emergency map save\n";
3070
3071 warn "begin emergency database checkpoint\n";
3072 BDB::db_env_txn_checkpoint $DB_ENV;
3073 warn "end emergency database checkpoint\n";
3074 };
3075
3076 warn "leave emergency perl save\n";
3077}
3078
3079sub post_cleanup {
3080 my ($make_core) = @_;
3081
3082 warn Carp::longmess "post_cleanup backtrace"
3083 if $make_core;
3084}
3085
2041sub reload() { 3086sub do_reload_perl() {
2042 # can/must only be called in main 3087 # can/must only be called in main
2043 if ($Coro::current != $Coro::main) { 3088 if ($Coro::current != $Coro::main) {
2044 warn "can only reload from main coroutine\n"; 3089 warn "can only reload from main coroutine";
2045 return; 3090 return;
2046 } 3091 }
2047 3092
2048 warn "reloading..."; 3093 warn "reloading...";
2049 3094
2050 my $guard = freeze_mainloop; 3095 warn "entering sync_job";
3096
3097 cf::sync_job {
3098 cf::write_runtime; # external watchdog should not bark
2051 cf::emergency_save; 3099 cf::emergency_save;
3100 cf::write_runtime; # external watchdog should not bark
2052 3101
2053 eval { 3102 warn "syncing database to disk";
3103 BDB::db_env_txn_checkpoint $DB_ENV;
3104
2054 # if anything goes wrong in here, we should simply crash as we already saved 3105 # if anything goes wrong in here, we should simply crash as we already saved
2055 3106
2056 # cancel all watchers 3107 warn "cancelling all WF_AUTOCANCEL watchers";
2057 for (Event::all_watchers) { 3108 for (Event::all_watchers) {
2058 $_->cancel if $_->data & WF_AUTOCANCEL; 3109 $_->cancel if $_->data & WF_AUTOCANCEL;
2059 } 3110 }
2060 3111
3112 warn "flushing outstanding aio requests";
3113 for (;;) {
3114 BDB::flush;
3115 IO::AIO::flush;
3116 Coro::cede;
3117 last unless IO::AIO::nreqs || BDB::nreqs;
3118 warn "iterate...";
3119 }
3120
3121 ++$RELOAD;
3122
2061 # cancel all extension coros 3123 warn "cancelling all extension coros";
2062 $_->cancel for values %EXT_CORO; 3124 $_->cancel for values %EXT_CORO;
2063 %EXT_CORO = (); 3125 %EXT_CORO = ();
2064 3126
2065 # unload all extensions 3127 warn "removing commands";
2066 for (@exts) { 3128 %COMMAND = ();
3129
3130 warn "removing ext/exti commands";
3131 %EXTCMD = ();
3132 %EXTICMD = ();
3133
3134 warn "unloading/nuking all extensions";
3135 for my $pkg (@EXTS) {
2067 warn "unloading <$_>"; 3136 warn "... unloading $pkg";
2068 unload_extension $_; 3137
3138 if (my $cb = $pkg->can ("unload")) {
3139 eval {
3140 $cb->($pkg);
3141 1
3142 } or warn "$pkg unloaded, but with errors: $@";
2069 } 3143 }
2070 3144
3145 warn "... nuking $pkg";
3146 Symbol::delete_package $pkg;
3147 }
3148
2071 # unload all modules loaded from $LIBDIR 3149 warn "unloading all perl modules loaded from $LIBDIR";
2072 while (my ($k, $v) = each %INC) { 3150 while (my ($k, $v) = each %INC) {
2073 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3151 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2074 3152
2075 warn "removing <$k>"; 3153 warn "... unloading $k";
2076 delete $INC{$k}; 3154 delete $INC{$k};
2077 3155
2078 $k =~ s/\.pm$//; 3156 $k =~ s/\.pm$//;
2079 $k =~ s/\//::/g; 3157 $k =~ s/\//::/g;
2080 3158
2083 } 3161 }
2084 3162
2085 Symbol::delete_package $k; 3163 Symbol::delete_package $k;
2086 } 3164 }
2087 3165
2088 # sync database to disk
2089 cf::db_sync;
2090 IO::AIO::flush;
2091
2092 # get rid of safe::, as good as possible 3166 warn "getting rid of safe::, as good as possible";
2093 Symbol::delete_package "safe::$_" 3167 Symbol::delete_package "safe::$_"
2094 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3168 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2095 3169
2096 # remove register_script_function callbacks
2097 # TODO
2098
2099 # unload cf.pm "a bit" 3170 warn "unloading cf.pm \"a bit\"";
2100 delete $INC{"cf.pm"}; 3171 delete $INC{"cf.pm"};
3172 delete $INC{"cf/pod.pm"};
2101 3173
2102 # don't, removes xs symbols, too, 3174 # don't, removes xs symbols, too,
2103 # and global variables created in xs 3175 # and global variables created in xs
2104 #Symbol::delete_package __PACKAGE__; 3176 #Symbol::delete_package __PACKAGE__;
2105 3177
2106 # reload cf.pm 3178 warn "unload completed, starting to reload now";
3179
2107 warn "reloading cf.pm"; 3180 warn "reloading cf.pm";
2108 require cf; 3181 require cf;
2109 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3182 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2110 3183
2111 # load config and database again 3184 warn "loading config and database again";
2112 cf::cfg_load; 3185 cf::cfg_load;
2113 cf::db_load;
2114 3186
2115 # load extensions
2116 warn "load extensions"; 3187 warn "loading extensions";
2117 cf::load_extensions; 3188 cf::load_extensions;
2118 3189
2119 # reattach attachments to objects 3190 warn "reattaching attachments to objects/players";
2120 warn "reattach"; 3191 _global_reattach; # objects, sockets
2121 _global_reattach; 3192 warn "reattaching attachments to maps";
2122 }; 3193 reattach $_ for values %MAP;
3194 warn "reattaching attachments to players";
3195 reattach $_ for values %PLAYER;
2123 3196
2124 if ($@) { 3197 warn "leaving sync_job";
3198
3199 1
3200 } or do {
2125 warn $@; 3201 warn $@;
2126 warn "error while reloading, exiting."; 3202 warn "error while reloading, exiting.";
2127 exit 1; 3203 exit 1;
2128 } 3204 };
2129 3205
2130 warn "reloaded successfully"; 3206 warn "reloaded";
2131}; 3207};
2132 3208
2133############################################################################# 3209our $RELOAD_WATCHER; # used only during reload
2134 3210
2135unless ($LINK_MAP) { 3211sub reload_perl() {
2136 $LINK_MAP = cf::map::new; 3212 # doing reload synchronously and two reloads happen back-to-back,
3213 # coro crashes during coro_state_free->destroy here.
2137 3214
2138 $LINK_MAP->width (41); 3215 $RELOAD_WATCHER ||= Event->timer (
2139 $LINK_MAP->height (41); 3216 reentrant => 0,
2140 $LINK_MAP->alloc;
2141 $LINK_MAP->path ("{link}");
2142 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2143 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2144
2145 # dirty hack because... archetypes are not yet loaded
2146 Event->timer (
2147 after => 2, 3217 after => 0,
3218 data => WF_AUTOCANCEL,
2148 cb => sub { 3219 cb => sub {
2149 $_[0]->w->cancel; 3220 do_reload_perl;
2150 3221 undef $RELOAD_WATCHER;
2151 # provide some exits "home"
2152 my $exit = cf::object::new "exit";
2153
2154 $exit->slaying ($EMERGENCY_POSITION->[0]);
2155 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2156 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2157
2158 $LINK_MAP->insert ($exit->clone, 19, 19);
2159 $LINK_MAP->insert ($exit->clone, 19, 20);
2160 $LINK_MAP->insert ($exit->clone, 19, 21);
2161 $LINK_MAP->insert ($exit->clone, 20, 19);
2162 $LINK_MAP->insert ($exit->clone, 20, 21);
2163 $LINK_MAP->insert ($exit->clone, 21, 19);
2164 $LINK_MAP->insert ($exit->clone, 21, 20);
2165 $LINK_MAP->insert ($exit->clone, 21, 21);
2166
2167 $exit->destroy;
2168 }); 3222 },
2169 3223 );
2170 $LINK_MAP->{deny_save} = 1;
2171 $LINK_MAP->{deny_reset} = 1;
2172
2173 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2174} 3224}
2175
2176register "<global>", __PACKAGE__;
2177 3225
2178register_command "reload" => sub { 3226register_command "reload" => sub {
2179 my ($who, $arg) = @_; 3227 my ($who, $arg) = @_;
2180 3228
2181 if ($who->flag (FLAG_WIZ)) { 3229 if ($who->flag (FLAG_WIZ)) {
2182 $who->message ("start of reload.");
2183 reload;
2184 $who->message ("end of reload."); 3230 $who->message ("reloading server.");
3231 async { reload_perl };
2185 } 3232 }
2186}; 3233};
2187 3234
2188unshift @INC, $LIBDIR; 3235unshift @INC, $LIBDIR;
2189 3236
3237my $bug_warning = 0;
3238
3239our @WAIT_FOR_TICK;
3240our @WAIT_FOR_TICK_BEGIN;
3241
3242sub wait_for_tick {
3243 return unless $TICK_WATCHER->is_active;
3244 return if $Coro::current == $Coro::main;
3245
3246 my $signal = new Coro::Signal;
3247 push @WAIT_FOR_TICK, $signal;
3248 $signal->wait;
3249}
3250
3251sub wait_for_tick_begin {
3252 return unless $TICK_WATCHER->is_active;
3253 return if $Coro::current == $Coro::main;
3254
3255 my $signal = new Coro::Signal;
3256 push @WAIT_FOR_TICK_BEGIN, $signal;
3257 $signal->wait;
3258}
3259
3260 my $min = 1e6;#d#
3261 my $avg = 10;
2190$TICK_WATCHER = Event->timer ( 3262$TICK_WATCHER = Event->timer (
2191 reentrant => 0, 3263 reentrant => 0,
3264 parked => 1,
2192 prio => 0, 3265 prio => 0,
2193 at => $NEXT_TICK || $TICK, 3266 at => $NEXT_TICK || $TICK,
2194 data => WF_AUTOCANCEL, 3267 data => WF_AUTOCANCEL,
2195 cb => sub { 3268 cb => sub {
3269 if ($Coro::current != $Coro::main) {
3270 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3271 unless ++$bug_warning > 10;
3272 return;
3273 }
3274
3275 $NOW = $tick_start = Event::time;
3276
2196 cf::server_tick; # one server iteration 3277 cf::server_tick; # one server iteration
3278
3279 0 && sync_job {#d#
3280 for(1..10) {
3281 my $t = Event::time;
3282 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3283 or die;
3284
3285 $map->width (50);
3286 $map->height (50);
3287 $map->alloc;
3288 $map->_load_objects ("/tmp/x.map", 1);
3289 my $t = Event::time - $t;
3290
3291 #next unless $t < 0.0013;#d#
3292 if ($t < $min) {
3293 $min = $t;
3294 }
3295 $avg = $avg * 0.99 + $t * 0.01;
3296 }
3297 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3298 exit 0;
3299 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3300 };
3301
2197 $RUNTIME += $TICK; 3302 $RUNTIME += $TICK;
2198 $NEXT_TICK += $TICK; 3303 $NEXT_TICK += $TICK;
2199 3304
3305 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3306 $NEXT_RUNTIME_WRITE = $NOW + 10;
3307 Coro::async_pool {
3308 write_runtime
3309 or warn "ERROR: unable to write runtime file: $!";
3310 };
3311 }
3312
3313# my $AFTER = Event::time;
3314# warn $AFTER - $NOW;#d#
3315
3316 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3317 $sig->send;
3318 }
3319 while (my $sig = shift @WAIT_FOR_TICK) {
3320 $sig->send;
3321 }
3322
3323 $NOW = Event::time;
3324
2200 # if we are delayed by four ticks or more, skip them all 3325 # if we are delayed by four ticks or more, skip them all
2201 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3326 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2202 3327
2203 $TICK_WATCHER->at ($NEXT_TICK); 3328 $TICK_WATCHER->at ($NEXT_TICK);
2204 $TICK_WATCHER->start; 3329 $TICK_WATCHER->start;
3330
3331 $LOAD = ($NOW - $tick_start) / $TICK;
3332 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3333
3334 _post_tick;
3335
3336
2205 }, 3337 },
2206); 3338);
2207 3339
3340{
2208IO::AIO::max_poll_time $TICK * 0.2; 3341 BDB::max_poll_time $TICK * 0.1;
2209 3342 $BDB_POLL_WATCHER = Event->io (
2210Event->io ( 3343 reentrant => 0,
2211 fd => IO::AIO::poll_fileno, 3344 fd => BDB::poll_fileno,
2212 poll => 'r', 3345 poll => 'r',
2213 prio => 5, 3346 prio => 0,
2214 data => WF_AUTOCANCEL,
2215 cb => \&IO::AIO::poll_cb,
2216);
2217
2218Event->timer (
2219 data => WF_AUTOCANCEL, 3347 data => WF_AUTOCANCEL,
2220 after => 0, 3348 cb => \&BDB::poll_cb,
2221 interval => 10, 3349 );
2222 cb => sub { 3350 BDB::min_parallel 8;
2223 (Coro::unblock_sub { 3351
2224 write_runtime 3352 BDB::set_sync_prepare {
2225 or warn "ERROR: unable to write runtime file: $!"; 3353 my $status;
3354 my $current = $Coro::current;
3355 (
3356 sub {
3357 $status = $!;
3358 $current->ready; undef $current;
3359 },
3360 sub {
3361 Coro::schedule while defined $current;
3362 $! = $status;
3363 },
3364 )
3365 };
3366
3367 unless ($DB_ENV) {
3368 $DB_ENV = BDB::db_env_create;
3369
3370 cf::sync_job {
3371 eval {
3372 BDB::db_env_open
3373 $DB_ENV,
3374 $BDBDIR,
3375 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3376 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3377 0666;
3378
3379 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3380
3381 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3382 $DB_ENV->set_lk_detect;
3383 };
3384
3385 cf::cleanup "db_env_open(db): $@" if $@;
2226 })->(); 3386 };
2227 }, 3387 }
2228); 3388}
3389
3390{
3391 IO::AIO::min_parallel 8;
3392
3393 undef $Coro::AIO::WATCHER;
3394 IO::AIO::max_poll_time $TICK * 0.1;
3395 $AIO_POLL_WATCHER = Event->io (
3396 reentrant => 0,
3397 data => WF_AUTOCANCEL,
3398 fd => IO::AIO::poll_fileno,
3399 poll => 'r',
3400 prio => 6,
3401 cb => \&IO::AIO::poll_cb,
3402 );
3403}
3404
3405my $_log_backtrace;
3406
3407sub _log_backtrace {
3408 my ($msg, @addr) = @_;
3409
3410 $msg =~ s/\n//;
3411
3412 # limit the # of concurrent backtraces
3413 if ($_log_backtrace < 2) {
3414 ++$_log_backtrace;
3415 async {
3416 my @bt = fork_call {
3417 @addr = map { sprintf "%x", $_ } @addr;
3418 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3419 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3420 or die "addr2line: $!";
3421
3422 my @funcs;
3423 my @res = <$fh>;
3424 chomp for @res;
3425 while (@res) {
3426 my ($func, $line) = splice @res, 0, 2, ();
3427 push @funcs, "[$func] $line";
3428 }
3429
3430 @funcs
3431 };
3432
3433 LOG llevInfo, "[ABT] $msg\n";
3434 LOG llevInfo, "[ABT] $_\n" for @bt;
3435 --$_log_backtrace;
3436 };
3437 } else {
3438 LOG llevInfo, "[ABT] $msg\n";
3439 LOG llevInfo, "[ABT] [suppressed]\n";
3440 }
3441}
3442
3443# load additional modules
3444use cf::pod;
2229 3445
2230END { cf::emergency_save } 3446END { cf::emergency_save }
2231 3447
22321 34481
2233 3449

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines