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.150 by root, Mon Jan 8 19:25:53 2007 UTC vs.
Revision 1.350 by root, Sat Sep 1 08:03:45 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines