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.142 by root, Fri Jan 5 21:51:42 2007 UTC vs.
Revision 1.326 by root, Tue Jul 31 17:33:15 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines