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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.323 by root, Sat Jul 28 12:02:58 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 261
181 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
182} 263sub from_json ($) { $json_coder->decode ($_[0]) }
183 264
184=item cf::lock_wait $string 265=item cf::lock_wait $string
185 266
186Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
187 268
193returned. 274returned.
194 275
195Lock 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
196uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
197 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
198=cut 283=cut
199 284
200our %LOCK; 285our %LOCK;
201 286
202sub lock_wait($) { 287sub lock_wait($) {
221 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
223 } 308 }
224} 309}
225 310
226=item cf::async { BLOCK } 311sub lock_active($) {
227
228Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
229error instead of exiting the server in case of a problem.
230
231=cut
232
233sub async(&) {
234 my ($cb) = @_; 312 my ($key) = @_;
235 313
236 Coro::async { 314 ! ! $LOCK{$key}
237 eval { $cb->() };
238 warn $@ if $@;
239 }
240} 315}
241 316
242sub freeze_mainloop { 317sub freeze_mainloop {
243 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
244 319
245 my $guard = Coro::guard { $TICK_WATCHER->start }; 320 my $guard = Coro::guard {
321 $TICK_WATCHER->start;
322 };
246 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
247 $guard 324 $guard
248} 325}
249 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
250=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
251 394
252The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
254reentrant. 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.
255 399
256If 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
257the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
258server 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
259fast or be very important. 403fast or be very important.
262 406
263sub sync_job(&) { 407sub sync_job(&) {
264 my ($job) = @_; 408 my ($job) = @_;
265 409
266 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
267 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
269 415
270 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 417 # (but this is cancel-safe)
272 my $freeze_guard = freeze_mainloop; 418 my $freeze_guard = freeze_mainloop;
273 419
274 my $busy = 1; 420 my $busy = 1;
275 my @res; 421 my @res;
276 422
277 (Coro::async { 423 (async {
278 @res = eval { $job->() }; 424 @res = eval { $job->() };
279 warn $@ if $@; 425 warn $@ if $@;
280 undef $busy; 426 undef $busy;
281 })->prio (Coro::PRIO_MAX); 427 })->prio (Coro::PRIO_MAX);
282 428
283 while ($busy) { 429 while ($busy) {
284 Coro::cede_notself; 430 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 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
287 439
288 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
289 } else { 441 } else {
290 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
291 443
292 $job->() 444 $job->()
293 } 445 }
294} 446}
295 447
296=item $coro = cf::coro { BLOCK } 448=item $coro = cf::async_ext { BLOCK }
297 449
298Creates and returns a new coro. This coro is automcatially being canceled 450Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 451extension calling this is being unloaded.
300 452
301=cut 453=cut
302 454
303sub coro(&) { 455sub async_ext(&) {
304 my $cb = shift; 456 my $cb = shift;
305 457
306 my $coro = &cf::async ($cb); 458 my $coro = &Coro::async ($cb);
307 459
308 $coro->on_destroy (sub { 460 $coro->on_destroy (sub {
309 delete $EXT_CORO{$coro+0}; 461 delete $EXT_CORO{$coro+0};
310 }); 462 });
311 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
312 464
313 $coro 465 $coro
314} 466}
315 467
316sub write_runtime { 468=item fork_call { }, $args
317 my $runtime = cf::localdir . "/runtime";
318 469
319 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
320 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.
321 474
322 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
323 (aio_write $fh, 0, (length $value), $value, 0) <= 0
324 and return;
325 476
326 aio_fsync $fh 477sub _store_scalar {
327 and return; 478 open my $fh, ">", \my $buf
328 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
329 close $fh 481 close $fh;
330 or return;
331 482
332 aio_rename "$runtime~", $runtime 483 $buf
333 and return; 484}
334 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;
335 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 });
336} 655}
337 656
338=back 657=back
339 658
340=cut 659=cut
341
342#############################################################################
343
344package cf::path;
345
346sub new {
347 my ($class, $path, $base) = @_;
348
349 $path = $path->as_string if ref $path;
350
351 my $self = bless { }, $class;
352
353 # {... are special paths that are not touched
354 # ?xxx/... are special absolute paths
355 # ?random/... random maps
356 # /! non-realised random map exit
357 # /... normal maps
358 # ~/... per-player maps without a specific player (DO NOT USE)
359 # ~user/... per-player map of a specific user
360
361 if ($path =~ /^{/) {
362 # fine as it is
363 } elsif ($path =~ s{^\?random/}{}) {
364 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365 $self->{random} = cf::from_json $data;
366 } else {
367 if ($path =~ s{^~([^/]+)?}{}) {
368 $self->{user_rel} = 1;
369
370 if (defined $1) {
371 $self->{user} = $1;
372 } elsif ($base =~ m{^~([^/]+)/}) {
373 $self->{user} = $1;
374 } else {
375 warn "cannot resolve user-relative path without user <$path,$base>\n";
376 }
377 } elsif ($path =~ /^\//) {
378 # already absolute
379 } else {
380 $base =~ s{[^/]+/?$}{};
381 return $class->new ("$base/$path");
382 }
383
384 for ($path) {
385 redo if s{/\.?/}{/};
386 redo if s{/[^/]+/\.\./}{/};
387 }
388 }
389
390 $self->{path} = $path;
391
392 $self
393}
394
395# the name / primary key / in-game path
396sub as_string {
397 my ($self) = @_;
398
399 $self->{user_rel} ? "~$self->{user}$self->{path}"
400 : $self->{random} ? "?random/$self->{path}"
401 : $self->{path}
402}
403
404# the displayed name, this is a one way mapping
405sub visible_name {
406 my ($self) = @_;
407
408# if (my $rmp = $self->{random}) {
409# # todo: be more intelligent about this
410# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411# } else {
412 $self->as_string
413# }
414}
415
416# escape the /'s in the path
417sub _escaped_path {
418 # ∕ is U+2215
419 (my $path = $_[0]{path}) =~ s/\//∕/g;
420 $path
421}
422
423# the original (read-only) location
424sub load_path {
425 my ($self) = @_;
426
427 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428}
429
430# the temporary/swap location
431sub save_path {
432 my ($self) = @_;
433
434 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437}
438
439# the unique path, might be eq to save_path
440sub uniq_path {
441 my ($self) = @_;
442
443 $self->{user_rel} || $self->{random}
444 ? undef
445 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446}
447
448# return random map parameters, or undef
449sub random_map_params {
450 my ($self) = @_;
451
452 $self->{random}
453}
454
455# this is somewhat ugly, but style maps do need special treatment
456sub is_style_map {
457 $_[0]{path} =~ m{^/styles/}
458}
459
460package cf;
461 660
462############################################################################# 661#############################################################################
463 662
464=head2 ATTACHABLE OBJECTS 663=head2 ATTACHABLE OBJECTS
465 664
467attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
468to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
469 668
470In 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>
471C<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
472crossfire+). 671Crossfire TRT).
473 672
474=over 4 673=over 4
475 674
476=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
477 676
591our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
592our @CB_MAP = (); 791our @CB_MAP = ();
593 792
594my %attachment; 793my %attachment;
595 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
596sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
597 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
598 803
599 use sort 'stable'; 804 use sort 'stable';
600 805
634 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
635 840
636 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
637 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
638 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
639 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
640 845
641 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
642 my $pkg = shift @arg; 847 my $pkg = shift @arg;
643 848
644 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
673 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
674 } 879 }
675 880
676 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
677 } else { 882 } else {
678 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
679 } 884 }
680 885
681 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
682} 887}
683 888
685 if (ref $_[0]) { 890 if (ref $_[0]) {
686 _object_attach @_; 891 _object_attach @_;
687 } else { 892 } else {
688 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
689 } 894 }
895 _recalc_want;
690}; 896};
691 897
692# all those should be optimised 898# all those should be optimised
693sub cf::attachable::detach { 899sub cf::attachable::detach {
694 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
697 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
698 reattach ($obj); 904 reattach ($obj);
699 } else { 905 } else {
700 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
701 } 907 }
908 _recalc_want;
702}; 909};
703 910
704sub cf::attachable::attached { 911sub cf::attachable::attached {
705 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
706 913
721 "; 928 ";
722 die if $@; 929 die if $@;
723} 930}
724 931
725our $override; 932our $override;
726our @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?
727 934
728sub override { 935sub override {
729 $override = 1; 936 $override = 1;
730 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
731} 938}
732 939
733sub do_invoke { 940sub do_invoke {
734 my $event = shift; 941 my $event = shift;
735 my $callbacks = shift; 942 my $callbacks = shift;
736 943
737 @invoke_results = (); 944 @INVOKE_RESULTS = ();
738 945
739 local $override; 946 local $override;
740 947
741 for (@$callbacks) { 948 for (@$callbacks) {
742 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
759 966
760Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
761 968
762This 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
763removed 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
764results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
765 972
766=back 973=back
767 974
768=cut 975=cut
769 976
770############################################################################# 977#############################################################################
771# 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}
772 990
773sub reattach { 991sub reattach {
774 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
775 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
776 996
777 my $registry = $obj->registry; 997 my $registry = $obj->registry;
778 998
779 @$registry = (); 999 @$registry = ();
780 1000
827 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
828 1048
829 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
831 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
833 close $fh; 1053 close $fh;
834 1054
835 if (@$objs) { 1055 if (@$objs) {
836 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) {
837 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
838 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
839 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
840 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
841 close $fh; 1061 close $fh;
842 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
843 } 1063 }
844 } else { 1064 } else {
845 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
877 or return; 1097 or return;
878 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
879 } 1099 }
880 1100
881 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
882 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
883 return ($data, $av); 1103 return ($data, $av);
884} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
885 1111
886############################################################################# 1112#############################################################################
887# command handling &c 1113# command handling &c
888 1114
889=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
902 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
903} 1129}
904 1130
905=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
906 1132
907Register 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.
908 1138
909If 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
910called. 1140called.
911 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
912=cut 1153=cut
913 1154
914sub register_extcmd { 1155sub register_extcmd {
915 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
916 1157
917 my $caller = caller;
918 #warn "registering extcmd '$name' to '$caller'";
919
920 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
921} 1165}
922 1166
923cf::player->attach ( 1167cf::player->attach (
924 on_command => sub { 1168 on_command => sub {
925 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
934 cf::override; 1178 cf::override;
935 }, 1179 },
936 on_extcmd => sub { 1180 on_extcmd => sub {
937 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
938 1182
939 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
940 1184
941 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
942 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
943 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
944 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
945 } 1195 if $reply;
946 } 1196 }
947 } else { 1197 } else {
948 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
949 } 1199 }
950 1200
951 cf::override; 1201 cf::override;
952 }, 1202 },
953); 1203);
954 1204
955sub register {
956 my ($base, $pkg) = @_;
957
958 #TODO
959}
960
961sub 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($) {
962 my ($path) = @_; 1573 my ($path) = @_;
963 1574
964 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1575 my ($match, $specificity);
965 my $base = $1;
966 my $pkg = $1;
967 $pkg =~ s/[^[:word:]]/_/g;
968 $pkg = "ext::$pkg";
969 1576
970 warn "loading '$path' into '$pkg'\n"; 1577 for my $region (list) {
971 1578 if ($region->{match} && $path =~ $region->{match}) {
972 open my $fh, "<:utf8", $path 1579 ($match, $specificity) = ($region, $region->specificity)
973 or die "$path: $!"; 1580 if $region->specificity > $specificity;
974 1581 }
975 my $source =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . (do { local $/; <$fh> })
979 . "\n};\n1";
980
981 eval $source
982 or die $@ ? "$path: $@\n"
983 : "extension disabled.\n";
984
985 push @exts, $pkg;
986 $ext_pkg{$base} = $pkg;
987
988# no strict 'refs';
989# @{"$pkg\::ISA"} = ext::;
990
991 register $base, $pkg;
992}
993
994sub unload_extension {
995 my ($pkg) = @_;
996
997 warn "removing extension $pkg\n";
998
999 # remove hooks
1000 #TODO
1001# for my $idx (0 .. $#PLUGIN_EVENT) {
1002# delete $hook[$idx]{$pkg};
1003# } 1582 }
1004 1583
1005 # remove commands 1584 $match
1006 for my $name (keys %COMMAND) {
1007 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009 if (@cb) {
1010 $COMMAND{$name} = \@cb;
1011 } else {
1012 delete $COMMAND{$name};
1013 }
1014 }
1015
1016 # remove extcmds
1017 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018 delete $EXTCMD{$name};
1019 }
1020
1021 if (my $cb = $pkg->can ("unload")) {
1022 eval {
1023 $cb->($pkg);
1024 1
1025 } or warn "$pkg unloaded, but with errors: $@";
1026 }
1027
1028 Symbol::delete_package $pkg;
1029}
1030
1031sub load_extensions {
1032 for my $ext (<$LIBDIR/*.ext>) {
1033 next unless -r $ext;
1034 eval {
1035 load_extension $ext;
1036 1
1037 } or warn "$ext not loaded: $@";
1038 }
1039}
1040
1041#############################################################################
1042# load/save/clean perl data associated with a map
1043
1044*cf::mapsupport::on_clean = sub {
1045 my ($map) = @_;
1046
1047 my $path = $map->tmpname;
1048 defined $path or return;
1049
1050 unlink "$path.pst";
1051};
1052
1053cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055#############################################################################
1056# load/save perl data associated with player->ob objects
1057
1058sub all_objects(@) {
1059 @_, map all_objects ($_->inv), @_
1060}
1061
1062# TODO: compatibility cruft, remove when no longer needed
1063cf::player->attach (
1064 on_load => sub {
1065 my ($pl, $path) = @_;
1066
1067 for my $o (all_objects $pl->ob) {
1068 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1069 $o->set_ob_key_value ("_perl_data");
1070
1071 %$o = %{ Storable::thaw pack "H*", $value };
1072 }
1073 }
1074 },
1075);
1076
1077#############################################################################
1078
1079=head2 CORE EXTENSIONS
1080
1081Functions and methods that extend core crossfire objects.
1082
1083=head3 cf::player
1084
1085=over 4
1086
1087=item cf::player::exists $login
1088
1089Returns true when the given account exists.
1090
1091=cut
1092
1093sub cf::player::exists($) {
1094 cf::player::find $_[0]
1095 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1096}
1097
1098=item $player->ext_reply ($msgid, $msgtype, %msg)
1099
1100Sends an ext reply to the player.
1101
1102=cut
1103
1104sub cf::player::ext_reply($$$%) {
1105 my ($self, $id, %msg) = @_;
1106
1107 $msg{msgid} = $id;
1108
1109 $self->send ("ext " . to_json \%msg);
1110} 1585}
1111 1586
1112=back 1587=back
1113
1114 1588
1115=head3 cf::map 1589=head3 cf::map
1116 1590
1117=over 4 1591=over 4
1118 1592
1121package cf::map; 1595package cf::map;
1122 1596
1123use Fcntl; 1597use Fcntl;
1124use Coro::AIO; 1598use Coro::AIO;
1125 1599
1600use overload
1601 '""' => \&as_string,
1602 fallback => 1;
1603
1126our $MAX_RESET = 3600; 1604our $MAX_RESET = 3600;
1127our $DEFAULT_RESET = 3000; 1605our $DEFAULT_RESET = 3000;
1128 1606
1129sub generate_random_map { 1607sub generate_random_map {
1130 my ($path, $rmp) = @_; 1608 my ($self, $rmp) = @_;
1131
1132 # mit "rum" bekleckern, nicht 1609 # mit "rum" bekleckern, nicht
1133 cf::map::_create_random_map 1610 $self->_create_random_map (
1134 $path,
1135 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1611 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1612 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1613 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{exit_on_final_map}, 1614 $rmp->{exit_on_final_map},
1139 $rmp->{xsize}, $rmp->{ysize}, 1615 $rmp->{xsize}, $rmp->{ysize},
1140 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1616 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1617 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1618 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143 $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},
1144 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1620 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145 (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"
1146} 1750}
1147 1751
1148# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1149# all maps in C++... 1753# all maps in C++...
1150sub change_all_map_light { 1754sub change_all_map_light {
1152 1756
1153 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1154 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1155} 1759}
1156 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
1157sub try_load_header($) { 1777sub load_header_from($) {
1158 my ($path) = @_; 1778 my ($self, $path) = @_;
1159 1779
1160 utf8::encode $path; 1780 utf8::encode $path;
1161 aio_open $path, O_RDONLY, 0 1781 #aio_open $path, O_RDONLY, 0
1782 # or return;
1783
1784 $self->_load_header ($path)
1162 or return; 1785 or return;
1163 1786
1164 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
1165 or return; 1830 or return;
1831 $self->prepare_orig;
1832 }
1166 1833
1167 # for better error messages only, will be overwritten 1834 $self->{deny_reset} = 1
1168 $map->path ($path); 1835 if $self->no_reset;
1169 1836
1170 $map->load_header ($path) 1837 $self->default_region (cf::region::find_by_path $self->{path})
1171 or return; 1838 unless $self->default_region;
1172 1839
1173 $map->{load_path} = $path; 1840 1
1174
1175 $map
1176} 1841}
1177 1842
1178sub find; 1843sub find;
1179sub find { 1844sub find {
1180 my ($path, $origin) = @_; 1845 my ($path, $origin) = @_;
1181 1846
1182 #warn "find<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 1847 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 1848
1187 cf::lock_wait "map_find:$key"; 1849 cf::lock_wait "map_find:$path";
1188 1850
1189 $cf::MAP{$key} || do { 1851 $cf::MAP{$path} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 1852 my $guard = cf::lock_acquire "map_find:$path";
1191 1853 my $map = new_from_path cf::map $path
1192 # do it the slow way
1193 my $map = try_load_header $path->save_path;
1194
1195 Coro::cede;
1196
1197 if ($map) {
1198 $map->last_access ((delete $map->{last_access})
1199 || $cf::RUNTIME); #d#
1200 # safety
1201 $map->{instantiate_time} = $cf::RUNTIME
1202 if $map->{instantiate_time} > $cf::RUNTIME;
1203 } else {
1204 if (my $rmp = $path->random_map_params) {
1205 $map = generate_random_map $key, $rmp;
1206 } else {
1207 $map = try_load_header $path->load_path;
1208 }
1209
1210 $map or return; 1854 or return;
1211 1855
1212 $map->{load_original} = 1;
1213 $map->{instantiate_time} = $cf::RUNTIME;
1214 $map->last_access ($cf::RUNTIME);
1215 $map->instantiate;
1216
1217 # per-player maps become, after loading, normal maps
1218 $map->per_player (0) if $path->{user_rel};
1219 }
1220
1221 $map->path ($key);
1222 $map->{path} = $path;
1223 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1224 1857
1225 Coro::cede; 1858 $map->load_header
1859 or return;
1226 1860
1227 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;
1228 $map->reset; 1864 $map->reset;
1229 undef $guard; 1865 undef $guard;
1230 $map = find $path 1866 return find $path;
1231 or return;
1232 } 1867 }
1233 1868
1234 $cf::MAP{$key} = $map 1869 $cf::MAP{$path} = $map
1235 } 1870 }
1236} 1871}
1872
1873sub pre_load { }
1874sub post_load { }
1237 1875
1238sub load { 1876sub load {
1239 my ($self) = @_; 1877 my ($self) = @_;
1240 1878
1879 local $self->{deny_reset} = 1; # loading can take a long time
1880
1241 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1242 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1884 my $guard = cf::lock_acquire "map_load:$path";
1243 1885
1244 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1245 1887
1246 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1247 1889
1248 $self->alloc; 1890 $self->alloc;
1891
1892 $self->pre_load;
1893 Coro::cede;
1894
1249 $self->load_objects ($self->{load_path}, 1) 1895 $self->_load_objects ($self->{load_path}, 1)
1250 or return; 1896 or return;
1251 1897
1252 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1253 if delete $self->{load_original}; 1899 if delete $self->{load_original};
1254 1900
1255 if (my $uniq = $path->uniq_path) { 1901 if (my $uniq = $self->uniq_path) {
1256 utf8::encode $uniq; 1902 utf8::encode $uniq;
1257 if (aio_open $uniq, O_RDONLY, 0) { 1903 if (aio_open $uniq, O_RDONLY, 0) {
1258 $self->clear_unique_items; 1904 $self->clear_unique_items;
1259 $self->load_objects ($uniq, 0); 1905 $self->_load_objects ($uniq, 0);
1260 } 1906 }
1261 } 1907 }
1262 1908
1263 Coro::cede; 1909 Coro::cede;
1264
1265 # now do the right thing for maps 1910 # now do the right thing for maps
1266 $self->link_multipart_objects; 1911 $self->link_multipart_objects;
1267
1268 if ($self->{path}->is_style_map) {
1269 $self->{deny_save} = 1;
1270 $self->{deny_reset} = 1;
1271 } else {
1272 $self->fix_auto_apply;
1273 $self->decay_objects;
1274 $self->update_buttons;
1275 $self->set_darkness_map;
1276 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1277 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;
1278 $self->activate; 1923 $self->activate;
1279 } 1924 }
1280 1925
1281 Coro::cede;
1282
1283 $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 }
1284} 1966}
1285 1967
1286sub find_sync { 1968sub find_sync {
1287 my ($path, $origin) = @_; 1969 my ($path, $origin) = @_;
1288 1970
1289 cf::sync_job { cf::map::find $path, $origin } 1971 cf::sync_job { find $path, $origin }
1290} 1972}
1291 1973
1292sub do_load_sync { 1974sub do_load_sync {
1293 my ($map) = @_; 1975 my ($map) = @_;
1294 1976
1295 cf::sync_job { $map->load }; 1977 cf::sync_job { $map->load };
1296} 1978}
1297 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
1298sub save { 2010sub save {
1299 my ($self) = @_; 2011 my ($self) = @_;
1300 2012
1301 my $lock = cf::lock_acquire "map_data:" . $self->path; 2013 my $lock = cf::lock_acquire "map_data:" . $self->path;
1302 2014
1303 $self->{last_save} = $cf::RUNTIME; 2015 $self->{last_save} = $cf::RUNTIME;
1304 2016
1305 return unless $self->dirty; 2017 return unless $self->dirty;
1306 2018
1307 my $save = $self->{path}->save_path; utf8::encode $save; 2019 my $save = $self->save_path; utf8::encode $save;
1308 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2020 my $uniq = $self->uniq_path; utf8::encode $uniq;
1309 2021
1310 $self->{load_path} = $save; 2022 $self->{load_path} = $save;
1311 2023
1312 return if $self->{deny_save}; 2024 return if $self->{deny_save};
1313 2025
1314 local $self->{last_access} = $self->last_access;#d# 2026 local $self->{last_access} = $self->last_access;#d#
1315 2027
2028 cf::async {
2029 $_->contr->save for $self->players;
2030 };
2031
1316 if ($uniq) { 2032 if ($uniq) {
1317 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2033 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318 $self->save_objects ($uniq, cf::IO_UNIQUES); 2034 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1319 } else { 2035 } else {
1320 $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);
1321 } 2037 }
1322} 2038}
1323 2039
1324sub swap_out { 2040sub swap_out {
1325 my ($self) = @_; 2041 my ($self) = @_;
1339 2055
1340sub reset_at { 2056sub reset_at {
1341 my ($self) = @_; 2057 my ($self) = @_;
1342 2058
1343 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1344 return 1e99 if $self->{path}{user_rel};
1345 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1346 2061
1347 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1348 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;
1349 2064
1354 my ($self) = @_; 2069 my ($self) = @_;
1355 2070
1356 $self->reset_at <= $cf::RUNTIME 2071 $self->reset_at <= $cf::RUNTIME
1357} 2072}
1358 2073
1359sub unlink_save {
1360 my ($self) = @_;
1361
1362 utf8::encode (my $save = $self->{path}->save_path);
1363 aioreq_pri 3; IO::AIO::aio_unlink $save;
1364 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1365}
1366
1367sub rename {
1368 my ($self, $new_path) = @_;
1369
1370 $self->unlink_save;
1371
1372 delete $cf::MAP{$self->path};
1373 $self->{path} = new cf::path $new_path;
1374 $self->path ($self->{path}->as_string);
1375 $cf::MAP{$self->path} = $self;
1376
1377 $self->save;
1378}
1379
1380sub reset { 2074sub reset {
1381 my ($self) = @_; 2075 my ($self) = @_;
1382 2076
1383 my $lock = cf::lock_acquire "map_data:" . $self->path; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1384 2078
1385 return if $self->players; 2079 return if $self->players;
1386 return if $self->{path}{user_rel};#d#
1387 2080
1388 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 }
1389 2092
1390 delete $cf::MAP{$self->path}; 2093 delete $cf::MAP{$self->path};
2094
2095 $self->clear;
1391 2096
1392 $_->clear_links_to ($self) for values %cf::MAP; 2097 $_->clear_links_to ($self) for values %cf::MAP;
1393 2098
1394 $self->unlink_save; 2099 $self->unlink_save;
1395 $self->destroy; 2100 $self->destroy;
1398my $nuke_counter = "aaaa"; 2103my $nuke_counter = "aaaa";
1399 2104
1400sub nuke { 2105sub nuke {
1401 my ($self) = @_; 2106 my ($self) = @_;
1402 2107
2108 delete $cf::MAP{$self->path};
2109
2110 $self->unlink_save;
2111
2112 bless $self, "cf::map";
2113 delete $self->{deny_reset};
1403 $self->{deny_save} = 1; 2114 $self->{deny_save} = 1;
1404 $self->reset_timeout (1); 2115 $self->reset_timeout (1);
1405 $self->rename ("{nuke}/" . ($nuke_counter++)); 2116 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2117
2118 $cf::MAP{$self->path} = $self;
2119
1406 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1407} 2121}
1408 2122
1409sub customise_for { 2123=item $maps = cf::map::tmp_maps
1410 my ($map, $ob) = @_;
1411 2124
1412 if ($map->per_player) { 2125Returns an arrayref with all map paths of currently instantiated and saved
1413 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
1414 } 2131 [
1415 2132 map {
1416 $map 2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
1417} 2139}
1418 2140
1419sub emergency_save { 2141=item $maps = cf::map::random_maps
1420 my $freeze_guard = cf::freeze_mainloop;
1421 2142
1422 warn "enter emergency map save\n"; 2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
1423 2145
1424 cf::sync_job { 2146=cut
1425 warn "begin emergency map save\n";
1426 $_->save for values %cf::MAP;
1427 };
1428 2147
1429 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 ]
1430} 2175}
1431 2176
1432package cf; 2177package cf;
1433 2178
1434=back 2179=back
1435 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
1436 2207
1437=head3 cf::object::player 2208=head3 cf::object::player
1438 2209
1439=over 4 2210=over 4
1440 2211
1454 2225
1455 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1456 2227
1457 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1458 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1459 } 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 {
1460 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1461 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1462 } 2242 }
1463} 2243}
1464 2244
1465=item $player_object->may ("access") 2245=item $player_object->may ("access")
1466 2246
1480 2260
1481=item $player_object->enter_link 2261=item $player_object->enter_link
1482 2262
1483Freezes 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}>).
1484 2264
1485The 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
1486I<MUST> call C<leave_link> as soon as possible, though. 2266I<MUST> call C<leave_link> as soon as possible, though.
1487 2267
2268Will never block.
2269
1488=item $player_object->leave_link ($map, $x, $y) 2270=item $player_object->leave_link ($map, $x, $y)
1489 2271
1490Moves 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
1491map 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
1492location 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
1493to the emergency map position. 2275fails, to the emergency map position.
1494 2276
1495Might block. 2277Might block.
1496 2278
1497=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}
1498 2290
1499sub cf::object::player::enter_link { 2291sub cf::object::player::enter_link {
1500 my ($self) = @_; 2292 my ($self) = @_;
1501 2293
1502 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1503 2295
1504 return if $self->map == $LINK_MAP; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1505 2297
1506 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1507 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1508 2300
1509 $self->enter_map ($LINK_MAP, 20, 20); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1510} 2302}
1511 2303
1512sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1513 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1514 2308
1515 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1516 2310
1517 unless ($map) { 2311 unless ($map) {
1518 # restore original map position 2312 # restore original map position
1532 # use -1 or undef as default coordinates, not 0, 0 2326 # use -1 or undef as default coordinates, not 0, 0
1533 ($x, $y) = ($map->enter_x, $map->enter_y) 2327 ($x, $y) = ($map->enter_x, $map->enter_y)
1534 if $x <=0 && $y <= 0; 2328 if $x <=0 && $y <= 0;
1535 2329
1536 $map->load; 2330 $map->load;
2331 $map->load_diag;
1537 2332
2333 return unless $self->contr->active;
1538 $self->activate_recursive; 2334 $self->activate_recursive;
2335
2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1539 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1540} 2338}
1541 2339
1542cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1543 on_logout => sub {
1544 my ($pl) = @_;
1545 2341
1546 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1547 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1548 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1549 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1550 }; 2346be called at the end of this process.
1551 }
1552 },
1553 on_login => sub {
1554 my ($pl) = @_;
1555 2347
1556 # try to abort aborted map switching on player login :)
1557 # should happen only on crashes
1558 if ($pl->ob->{_link_pos}) {
1559 $pl->ob->enter_link;
1560 cf::async {
1561 # we need this sleep as the login has a concurrent enter_exit running
1562 # and this sleep increases chances of the player not ending up in scorn
1563 Coro::Timer::sleep 1;
1564 $pl->ob->leave_link;
1565 };
1566 }
1567 },
1568);
1569
1570=item $player_object->goto ($path, $x, $y)
1571
1572=cut 2348=cut
2349
2350our $GOTOGEN;
1573 2351
1574sub cf::object::player::goto { 2352sub cf::object::player::goto {
1575 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;
1576 2357
1577 $self->enter_link; 2358 $self->enter_link;
1578 2359
1579 (cf::async { 2360 (async {
1580 $path = new cf::path $path; 2361 my $map = eval {
1581
1582 my $map = cf::map::find $path->as_string; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1583 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
1584 2366 $map = $check->($map) if $check && $map;
1585# warn "entering ", $map->path, " at ($x, $y)\n" 2367 } else {
1586# if $map;
1587
1588 $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 }
1589 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};
1590 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1591 })->prio (1); 2385 })->prio (1);
1592} 2386}
1593 2387
1594=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1595 2389
1597 2391
1598sub parse_random_map_params { 2392sub parse_random_map_params {
1599 my ($spec) = @_; 2393 my ($spec) = @_;
1600 2394
1601 my $rmp = { # defaults 2395 my $rmp = { # defaults
1602 xsize => 10, 2396 xsize => (cf::rndm 15, 40),
1603 ysize => 10, 2397 ysize => (cf::rndm 15, 40),
2398 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2399 #layout => string,
1604 }; 2400 };
1605 2401
1606 for (split /\n/, $spec) { 2402 for (split /\n/, $spec) {
1607 my ($k, $v) = split /\s+/, $_, 2; 2403 my ($k, $v) = split /\s+/, $_, 2;
1608 2404
1612 $rmp 2408 $rmp
1613} 2409}
1614 2410
1615sub prepare_random_map { 2411sub prepare_random_map {
1616 my ($exit) = @_; 2412 my ($exit) = @_;
2413
2414 my $guard = cf::lock_acquire "exit_prepare:$exit";
1617 2415
1618 # all this does is basically replace the /! path by 2416 # all this does is basically replace the /! path by
1619 # a new random map path (?random/...) with a seed 2417 # a new random map path (?random/...) with a seed
1620 # that depends on the exit object 2418 # that depends on the exit object
1621 2419
1622 my $rmp = parse_random_map_params $exit->msg; 2420 my $rmp = parse_random_map_params $exit->msg;
1623 2421
1624 if ($exit->map) { 2422 if ($exit->map) {
1625 $rmp->{region} = $exit->map->region_name; 2423 $rmp->{region} = $exit->region->name;
1626 $rmp->{origin_map} = $exit->map->path; 2424 $rmp->{origin_map} = $exit->map->path;
1627 $rmp->{origin_x} = $exit->x; 2425 $rmp->{origin_x} = $exit->x;
1628 $rmp->{origin_y} = $exit->y; 2426 $rmp->{origin_y} = $exit->y;
1629 } 2427 }
1630 2428
1631 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1632 2430
1633 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1634 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
2433 my $meta = "$RANDOMDIR/$md5.meta";
1635 2434
1636 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) {
1637 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;
1638 2439
1639 $exit->slaying ("?random/$md5"); 2440 $exit->slaying ("?random/$md5");
1640 $exit->msg (undef); 2441 $exit->msg (undef);
1641 } 2442 }
1642} 2443}
1644sub cf::object::player::enter_exit { 2445sub cf::object::player::enter_exit {
1645 my ($self, $exit) = @_; 2446 my ($self, $exit) = @_;
1646 2447
1647 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1648 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
1649 $self->enter_link; 2461 $self->enter_link;
1650 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
1651 (cf::async { 2467 (async {
1652 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1653 unless (eval { 2469 unless (eval {
1654 prepare_random_map $exit 2470 $self->goto ($slaying, $hp, $sp);
1655 if $exit->slaying eq "/!";
1656
1657 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1658 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1659 2471
1660 1; 2472 1;
1661 }) { 2473 }) {
1662 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1663 . "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. "
1664 . "Please report this to the dungeon master", 2476 . "Please report this to the dungeon master!",
1665 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1666 2478
1667 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1668 $self->leave_link; 2480 $self->leave_link;
1669 } 2481 }
1670 })->prio (1); 2482 })->prio (1);
1683 2495
1684sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1685 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1686 2498
1687 utf8::encode $text; 2499 utf8::encode $text;
1688 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1689} 2501}
1690 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_CLIENT_MASK; # 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 # default colour, mask it out
2533 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2534 if $color & cf::NDI_DEF;
2535
2536 $self->send_packet ("msg " . $self->{json_coder}->encode (
2537 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2538 } else {
2539 if ($color >= 0) {
2540 # replace some tags by gcfclient-compatible ones
2541 for ($msg) {
2542 1 while
2543 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2544 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2545 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2546 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2547 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2548 }
2549
2550 $color &= cf::NDI_COLOR_MASK;
2551
2552 if (0 && $msg =~ /\[/) {
2553 $self->send_packet ("drawextinfo $color 4 0 $msg")
2554 } else {
2555 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2556 $self->send_packet ("drawinfo $color $msg")
2557 }
2558 }
2559 }
2560}
2561
2562=item $client->ext_msg ($type, @msg)
2563
2564Sends an ext event to the client.
2565
2566=cut
2567
2568sub cf::client::ext_msg($$@) {
2569 my ($self, $type, @msg) = @_;
2570
2571 my $extcmd = $self->extcmd;
2572
2573 if ($extcmd == 2) {
2574 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2575 } elsif ($extcmd == 1) { # TODO: remove
2576 push @msg, msgtype => "event_$type";
2577 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2578 }
2579}
1691 2580
1692=item $success = $client->query ($flags, "text", \&cb) 2581=item $success = $client->query ($flags, "text", \&cb)
1693 2582
1694Queues a query to the client, calling the given callback with 2583Queues a query to the client, calling the given callback with
1695the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2584the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1696C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2585C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1697 2586
1698Queries can fail, so check the return code. Or don't, as queries will become 2587Queries can fail, so check the return code. Or don't, as queries will
1699reliable at some point in the future. 2588become reliable at some point in the future.
1700 2589
1701=cut 2590=cut
1702 2591
1703sub cf::client::query { 2592sub cf::client::query {
1704 my ($self, $flags, $text, $cb) = @_; 2593 my ($self, $flags, $text, $cb) = @_;
1712 utf8::encode $text; 2601 utf8::encode $text;
1713 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2602 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1714 2603
1715 $self->send_packet ($self->{query_queue}[0][0]) 2604 $self->send_packet ($self->{query_queue}[0][0])
1716 if @{ $self->{query_queue} } == 1; 2605 if @{ $self->{query_queue} } == 1;
2606
2607 1
1717} 2608}
1718 2609
1719cf::client->attach ( 2610cf::client->attach (
2611 on_connect => sub {
2612 my ($ns) = @_;
2613
2614 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2615 },
1720 on_reply => sub { 2616 on_reply => sub {
1721 my ($ns, $msg) = @_; 2617 my ($ns, $msg) = @_;
1722 2618
1723 # this weird shuffling is so that direct followup queries 2619 # this weird shuffling is so that direct followup queries
1724 # get handled first 2620 # get handled first
1725 my $queue = delete $ns->{query_queue} 2621 my $queue = delete $ns->{query_queue}
1726 or return; # be conservative, not sure how that can happen, but we saw a crash here 2622 or return; # be conservative, not sure how that can happen, but we saw a crash here
1727 2623
1728 (shift @$queue)->[1]->($msg); 2624 (shift @$queue)->[1]->($msg);
2625 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1729 2626
1730 push @{ $ns->{query_queue} }, @$queue; 2627 push @{ $ns->{query_queue} }, @$queue;
1731 2628
1732 if (@{ $ns->{query_queue} } == @$queue) { 2629 if (@{ $ns->{query_queue} } == @$queue) {
1733 if (@$queue) { 2630 if (@$queue) {
1735 } else { 2632 } else {
1736 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2633 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1737 } 2634 }
1738 } 2635 }
1739 }, 2636 },
2637 on_exticmd => sub {
2638 my ($ns, $buf) = @_;
2639
2640 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2641
2642 if (ref $msg) {
2643 my ($type, $reply, @payload) =
2644 "ARRAY" eq ref $msg
2645 ? @$msg
2646 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2647
2648 if (my $cb = $EXTICMD{$type}) {
2649 my @reply = $cb->($ns, @payload);
2650
2651 $ns->ext_reply ($reply, @reply)
2652 if $reply;
2653 }
2654 } else {
2655 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2656 }
2657
2658 cf::override;
2659 },
1740); 2660);
1741 2661
1742=item $client->coro (\&cb) 2662=item $client->async (\&cb)
1743 2663
1744Create a new coroutine, running the specified callback. The coroutine will 2664Create a new coroutine, running the specified callback. The coroutine will
1745be automatically cancelled when the client gets destroyed (e.g. on logout, 2665be automatically cancelled when the client gets destroyed (e.g. on logout,
1746or loss of connection). 2666or loss of connection).
1747 2667
1748=cut 2668=cut
1749 2669
1750sub cf::client::coro { 2670sub cf::client::async {
1751 my ($self, $cb) = @_; 2671 my ($self, $cb) = @_;
1752 2672
1753 my $coro = &cf::async ($cb); 2673 my $coro = &Coro::async ($cb);
1754 2674
1755 $coro->on_destroy (sub { 2675 $coro->on_destroy (sub {
1756 delete $self->{_coro}{$coro+0}; 2676 delete $self->{_coro}{$coro+0};
1757 }); 2677 });
1758 2678
1791 2711
1792# here we export the classes and methods available to script code 2712# here we export the classes and methods available to script code
1793 2713
1794=pod 2714=pod
1795 2715
1796The following fucntions and emthods are available within a safe environment: 2716The following functions and methods are available within a safe environment:
1797 2717
1798 cf::object contr pay_amount pay_player map 2718 cf::object
2719 contr pay_amount pay_player map x y force_find force_add
2720 insert remove
2721
1799 cf::object::player player 2722 cf::object::player
1800 cf::player peaceful 2723 player
1801 cf::map trigger 2724
2725 cf::player
2726 peaceful
2727
2728 cf::map
2729 trigger
1802 2730
1803=cut 2731=cut
1804 2732
1805for ( 2733for (
1806 ["cf::object" => qw(contr pay_amount pay_player map)], 2734 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2735 insert remove)],
1807 ["cf::object::player" => qw(player)], 2736 ["cf::object::player" => qw(player)],
1808 ["cf::player" => qw(peaceful)], 2737 ["cf::player" => qw(peaceful)],
1809 ["cf::map" => qw(trigger)], 2738 ["cf::map" => qw(trigger)],
1810) { 2739) {
1811 no strict 'refs'; 2740 no strict 'refs';
1882=back 2811=back
1883 2812
1884=cut 2813=cut
1885 2814
1886############################################################################# 2815#############################################################################
2816# the server's init and main functions
1887 2817
1888=head2 EXTENSION DATABASE SUPPORT 2818sub load_facedata($) {
2819 my ($path) = @_;
1889 2820
1890Crossfire maintains a very simple database for extension use. It can 2821 warn "loading facedata from $path\n";
1891currently store anything that can be serialised using Storable, which
1892excludes objects.
1893 2822
1894The parameter C<$family> should best start with the name of the extension 2823 my $facedata;
1895using it, it should be unique. 2824 0 < aio_load $path, $facedata
2825 or die "$path: $!";
1896 2826
1897=over 4 2827 $facedata = Coro::Storable::thaw $facedata;
1898 2828
1899=item $hashref = cf::db_get $family 2829 $facedata->{version} == 2
2830 or cf::cleanup "$path: version mismatch, cannot proceed.";
1900 2831
1901Return a hashref for use by the extension C<$family>, which can be
1902modified. After modifications, you have to call C<cf::db_dirty> or
1903C<cf::db_sync>.
1904
1905=item $value = cf::db_get $family => $key
1906
1907Returns a single value from the database
1908
1909=item cf::db_put $family => $hashref
1910
1911Stores the given family hashref into the database. Updates are delayed, if
1912you want the data to be synced to disk immediately, use C<cf::db_sync>.
1913
1914=item cf::db_put $family => $key => $value
1915
1916Stores the given C<$value> in the family hash. Updates are delayed, if you
1917want the data to be synced to disk immediately, use C<cf::db_sync>.
1918
1919=item cf::db_dirty
1920
1921Marks the database as dirty, to be updated at a later time.
1922
1923=item cf::db_sync
1924
1925Immediately write the database to disk I<if it is dirty>.
1926
1927=cut
1928
1929our $DB;
1930
1931{
1932 my $path = cf::localdir . "/database.pst";
1933
1934 sub db_load() {
1935 $DB = stat $path ? Storable::retrieve $path : { };
1936 } 2832 {
2833 my $faces = $facedata->{faceinfo};
1937 2834
1938 my $pid; 2835 while (my ($face, $info) = each %$faces) {
2836 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2837 cf::face::set_visibility $idx, $info->{visibility};
2838 cf::face::set_magicmap $idx, $info->{magicmap};
2839 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2840 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1939 2841
1940 sub db_save() { 2842 cf::cede_to_tick;
1941 waitpid $pid, 0 if $pid;
1942 if (0 == ($pid = fork)) {
1943 $DB->{_meta}{version} = 1;
1944 Storable::nstore $DB, "$path~";
1945 rename "$path~", $path;
1946 cf::_exit 0 if defined $pid;
1947 }
1948 }
1949
1950 my $dirty;
1951
1952 sub db_sync() {
1953 db_save if $dirty;
1954 undef $dirty;
1955 }
1956
1957 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1958 db_sync;
1959 });
1960
1961 sub db_dirty() {
1962 $dirty = 1;
1963 $idle->start;
1964 }
1965
1966 sub db_get($;$) {
1967 @_ >= 2
1968 ? $DB->{$_[0]}{$_[1]}
1969 : ($DB->{$_[0]} ||= { })
1970 }
1971
1972 sub db_put($$;$) {
1973 if (@_ >= 3) {
1974 $DB->{$_[0]}{$_[1]} = $_[2];
1975 } else {
1976 $DB->{$_[0]} = $_[1];
1977 }
1978 db_dirty;
1979 }
1980
1981 cf::global->attach (
1982 prio => 10000,
1983 on_cleanup => sub {
1984 db_sync;
1985 }, 2843 }
1986 );
1987}
1988 2844
1989############################################################################# 2845 while (my ($face, $info) = each %$faces) {
1990# the server's main() 2846 next unless $info->{smooth};
2847 my $idx = cf::face::find $face
2848 or next;
2849 if (my $smooth = cf::face::find $info->{smooth}) {
2850 cf::face::set_smooth $idx, $smooth;
2851 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2852 } else {
2853 warn "smooth face '$info->{smooth}' not found for face '$face'";
2854 }
2855
2856 cf::cede_to_tick;
2857 }
2858 }
2859
2860 {
2861 my $anims = $facedata->{animinfo};
2862
2863 while (my ($anim, $info) = each %$anims) {
2864 cf::anim::set $anim, $info->{frames}, $info->{facings};
2865 cf::cede_to_tick;
2866 }
2867
2868 cf::anim::invalidate_all; # d'oh
2869 }
2870
2871 {
2872 # TODO: for gcfclient pleasure, we should give resources
2873 # that gcfclient doesn't grok a >10000 face index.
2874 my $res = $facedata->{resource};
2875 my $enc = JSON::XS->new->utf8->canonical;
2876
2877 my $soundconf = delete $res->{"res/sound.conf"};
2878
2879 while (my ($name, $info) = each %$res) {
2880 my $meta = $enc->encode ({
2881 name => $name,
2882 %{ $info->{meta} || {} },
2883 });
2884
2885 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2886
2887 if ($info->{type} & 1) {
2888 # prepend meta info
2889
2890 my $data = pack "(w/a*)*", $meta, $info->{data};
2891 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2892
2893 cf::face::set_data $idx, 0, $data, $chk;
2894 } else {
2895 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2896 }
2897
2898 cf::face::set_type $idx, $info->{type};
2899
2900 cf::cede_to_tick;
2901 }
2902
2903 if ($soundconf) {
2904 $soundconf = $enc->decode (delete $soundconf->{data});
2905
2906 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2907 my $sound = $soundconf->{compat}[$_]
2908 or next;
2909
2910 my $face = cf::face::find "sound/$sound->[1]";
2911
2912 cf::sound::set $sound->[0] => $face;
2913 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2914 }
2915
2916 #TODO
2917 }
2918 }
2919
2920 1
2921}
2922
2923register_exticmd fx_want => sub {
2924 my ($ns, $want) = @_;
2925
2926 while (my ($k, $v) = each %$want) {
2927 $ns->fx_want ($k, $v);
2928 }
2929};
2930
2931sub reload_regions {
2932 load_resource_file "$MAPDIR/regions"
2933 or die "unable to load regions file\n";
2934
2935 for (cf::region::list) {
2936 $_->{match} = qr/$_->{match}/
2937 if exists $_->{match};
2938 }
2939}
2940
2941sub reload_facedata {
2942 load_facedata "$DATADIR/facedata"
2943 or die "unable to load facedata\n";
2944}
2945
2946sub reload_archetypes {
2947 load_resource_file "$DATADIR/archetypes"
2948 or die "unable to load archetypes\n";
2949 #d# NEED to laod twice to resolve forward references
2950 # this really needs to be done in an extra post-pass
2951 # (which needs to be synchronous, so solve it differently)
2952 load_resource_file "$DATADIR/archetypes"
2953 or die "unable to load archetypes\n";
2954}
2955
2956sub reload_treasures {
2957 load_resource_file "$DATADIR/treasures"
2958 or die "unable to load treasurelists\n";
2959}
2960
2961sub reload_resources {
2962 warn "reloading resource files...\n";
2963
2964 reload_regions;
2965 reload_facedata;
2966 #reload_archetypes;#d#
2967 reload_archetypes;
2968 reload_treasures;
2969
2970 warn "finished reloading resource files\n";
2971}
2972
2973sub init {
2974 reload_resources;
2975}
1991 2976
1992sub cfg_load { 2977sub cfg_load {
1993 open my $fh, "<:utf8", cf::confdir . "/config" 2978 open my $fh, "<:utf8", "$CONFDIR/config"
1994 or return; 2979 or return;
1995 2980
1996 local $/; 2981 local $/;
1997 *CFG = YAML::Syck::Load <$fh>; 2982 *CFG = YAML::Syck::Load <$fh>;
1998 2983
1999 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2984 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2000 2985
2986 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2987 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2988
2001 if (exists $CFG{mlockall}) { 2989 if (exists $CFG{mlockall}) {
2002 eval { 2990 eval {
2003 $CFG{mlockall} ? &mlockall : &munlockall 2991 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2004 and die "WARNING: m(un)lockall failed: $!\n"; 2992 and die "WARNING: m(un)lockall failed: $!\n";
2005 }; 2993 };
2006 warn $@ if $@; 2994 warn $@ if $@;
2007 } 2995 }
2008} 2996}
2009 2997
2010sub main { 2998sub main {
2011 # we must not ever block the main coroutine 2999 # we must not ever block the main coroutine
2012 local $Coro::idle = sub { 3000 local $Coro::idle = sub {
2013 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3001 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2014 (Coro::unblock_sub { 3002 (async {
2015 Event::one_event; 3003 Event::one_event;
2016 })->(); 3004 })->prio (Coro::PRIO_MAX);
2017 }; 3005 };
2018 3006
2019 cfg_load; 3007 cfg_load;
2020 db_load; 3008 db_init;
2021 load_extensions; 3009 load_extensions;
3010
3011 $TICK_WATCHER->start;
2022 Event::loop; 3012 Event::loop;
2023} 3013}
2024 3014
2025############################################################################# 3015#############################################################################
2026# initialisation 3016# initialisation and cleanup
2027 3017
3018# install some emergency cleanup handlers
3019BEGIN {
3020 for my $signal (qw(INT HUP TERM)) {
3021 Event->signal (
3022 reentrant => 0,
3023 data => WF_AUTOCANCEL,
3024 signal => $signal,
3025 prio => 0,
3026 cb => sub {
3027 cf::cleanup "SIG$signal";
3028 },
3029 );
3030 }
3031}
3032
3033sub write_runtime {
3034 my $runtime = "$LOCALDIR/runtime";
3035
3036 # first touch the runtime file to show we are still running:
3037 # the fsync below can take a very very long time.
3038
3039 IO::AIO::aio_utime $runtime, undef, undef;
3040
3041 my $guard = cf::lock_acquire "write_runtime";
3042
3043 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3044 or return;
3045
3046 my $value = $cf::RUNTIME + 90 + 10;
3047 # 10 is the runtime save interval, for a monotonic clock
3048 # 60 allows for the watchdog to kill the server.
3049
3050 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3051 and return;
3052
3053 # always fsync - this file is important
3054 aio_fsync $fh
3055 and return;
3056
3057 # touch it again to show we are up-to-date
3058 aio_utime $fh, undef, undef;
3059
3060 close $fh
3061 or return;
3062
3063 aio_rename "$runtime~", $runtime
3064 and return;
3065
3066 warn "runtime file written.\n";
3067
3068 1
3069}
3070
3071sub emergency_save() {
3072 my $freeze_guard = cf::freeze_mainloop;
3073
3074 warn "enter emergency perl save\n";
3075
3076 cf::sync_job {
3077 # use a peculiar iteration method to avoid tripping on perl
3078 # refcount bugs in for. also avoids problems with players
3079 # and maps saved/destroyed asynchronously.
3080 warn "begin emergency player save\n";
3081 for my $login (keys %cf::PLAYER) {
3082 my $pl = $cf::PLAYER{$login} or next;
3083 $pl->valid or next;
3084 $pl->save;
3085 }
3086 warn "end emergency player save\n";
3087
3088 warn "begin emergency map save\n";
3089 for my $path (keys %cf::MAP) {
3090 my $map = $cf::MAP{$path} or next;
3091 $map->valid or next;
3092 $map->save;
3093 }
3094 warn "end emergency map save\n";
3095
3096 warn "begin emergency database checkpoint\n";
3097 BDB::db_env_txn_checkpoint $DB_ENV;
3098 warn "end emergency database checkpoint\n";
3099 };
3100
3101 warn "leave emergency perl save\n";
3102}
3103
3104sub post_cleanup {
3105 my ($make_core) = @_;
3106
3107 warn Carp::longmess "post_cleanup backtrace"
3108 if $make_core;
3109}
3110
2028sub reload() { 3111sub do_reload_perl() {
2029 # can/must only be called in main 3112 # can/must only be called in main
2030 if ($Coro::current != $Coro::main) { 3113 if ($Coro::current != $Coro::main) {
2031 warn "can only reload from main coroutine\n"; 3114 warn "can only reload from main coroutine";
2032 return; 3115 return;
2033 } 3116 }
2034 3117
2035 warn "reloading..."; 3118 warn "reloading...";
2036 3119
2037 my $guard = freeze_mainloop; 3120 warn "entering sync_job";
3121
3122 cf::sync_job {
3123 cf::write_runtime; # external watchdog should not bark
2038 cf::emergency_save; 3124 cf::emergency_save;
3125 cf::write_runtime; # external watchdog should not bark
2039 3126
2040 eval { 3127 warn "syncing database to disk";
3128 BDB::db_env_txn_checkpoint $DB_ENV;
3129
2041 # if anything goes wrong in here, we should simply crash as we already saved 3130 # if anything goes wrong in here, we should simply crash as we already saved
2042 3131
2043 # cancel all watchers 3132 warn "cancelling all WF_AUTOCANCEL watchers";
2044 for (Event::all_watchers) { 3133 for (Event::all_watchers) {
2045 $_->cancel if $_->data & WF_AUTOCANCEL; 3134 $_->cancel if $_->data & WF_AUTOCANCEL;
2046 } 3135 }
2047 3136
3137 warn "flushing outstanding aio requests";
3138 for (;;) {
3139 BDB::flush;
3140 IO::AIO::flush;
3141 Coro::cede;
3142 last unless IO::AIO::nreqs || BDB::nreqs;
3143 warn "iterate...";
3144 }
3145
3146 ++$RELOAD;
3147
2048 # cancel all extension coros 3148 warn "cancelling all extension coros";
2049 $_->cancel for values %EXT_CORO; 3149 $_->cancel for values %EXT_CORO;
2050 %EXT_CORO = (); 3150 %EXT_CORO = ();
2051 3151
2052 # unload all extensions 3152 warn "removing commands";
2053 for (@exts) { 3153 %COMMAND = ();
3154
3155 warn "removing ext/exti commands";
3156 %EXTCMD = ();
3157 %EXTICMD = ();
3158
3159 warn "unloading/nuking all extensions";
3160 for my $pkg (@EXTS) {
2054 warn "unloading <$_>"; 3161 warn "... unloading $pkg";
2055 unload_extension $_; 3162
3163 if (my $cb = $pkg->can ("unload")) {
3164 eval {
3165 $cb->($pkg);
3166 1
3167 } or warn "$pkg unloaded, but with errors: $@";
2056 } 3168 }
2057 3169
3170 warn "... nuking $pkg";
3171 Symbol::delete_package $pkg;
3172 }
3173
2058 # unload all modules loaded from $LIBDIR 3174 warn "unloading all perl modules loaded from $LIBDIR";
2059 while (my ($k, $v) = each %INC) { 3175 while (my ($k, $v) = each %INC) {
2060 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3176 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2061 3177
2062 warn "removing <$k>"; 3178 warn "... unloading $k";
2063 delete $INC{$k}; 3179 delete $INC{$k};
2064 3180
2065 $k =~ s/\.pm$//; 3181 $k =~ s/\.pm$//;
2066 $k =~ s/\//::/g; 3182 $k =~ s/\//::/g;
2067 3183
2070 } 3186 }
2071 3187
2072 Symbol::delete_package $k; 3188 Symbol::delete_package $k;
2073 } 3189 }
2074 3190
2075 # sync database to disk
2076 cf::db_sync;
2077 IO::AIO::flush;
2078
2079 # get rid of safe::, as good as possible 3191 warn "getting rid of safe::, as good as possible";
2080 Symbol::delete_package "safe::$_" 3192 Symbol::delete_package "safe::$_"
2081 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3193 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2082 3194
2083 # remove register_script_function callbacks
2084 # TODO
2085
2086 # unload cf.pm "a bit" 3195 warn "unloading cf.pm \"a bit\"";
2087 delete $INC{"cf.pm"}; 3196 delete $INC{"cf.pm"};
3197 delete $INC{"cf/pod.pm"};
2088 3198
2089 # don't, removes xs symbols, too, 3199 # don't, removes xs symbols, too,
2090 # and global variables created in xs 3200 # and global variables created in xs
2091 #Symbol::delete_package __PACKAGE__; 3201 #Symbol::delete_package __PACKAGE__;
2092 3202
2093 # reload cf.pm 3203 warn "unload completed, starting to reload now";
3204
2094 warn "reloading cf.pm"; 3205 warn "reloading cf.pm";
2095 require cf; 3206 require cf;
2096 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3207 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2097 3208
2098 # load config and database again 3209 warn "loading config and database again";
2099 cf::cfg_load; 3210 cf::cfg_load;
2100 cf::db_load;
2101 3211
2102 # load extensions
2103 warn "load extensions"; 3212 warn "loading extensions";
2104 cf::load_extensions; 3213 cf::load_extensions;
2105 3214
2106 # reattach attachments to objects 3215 warn "reattaching attachments to objects/players";
2107 warn "reattach"; 3216 _global_reattach; # objects, sockets
2108 _global_reattach; 3217 warn "reattaching attachments to maps";
2109 }; 3218 reattach $_ for values %MAP;
3219 warn "reattaching attachments to players";
3220 reattach $_ for values %PLAYER;
2110 3221
2111 if ($@) { 3222 warn "leaving sync_job";
3223
3224 1
3225 } or do {
2112 warn $@; 3226 warn $@;
2113 warn "error while reloading, exiting."; 3227 warn "error while reloading, exiting.";
2114 exit 1; 3228 exit 1;
2115 } 3229 };
2116 3230
2117 warn "reloaded successfully"; 3231 warn "reloaded";
2118}; 3232};
2119 3233
2120############################################################################# 3234our $RELOAD_WATCHER; # used only during reload
2121 3235
2122unless ($LINK_MAP) { 3236sub reload_perl() {
2123 $LINK_MAP = cf::map::new; 3237 # doing reload synchronously and two reloads happen back-to-back,
3238 # coro crashes during coro_state_free->destroy here.
2124 3239
2125 $LINK_MAP->width (41); 3240 $RELOAD_WATCHER ||= Event->timer (
2126 $LINK_MAP->height (41); 3241 reentrant => 0,
2127 $LINK_MAP->alloc;
2128 $LINK_MAP->path ("{link}");
2129 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2130 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2131
2132 # dirty hack because... archetypes are not yet loaded
2133 Event->timer (
2134 after => 2, 3242 after => 0,
3243 data => WF_AUTOCANCEL,
2135 cb => sub { 3244 cb => sub {
2136 $_[0]->w->cancel; 3245 do_reload_perl;
2137 3246 undef $RELOAD_WATCHER;
2138 # provide some exits "home"
2139 my $exit = cf::object::new "exit";
2140
2141 $exit->slaying ($EMERGENCY_POSITION->[0]);
2142 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2143 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2144
2145 $LINK_MAP->insert ($exit->clone, 19, 19);
2146 $LINK_MAP->insert ($exit->clone, 19, 20);
2147 $LINK_MAP->insert ($exit->clone, 19, 21);
2148 $LINK_MAP->insert ($exit->clone, 20, 19);
2149 $LINK_MAP->insert ($exit->clone, 20, 21);
2150 $LINK_MAP->insert ($exit->clone, 21, 19);
2151 $LINK_MAP->insert ($exit->clone, 21, 20);
2152 $LINK_MAP->insert ($exit->clone, 21, 21);
2153
2154 $exit->destroy;
2155 }); 3247 },
2156 3248 );
2157 $LINK_MAP->{deny_save} = 1;
2158 $LINK_MAP->{deny_reset} = 1;
2159
2160 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2161} 3249}
2162
2163register "<global>", __PACKAGE__;
2164 3250
2165register_command "reload" => sub { 3251register_command "reload" => sub {
2166 my ($who, $arg) = @_; 3252 my ($who, $arg) = @_;
2167 3253
2168 if ($who->flag (FLAG_WIZ)) { 3254 if ($who->flag (FLAG_WIZ)) {
2169 $who->message ("start of reload.");
2170 reload;
2171 $who->message ("end of reload."); 3255 $who->message ("reloading server.");
3256 async { reload_perl };
2172 } 3257 }
2173}; 3258};
2174 3259
2175unshift @INC, $LIBDIR; 3260unshift @INC, $LIBDIR;
2176 3261
3262my $bug_warning = 0;
3263
3264our @WAIT_FOR_TICK;
3265our @WAIT_FOR_TICK_BEGIN;
3266
3267sub wait_for_tick {
3268 return unless $TICK_WATCHER->is_active;
3269 return if $Coro::current == $Coro::main;
3270
3271 my $signal = new Coro::Signal;
3272 push @WAIT_FOR_TICK, $signal;
3273 $signal->wait;
3274}
3275
3276sub wait_for_tick_begin {
3277 return unless $TICK_WATCHER->is_active;
3278 return if $Coro::current == $Coro::main;
3279
3280 my $signal = new Coro::Signal;
3281 push @WAIT_FOR_TICK_BEGIN, $signal;
3282 $signal->wait;
3283}
3284
3285 my $min = 1e6;#d#
3286 my $avg = 10;
2177$TICK_WATCHER = Event->timer ( 3287$TICK_WATCHER = Event->timer (
2178 reentrant => 0, 3288 reentrant => 0,
3289 parked => 1,
2179 prio => 0, 3290 prio => 0,
2180 at => $NEXT_TICK || $TICK, 3291 at => $NEXT_TICK || $TICK,
2181 data => WF_AUTOCANCEL, 3292 data => WF_AUTOCANCEL,
2182 cb => sub { 3293 cb => sub {
3294 if ($Coro::current != $Coro::main) {
3295 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3296 unless ++$bug_warning > 10;
3297 return;
3298 }
3299
3300 $NOW = $tick_start = Event::time;
3301
2183 cf::server_tick; # one server iteration 3302 cf::server_tick; # one server iteration
3303
3304 0 && sync_job {#d#
3305 for(1..10) {
3306 my $t = Event::time;
3307 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3308 or die;
3309
3310 $map->width (50);
3311 $map->height (50);
3312 $map->alloc;
3313 $map->_load_objects ("/tmp/x.map", 1);
3314 my $t = Event::time - $t;
3315
3316 #next unless $t < 0.0013;#d#
3317 if ($t < $min) {
3318 $min = $t;
3319 }
3320 $avg = $avg * 0.99 + $t * 0.01;
3321 }
3322 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3323 exit 0;
3324 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3325 };
3326
2184 $RUNTIME += $TICK; 3327 $RUNTIME += $TICK;
2185 $NEXT_TICK += $TICK; 3328 $NEXT_TICK += $TICK;
2186 3329
3330 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3331 $NEXT_RUNTIME_WRITE = $NOW + 10;
3332 Coro::async_pool {
3333 write_runtime
3334 or warn "ERROR: unable to write runtime file: $!";
3335 };
3336 }
3337
3338# my $AFTER = Event::time;
3339# warn $AFTER - $NOW;#d#
3340
3341 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3342 $sig->send;
3343 }
3344 while (my $sig = shift @WAIT_FOR_TICK) {
3345 $sig->send;
3346 }
3347
3348 $NOW = Event::time;
3349
2187 # if we are delayed by four ticks or more, skip them all 3350 # if we are delayed by four ticks or more, skip them all
2188 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3351 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2189 3352
2190 $TICK_WATCHER->at ($NEXT_TICK); 3353 $TICK_WATCHER->at ($NEXT_TICK);
2191 $TICK_WATCHER->start; 3354 $TICK_WATCHER->start;
3355
3356 $LOAD = ($NOW - $tick_start) / $TICK;
3357 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3358
3359 _post_tick;
3360
3361
2192 }, 3362 },
2193); 3363);
2194 3364
3365{
2195IO::AIO::max_poll_time $TICK * 0.2; 3366 BDB::max_poll_time $TICK * 0.1;
2196 3367 $BDB_POLL_WATCHER = Event->io (
2197Event->io ( 3368 reentrant => 0,
2198 fd => IO::AIO::poll_fileno, 3369 fd => BDB::poll_fileno,
2199 poll => 'r', 3370 poll => 'r',
2200 prio => 5, 3371 prio => 0,
2201 data => WF_AUTOCANCEL,
2202 cb => \&IO::AIO::poll_cb,
2203);
2204
2205Event->timer (
2206 data => WF_AUTOCANCEL, 3372 data => WF_AUTOCANCEL,
2207 after => 0, 3373 cb => \&BDB::poll_cb,
2208 interval => 10, 3374 );
2209 cb => sub { 3375 BDB::min_parallel 8;
2210 (Coro::unblock_sub { 3376
2211 write_runtime 3377 BDB::set_sync_prepare {
2212 or warn "ERROR: unable to write runtime file: $!"; 3378 my $status;
3379 my $current = $Coro::current;
3380 (
3381 sub {
3382 $status = $!;
3383 $current->ready; undef $current;
3384 },
3385 sub {
3386 Coro::schedule while defined $current;
3387 $! = $status;
3388 },
3389 )
3390 };
3391
3392 unless ($DB_ENV) {
3393 $DB_ENV = BDB::db_env_create;
3394
3395 cf::sync_job {
3396 eval {
3397 BDB::db_env_open
3398 $DB_ENV,
3399 $BDBDIR,
3400 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3401 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3402 0666;
3403
3404 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3405
3406 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3407 $DB_ENV->set_lk_detect;
3408 };
3409
3410 cf::cleanup "db_env_open(db): $@" if $@;
2213 })->(); 3411 };
2214 }, 3412 }
2215); 3413}
3414
3415{
3416 IO::AIO::min_parallel 8;
3417
3418 undef $Coro::AIO::WATCHER;
3419 IO::AIO::max_poll_time $TICK * 0.1;
3420 $AIO_POLL_WATCHER = Event->io (
3421 reentrant => 0,
3422 data => WF_AUTOCANCEL,
3423 fd => IO::AIO::poll_fileno,
3424 poll => 'r',
3425 prio => 6,
3426 cb => \&IO::AIO::poll_cb,
3427 );
3428}
3429
3430my $_log_backtrace;
3431
3432sub _log_backtrace {
3433 my ($msg, @addr) = @_;
3434
3435 $msg =~ s/\n//;
3436
3437 # limit the # of concurrent backtraces
3438 if ($_log_backtrace < 2) {
3439 ++$_log_backtrace;
3440 async {
3441 my @bt = fork_call {
3442 @addr = map { sprintf "%x", $_ } @addr;
3443 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3444 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3445 or die "addr2line: $!";
3446
3447 my @funcs;
3448 my @res = <$fh>;
3449 chomp for @res;
3450 while (@res) {
3451 my ($func, $line) = splice @res, 0, 2, ();
3452 push @funcs, "[$func] $line";
3453 }
3454
3455 @funcs
3456 };
3457
3458 LOG llevInfo, "[ABT] $msg\n";
3459 LOG llevInfo, "[ABT] $_\n" for @bt;
3460 --$_log_backtrace;
3461 };
3462 } else {
3463 LOG llevInfo, "[ABT] $msg\n";
3464 LOG llevInfo, "[ABT] [suppressed]\n";
3465 }
3466}
3467
3468# load additional modules
3469use cf::pod;
2216 3470
2217END { cf::emergency_save } 3471END { cf::emergency_save }
2218 3472
22191 34731
2220 3474

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines