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.146 by root, Sun Jan 7 23:10:43 2007 UTC vs.
Revision 1.355 by root, Sun Sep 2 12:45:44 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 (likely 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 IO::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 Coro::cede;
1142 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1143 Coro::cede; 1330 cf::cede_to_tick;
1144} 1331}
1145 1332
1146sub new($) { 1333sub new($) {
1147 my ($login) = @_; 1334 my ($login) = @_;
1148 1335
1154 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1155 1342
1156 $self 1343 $self
1157} 1344}
1158 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
1159sub quit_character { 1363sub quit_character {
1160 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1161 1367
1162 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1163 $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
1164 1370
1165 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1167 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1373 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1168 $pl->ns->destroy if $pl->ns; 1374 $pl->ns->destroy if $pl->ns;
1169 1375
1170 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1171 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1172 IO::AIO::aio_rename $path, $temp, sub { 1378 aio_rename $path, $temp;
1173 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1174 $pl->destroy; 1380 $pl->destroy;
1175 1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1176 IO::AIO::aio_rmtree $temp; 1387 IO::AIO::aio_rmtree $temp;
1388}
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 $path = path $login;
1419
1420 # a .pst is a dead give-away for a valid player
1421 unless (-e "$path.pst") {
1422 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1423 aio_read $fh, 0, 512, my $buf, 0 or next;
1424 $buf !~ /^password -------------$/m or next; # official not-valid tag
1425 }
1426
1427 utf8::decode $login;
1428 push @logins, $login;
1177 }; 1429 }
1178}
1179 1430
1431 \@logins
1432}
1433
1434=item $player->maps
1435
1436Returns an arrayref of map paths that are private for this
1437player. May block.
1438
1439=cut
1440
1441sub maps($) {
1442 my ($pl) = @_;
1443
1444 $pl = ref $pl ? $pl->ob->name : $pl;
1445
1446 my $files = aio_readdir playerdir $pl
1447 or return;
1448
1449 my @paths;
1450
1451 for (@$files) {
1452 utf8::decode $_;
1453 next if /\.(?:pl|pst)$/;
1454 next unless /^$PATH_SEP/o;
1455
1456 push @paths, cf::map::normalise "~$pl/$_";
1457 }
1458
1459 \@paths
1460}
1461
1462=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1463
1464Expand crossfire pod fragments into protocol xml.
1465
1466=cut
1467
1468sub expand_cfpod {
1469 ((my $self), (local $_)) = @_;
1470
1471 # escape & and <
1472 s/&/&amp;/g;
1473 s/(?<![BIUGHT])</&lt;/g;
1474
1475 # this is buggy, it needs to properly take care of nested <'s
1476
1477 1 while
1478 # replace B<>, I<>, U<> etc.
1479 s/B<([^\>]*)>/<b>$1<\/b>/
1480 || s/I<([^\>]*)>/<i>$1<\/i>/
1481 || s/U<([^\>]*)>/<u>$1<\/u>/
1482 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1483 # replace G<male|female> tags
1484 || s{G<([^>|]*)\|([^>]*)>}{
1485 $self->gender ? $2 : $1
1486 }ge
1487 # replace H<hint text>
1488 || s{H<([^\>]*)>}
1489 {
1490 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1491 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1492 "")
1493 [$self->{hintmode}]
1494 }ge;
1495
1496 # create single paragraphs (very hackish)
1497 s/(?<=\S)\n(?=\w)/ /g;
1498
1499 # compress some whitespace
1500 s/\s+\n/\n/g; # ws line-ends
1501 s/\n\n+/\n/g; # double lines
1502 s/^\n+//; # beginning lines
1503 s/\n+$//; # ending lines
1504
1505 $_
1506}
1507
1508sub hintmode {
1509 $_[0]{hintmode} = $_[1] if @_ > 1;
1510 $_[0]{hintmode}
1511}
1512
1180=item $player->ext_reply ($msgid, $msgtype, %msg) 1513=item $player->ext_reply ($msgid, @msg)
1181 1514
1182Sends an ext reply to the player. 1515Sends an ext reply to the player.
1183 1516
1184=cut 1517=cut
1185 1518
1186sub ext_reply($$$%) { 1519sub ext_reply($$@) {
1187 my ($self, $id, %msg) = @_; 1520 my ($self, $id, @msg) = @_;
1188 1521
1189 $msg{msgid} = $id; 1522 $self->ns->ext_reply ($id, @msg)
1190
1191 $self->send ("ext " . cf::to_json \%msg);
1192} 1523}
1193 1524
1194package cf; 1525=item $player->ext_msg ($type, @msg)
1526
1527Sends an ext event to the client.
1528
1529=cut
1530
1531sub ext_msg($$@) {
1532 my ($self, $type, @msg) = @_;
1533
1534 $self->ns->ext_msg ($type, @msg);
1535}
1536
1537=head3 cf::region
1538
1539=over 4
1540
1541=cut
1542
1543package cf::region;
1544
1545=item cf::region::find_by_path $path
1546
1547Tries to decuce the likely region for a map knowing only its path.
1548
1549=cut
1550
1551sub find_by_path($) {
1552 my ($path) = @_;
1553
1554 my ($match, $specificity);
1555
1556 for my $region (list) {
1557 if ($region->{match} && $path =~ $region->{match}) {
1558 ($match, $specificity) = ($region, $region->specificity)
1559 if $region->specificity > $specificity;
1560 }
1561 }
1562
1563 $match
1564}
1195 1565
1196=back 1566=back
1197
1198 1567
1199=head3 cf::map 1568=head3 cf::map
1200 1569
1201=over 4 1570=over 4
1202 1571
1205package cf::map; 1574package cf::map;
1206 1575
1207use Fcntl; 1576use Fcntl;
1208use Coro::AIO; 1577use Coro::AIO;
1209 1578
1579use overload
1580 '""' => \&as_string,
1581 fallback => 1;
1582
1210our $MAX_RESET = 3600; 1583our $MAX_RESET = 3600;
1211our $DEFAULT_RESET = 3000; 1584our $DEFAULT_RESET = 3000;
1212 1585
1213sub generate_random_map { 1586sub generate_random_map {
1214 my ($path, $rmp) = @_; 1587 my ($self, $rmp) = @_;
1215
1216 # mit "rum" bekleckern, nicht 1588 # mit "rum" bekleckern, nicht
1217 cf::map::_create_random_map 1589 $self->_create_random_map (
1218 $path,
1219 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1590 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1220 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1591 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1221 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1592 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1222 $rmp->{exit_on_final_map}, 1593 $rmp->{exit_on_final_map},
1223 $rmp->{xsize}, $rmp->{ysize}, 1594 $rmp->{xsize}, $rmp->{ysize},
1224 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1595 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1225 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1596 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1226 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1597 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1227 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1598 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1228 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1599 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1229 (cf::region::find $rmp->{region}) 1600 (cf::region::find $rmp->{region}), $rmp->{custom}
1601 )
1602}
1603
1604=item cf::map->register ($regex, $prio)
1605
1606Register a handler for the map path matching the given regex at the
1607givne priority (higher is better, built-in handlers have priority 0, the
1608default).
1609
1610=cut
1611
1612sub register {
1613 my (undef, $regex, $prio) = @_;
1614 my $pkg = caller;
1615
1616 no strict;
1617 push @{"$pkg\::ISA"}, __PACKAGE__;
1618
1619 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1620}
1621
1622# also paths starting with '/'
1623$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1624
1625sub thawer_merge {
1626 my ($self, $merge) = @_;
1627
1628 # we have to keep some variables in memory intact
1629 local $self->{path};
1630 local $self->{load_path};
1631
1632 $self->SUPER::thawer_merge ($merge);
1633}
1634
1635sub normalise {
1636 my ($path, $base) = @_;
1637
1638 $path = "$path"; # make sure its a string
1639
1640 $path =~ s/\.map$//;
1641
1642 # map plan:
1643 #
1644 # /! non-realised random map exit (special hack!)
1645 # {... are special paths that are not being touched
1646 # ?xxx/... are special absolute paths
1647 # ?random/... random maps
1648 # /... normal maps
1649 # ~user/... per-player map of a specific user
1650
1651 $path =~ s/$PATH_SEP/\//go;
1652
1653 # treat it as relative path if it starts with
1654 # something that looks reasonable
1655 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1656 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1657
1658 $base =~ s{[^/]+/?$}{};
1659 $path = "$base/$path";
1660 }
1661
1662 for ($path) {
1663 redo if s{//}{/};
1664 redo if s{/\.?/}{/};
1665 redo if s{/[^/]+/\.\./}{/};
1666 }
1667
1668 $path
1669}
1670
1671sub new_from_path {
1672 my (undef, $path, $base) = @_;
1673
1674 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1675
1676 $path = normalise $path, $base;
1677
1678 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1679 if ($path =~ $EXT_MAP{$pkg}[1]) {
1680 my $self = bless cf::map::new, $pkg;
1681 $self->{path} = $path; $self->path ($path);
1682 $self->init; # pass $1 etc.
1683 return $self;
1684 }
1685 }
1686
1687 Carp::cluck "unable to resolve path '$path' (base '$base').";
1688 ()
1689}
1690
1691sub init {
1692 my ($self) = @_;
1693
1694 $self
1695}
1696
1697sub as_string {
1698 my ($self) = @_;
1699
1700 "$self->{path}"
1701}
1702
1703# the displayed name, this is a one way mapping
1704sub visible_name {
1705 &as_string
1706}
1707
1708# the original (read-only) location
1709sub load_path {
1710 my ($self) = @_;
1711
1712 "$MAPDIR/$self->{path}.map"
1713}
1714
1715# the temporary/swap location
1716sub save_path {
1717 my ($self) = @_;
1718
1719 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1720 "$TMPDIR/$path.map"
1721}
1722
1723# the unique path, undef == no special unique path
1724sub uniq_path {
1725 my ($self) = @_;
1726
1727 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1728 "$UNIQUEDIR/$path"
1230} 1729}
1231 1730
1232# and all this just because we cannot iterate over 1731# and all this just because we cannot iterate over
1233# all maps in C++... 1732# all maps in C++...
1234sub change_all_map_light { 1733sub change_all_map_light {
1236 1735
1237 $_->change_map_light ($change) 1736 $_->change_map_light ($change)
1238 for grep $_->outdoor, values %cf::MAP; 1737 for grep $_->outdoor, values %cf::MAP;
1239} 1738}
1240 1739
1740sub decay_objects {
1741 my ($self) = @_;
1742
1743 return if $self->{deny_reset};
1744
1745 $self->do_decay_objects;
1746}
1747
1748sub unlink_save {
1749 my ($self) = @_;
1750
1751 utf8::encode (my $save = $self->save_path);
1752 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1753 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1754}
1755
1241sub try_load_header($) { 1756sub load_header_from($) {
1242 my ($path) = @_; 1757 my ($self, $path) = @_;
1243 1758
1244 utf8::encode $path; 1759 utf8::encode $path;
1245 aio_open $path, O_RDONLY, 0 1760 #aio_open $path, O_RDONLY, 0
1761 # or return;
1762
1763 $self->_load_header ($path)
1246 or return; 1764 or return;
1247 1765
1248 my $map = cf::map::new 1766 $self->{load_path} = $path;
1767
1768 1
1769}
1770
1771sub load_header_orig {
1772 my ($self) = @_;
1773
1774 $self->load_header_from ($self->load_path)
1775}
1776
1777sub load_header_temp {
1778 my ($self) = @_;
1779
1780 $self->load_header_from ($self->save_path)
1781}
1782
1783sub prepare_temp {
1784 my ($self) = @_;
1785
1786 $self->last_access ((delete $self->{last_access})
1787 || $cf::RUNTIME); #d#
1788 # safety
1789 $self->{instantiate_time} = $cf::RUNTIME
1790 if $self->{instantiate_time} > $cf::RUNTIME;
1791}
1792
1793sub prepare_orig {
1794 my ($self) = @_;
1795
1796 $self->{load_original} = 1;
1797 $self->{instantiate_time} = $cf::RUNTIME;
1798 $self->last_access ($cf::RUNTIME);
1799 $self->instantiate;
1800}
1801
1802sub load_header {
1803 my ($self) = @_;
1804
1805 if ($self->load_header_temp) {
1806 $self->prepare_temp;
1807 } else {
1808 $self->load_header_orig
1249 or return; 1809 or return;
1810 $self->prepare_orig;
1811 }
1250 1812
1251 # for better error messages only, will be overwritten 1813 $self->{deny_reset} = 1
1252 $map->path ($path); 1814 if $self->no_reset;
1253 1815
1254 $map->load_header ($path) 1816 $self->default_region (cf::region::find_by_path $self->{path})
1255 or return; 1817 unless $self->default_region;
1256 1818
1257 $map->{load_path} = $path; 1819 1
1258
1259 $map
1260} 1820}
1261 1821
1262sub find; 1822sub find;
1263sub find { 1823sub find {
1264 my ($path, $origin) = @_; 1824 my ($path, $origin) = @_;
1265 1825
1266 #warn "find<$path,$origin>\n";#d#
1267
1268 $path = new cf::path $path, $origin && $origin->path; 1826 $path = normalise $path, $origin && $origin->path;
1269 my $key = $path->as_string;
1270 1827
1271 cf::lock_wait "map_find:$key"; 1828 cf::lock_wait "map_find:$path";
1272 1829
1273 $cf::MAP{$key} || do { 1830 $cf::MAP{$path} || do {
1274 my $guard = cf::lock_acquire "map_find:$key"; 1831 my $guard = cf::lock_acquire "map_find:$path";
1275 1832 my $map = new_from_path cf::map $path
1276 # do it the slow way
1277 my $map = try_load_header $path->save_path;
1278
1279 Coro::cede;
1280
1281 if ($map) {
1282 $map->last_access ((delete $map->{last_access})
1283 || $cf::RUNTIME); #d#
1284 # safety
1285 $map->{instantiate_time} = $cf::RUNTIME
1286 if $map->{instantiate_time} > $cf::RUNTIME;
1287 } else {
1288 if (my $rmp = $path->random_map_params) {
1289 $map = generate_random_map $key, $rmp;
1290 } else {
1291 $map = try_load_header $path->load_path;
1292 }
1293
1294 $map or return; 1833 or return;
1295 1834
1296 $map->{load_original} = 1;
1297 $map->{instantiate_time} = $cf::RUNTIME;
1298 $map->last_access ($cf::RUNTIME);
1299 $map->instantiate;
1300
1301 # per-player maps become, after loading, normal maps
1302 $map->per_player (0) if $path->{user_rel};
1303 }
1304
1305 $map->path ($key);
1306 $map->{path} = $path;
1307 $map->{last_save} = $cf::RUNTIME; 1835 $map->{last_save} = $cf::RUNTIME;
1308 1836
1309 Coro::cede; 1837 $map->load_header
1838 or return;
1310 1839
1311 if ($map->should_reset) { 1840 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1841 # doing this can freeze the server in a sync job, obviously
1842 #$cf::WAIT_FOR_TICK->wait;
1312 $map->reset; 1843 $map->reset;
1313 undef $guard; 1844 undef $guard;
1314 $map = find $path 1845 return find $path;
1315 or return;
1316 } 1846 }
1317 1847
1318 $cf::MAP{$key} = $map 1848 $cf::MAP{$path} = $map
1319 } 1849 }
1320} 1850}
1851
1852sub pre_load { }
1853sub post_load { }
1321 1854
1322sub load { 1855sub load {
1323 my ($self) = @_; 1856 my ($self) = @_;
1324 1857
1858 local $self->{deny_reset} = 1; # loading can take a long time
1859
1325 my $path = $self->{path}; 1860 my $path = $self->{path};
1861
1862 {
1863 my $guard1 = cf::lock_acquire "map_data:$path";
1326 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1864 my $guard2 = cf::lock_acquire "map_load:$path";
1327 1865
1328 return if $self->in_memory != cf::MAP_SWAPPED; 1866 return if $self->in_memory != cf::MAP_SWAPPED;
1329 1867
1330 $self->in_memory (cf::MAP_LOADING); 1868 $self->in_memory (cf::MAP_LOADING);
1331 1869
1332 $self->alloc; 1870 $self->alloc;
1871
1872 $self->pre_load;
1873 cf::cede_to_tick;
1874
1333 $self->load_objects ($self->{load_path}, 1) 1875 $self->_load_objects ($self->{load_path}, 1)
1334 or return; 1876 or return;
1335 1877
1336 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1878 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1337 if delete $self->{load_original}; 1879 if delete $self->{load_original};
1338 1880
1339 if (my $uniq = $path->uniq_path) { 1881 if (my $uniq = $self->uniq_path) {
1340 utf8::encode $uniq; 1882 utf8::encode $uniq;
1341 if (aio_open $uniq, O_RDONLY, 0) { 1883 if (aio_open $uniq, O_RDONLY, 0) {
1342 $self->clear_unique_items; 1884 $self->clear_unique_items;
1343 $self->load_objects ($uniq, 0); 1885 $self->_load_objects ($uniq, 0);
1344 } 1886 }
1345 } 1887 }
1346 1888
1347 Coro::cede; 1889 cf::cede_to_tick;
1348
1349 # now do the right thing for maps 1890 # now do the right thing for maps
1350 $self->link_multipart_objects; 1891 $self->link_multipart_objects;
1351
1352 if ($self->{path}->is_style_map) {
1353 $self->{deny_save} = 1;
1354 $self->{deny_reset} = 1;
1355 } else {
1356 $self->fix_auto_apply;
1357 $self->decay_objects;
1358 $self->update_buttons;
1359 $self->set_darkness_map;
1360 $self->difficulty ($self->estimate_difficulty) 1892 $self->difficulty ($self->estimate_difficulty)
1361 unless $self->difficulty; 1893 unless $self->difficulty;
1894 cf::cede_to_tick;
1895
1896 unless ($self->{deny_activate}) {
1897 $self->decay_objects;
1898 $self->fix_auto_apply;
1899 $self->update_buttons;
1900 cf::cede_to_tick;
1901 $self->set_darkness_map;
1902 cf::cede_to_tick;
1362 $self->activate; 1903 $self->activate;
1363 } 1904 }
1364 1905
1365 Coro::cede; 1906 $self->{last_save} = $cf::RUNTIME;
1907 $self->last_access ($cf::RUNTIME);
1366 1908
1367 $self->in_memory (cf::MAP_IN_MEMORY); 1909 $self->in_memory (cf::MAP_IN_MEMORY);
1910 }
1911
1912 $self->post_load;
1913}
1914
1915sub customise_for {
1916 my ($self, $ob) = @_;
1917
1918 return find "~" . $ob->name . "/" . $self->{path}
1919 if $self->per_player;
1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1923
1924 $self
1925}
1926
1927# find and load all maps in the 3x3 area around a map
1928sub load_neighbours {
1929 my ($map) = @_;
1930
1931 my @neigh; # diagonal neighbours
1932
1933 for (0 .. 3) {
1934 my $neigh = $map->tile_path ($_)
1935 or next;
1936 $neigh = find $neigh, $map
1937 or next;
1938 $neigh->load;
1939
1940 push @neigh,
1941 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1942 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1943 }
1944
1945 for (grep defined $_->[0], @neigh) {
1946 my ($path, $origin) = @$_;
1947 my $neigh = find $path, $origin
1948 or next;
1949 $neigh->load;
1950 }
1368} 1951}
1369 1952
1370sub find_sync { 1953sub find_sync {
1371 my ($path, $origin) = @_; 1954 my ($path, $origin) = @_;
1372 1955
1373 cf::sync_job { cf::map::find $path, $origin } 1956 cf::sync_job { find $path, $origin }
1374} 1957}
1375 1958
1376sub do_load_sync { 1959sub do_load_sync {
1377 my ($map) = @_; 1960 my ($map) = @_;
1378 1961
1962 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1963 if $Coro::current == $Coro::main;
1964
1379 cf::sync_job { $map->load }; 1965 cf::sync_job { $map->load };
1966}
1967
1968our %MAP_PREFETCH;
1969our $MAP_PREFETCHER = undef;
1970
1971sub find_async {
1972 my ($path, $origin, $load) = @_;
1973
1974 $path = normalise $path, $origin && $origin->{path};
1975
1976 if (my $map = $cf::MAP{$path}) {
1977 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1978 }
1979
1980 $MAP_PREFETCH{$path} |= $load;
1981
1982 $MAP_PREFETCHER ||= cf::async {
1983 while (%MAP_PREFETCH) {
1984 while (my ($k, $v) = each %MAP_PREFETCH) {
1985 if (my $map = find $k) {
1986 $map->load if $v;
1987 }
1988
1989 delete $MAP_PREFETCH{$k};
1990 }
1991 }
1992 undef $MAP_PREFETCHER;
1993 };
1994 $MAP_PREFETCHER->prio (6);
1995
1996 ()
1380} 1997}
1381 1998
1382sub save { 1999sub save {
1383 my ($self) = @_; 2000 my ($self) = @_;
1384 2001
1385 my $lock = cf::lock_acquire "map_data:" . $self->path; 2002 my $lock = cf::lock_acquire "map_data:$self->{path}";
1386 2003
1387 $self->{last_save} = $cf::RUNTIME; 2004 $self->{last_save} = $cf::RUNTIME;
1388 2005
1389 return unless $self->dirty; 2006 return unless $self->dirty;
1390 2007
1391 my $save = $self->{path}->save_path; utf8::encode $save; 2008 my $save = $self->save_path; utf8::encode $save;
1392 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2009 my $uniq = $self->uniq_path; utf8::encode $uniq;
1393 2010
1394 $self->{load_path} = $save; 2011 $self->{load_path} = $save;
1395 2012
1396 return if $self->{deny_save}; 2013 return if $self->{deny_save};
1397 2014
1400 cf::async { 2017 cf::async {
1401 $_->contr->save for $self->players; 2018 $_->contr->save for $self->players;
1402 }; 2019 };
1403 2020
1404 if ($uniq) { 2021 if ($uniq) {
1405 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2022 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1406 $self->save_objects ($uniq, cf::IO_UNIQUES); 2023 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1407 } else { 2024 } else {
1408 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2025 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1409 } 2026 }
1410} 2027}
1411 2028
1412sub swap_out { 2029sub swap_out {
1413 my ($self) = @_; 2030 my ($self) = @_;
1414 2031
1415 # save first because save cedes 2032 # save first because save cedes
1416 $self->save; 2033 $self->save;
1417 2034
1418 my $lock = cf::lock_acquire "map_data:" . $self->path; 2035 my $lock = cf::lock_acquire "map_data:$self->{path}";
1419 2036
1420 return if $self->players; 2037 return if $self->players;
1421 return if $self->in_memory != cf::MAP_IN_MEMORY; 2038 return if $self->in_memory != cf::MAP_IN_MEMORY;
1422 return if $self->{deny_save}; 2039 return if $self->{deny_save};
1423 2040
1427 2044
1428sub reset_at { 2045sub reset_at {
1429 my ($self) = @_; 2046 my ($self) = @_;
1430 2047
1431 # TODO: safety, remove and allow resettable per-player maps 2048 # TODO: safety, remove and allow resettable per-player maps
1432 return 1e99 if $self->{path}{user_rel};
1433 return 1e99 if $self->{deny_reset}; 2049 return 1e99 if $self->{deny_reset};
1434 2050
1435 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1436 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1437 2053
1442 my ($self) = @_; 2058 my ($self) = @_;
1443 2059
1444 $self->reset_at <= $cf::RUNTIME 2060 $self->reset_at <= $cf::RUNTIME
1445} 2061}
1446 2062
1447sub unlink_save {
1448 my ($self) = @_;
1449
1450 utf8::encode (my $save = $self->{path}->save_path);
1451 aioreq_pri 3; IO::AIO::aio_unlink $save;
1452 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1453}
1454
1455sub rename {
1456 my ($self, $new_path) = @_;
1457
1458 $self->unlink_save;
1459
1460 delete $cf::MAP{$self->path};
1461 $self->{path} = new cf::path $new_path;
1462 $self->path ($self->{path}->as_string);
1463 $cf::MAP{$self->path} = $self;
1464
1465 $self->save;
1466}
1467
1468sub reset { 2063sub reset {
1469 my ($self) = @_; 2064 my ($self) = @_;
1470 2065
1471 my $lock = cf::lock_acquire "map_data:" . $self->path; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1472 2067
1473 return if $self->players; 2068 return if $self->players;
1474 return if $self->{path}{user_rel};#d#
1475 2069
1476 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
2071
2072 $self->in_memory (cf::MAP_SWAPPED);
2073
2074 # need to save uniques path
2075 unless ($self->{deny_save}) {
2076 my $uniq = $self->uniq_path; utf8::encode $uniq;
2077
2078 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2079 if $uniq;
2080 }
1477 2081
1478 delete $cf::MAP{$self->path}; 2082 delete $cf::MAP{$self->path};
2083
2084 $self->clear;
1479 2085
1480 $_->clear_links_to ($self) for values %cf::MAP; 2086 $_->clear_links_to ($self) for values %cf::MAP;
1481 2087
1482 $self->unlink_save; 2088 $self->unlink_save;
1483 $self->destroy; 2089 $self->destroy;
1486my $nuke_counter = "aaaa"; 2092my $nuke_counter = "aaaa";
1487 2093
1488sub nuke { 2094sub nuke {
1489 my ($self) = @_; 2095 my ($self) = @_;
1490 2096
2097 {
2098 my $lock = cf::lock_acquire "map_data:$self->{path}";
2099
2100 delete $cf::MAP{$self->path};
2101
2102 $self->unlink_save;
2103
2104 bless $self, "cf::map";
2105 delete $self->{deny_reset};
1491 $self->{deny_save} = 1; 2106 $self->{deny_save} = 1;
1492 $self->reset_timeout (1); 2107 $self->reset_timeout (1);
1493 $self->rename ("{nuke}/" . ($nuke_counter++)); 2108 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2109
2110 $cf::MAP{$self->path} = $self;
2111 }
2112
1494 $self->reset; # polite request, might not happen 2113 $self->reset; # polite request, might not happen
1495} 2114}
1496 2115
1497sub customise_for { 2116=item $maps = cf::map::tmp_maps
1498 my ($map, $ob) = @_;
1499 2117
1500 if ($map->per_player) { 2118Returns an arrayref with all map paths of currently instantiated and saved
1501 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2119maps. May block.
2120
2121=cut
2122
2123sub tmp_maps() {
1502 } 2124 [
1503 2125 map {
1504 $map 2126 utf8::decode $_;
2127 /\.map$/
2128 ? normalise $_
2129 : ()
2130 } @{ aio_readdir $TMPDIR or [] }
2131 ]
1505} 2132}
1506 2133
1507sub emergency_save { 2134=item $maps = cf::map::random_maps
1508 my $freeze_guard = cf::freeze_mainloop;
1509 2135
1510 warn "enter emergency perl save\n"; 2136Returns an arrayref with all map paths of currently instantiated and saved
2137random maps. May block.
1511 2138
1512 cf::sync_job { 2139=cut
1513 warn "begin emergency player save\n";
1514 $_->save for values %cf::PLAYER;
1515 warn "end emergency player save\n";
1516 2140
1517 warn "begin emergency map save\n"; 2141sub random_maps() {
1518 $_->save for values %cf::MAP; 2142 [
1519 warn "end emergency map save\n"; 2143 map {
1520 }; 2144 utf8::decode $_;
2145 /\.map$/
2146 ? normalise "?random/$_"
2147 : ()
2148 } @{ aio_readdir $RANDOMDIR or [] }
2149 ]
2150}
1521 2151
1522 warn "leave emergency perl save\n"; 2152=item cf::map::unique_maps
2153
2154Returns an arrayref of paths of all shared maps that have
2155instantiated unique items. May block.
2156
2157=cut
2158
2159sub unique_maps() {
2160 [
2161 map {
2162 utf8::decode $_;
2163 /\.map$/
2164 ? normalise $_
2165 : ()
2166 } @{ aio_readdir $UNIQUEDIR or [] }
2167 ]
1523} 2168}
1524 2169
1525package cf; 2170package cf;
1526 2171
1527=back 2172=back
1528 2173
2174=head3 cf::object
2175
2176=cut
2177
2178package cf::object;
2179
2180=over 4
2181
2182=item $ob->inv_recursive
2183
2184Returns the inventory of the object _and_ their inventories, recursively.
2185
2186=cut
2187
2188sub inv_recursive_;
2189sub inv_recursive_ {
2190 map { $_, inv_recursive_ $_->inv } @_
2191}
2192
2193sub inv_recursive {
2194 inv_recursive_ inv $_[0]
2195}
2196
2197package cf;
2198
2199=back
1529 2200
1530=head3 cf::object::player 2201=head3 cf::object::player
1531 2202
1532=over 4 2203=over 4
1533 2204
1547 2218
1548 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2219 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1549 2220
1550 if ($self->{record_replies}) { 2221 if ($self->{record_replies}) {
1551 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2222 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2223
1552 } else { 2224 } else {
2225 my $pl = $self->contr;
2226
2227 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2228 my $dialog = $pl->{npc_dialog};
2229 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2230
2231 } else {
1553 $msg = $npc->name . " says: $msg" if $npc; 2232 $msg = $npc->name . " says: $msg" if $npc;
1554 $self->message ($msg, $flags); 2233 $self->message ($msg, $flags);
2234 }
1555 } 2235 }
2236}
2237
2238=item $object->send_msg ($channel, $msg, $color, [extra...])
2239
2240=cut
2241
2242sub cf::object::send_msg {
2243 my $pl = shift->contr
2244 or return;
2245 $pl->send_msg (@_);
1556} 2246}
1557 2247
1558=item $player_object->may ("access") 2248=item $player_object->may ("access")
1559 2249
1560Returns wether the given player is authorized to access resource "access" 2250Returns wether the given player is authorized to access resource "access"
1573 2263
1574=item $player_object->enter_link 2264=item $player_object->enter_link
1575 2265
1576Freezes the player and moves him/her to a special map (C<{link}>). 2266Freezes the player and moves him/her to a special map (C<{link}>).
1577 2267
1578The player should be reaosnably safe there for short amounts of time. You 2268The player should be reasonably safe there for short amounts of time. You
1579I<MUST> call C<leave_link> as soon as possible, though. 2269I<MUST> call C<leave_link> as soon as possible, though.
1580 2270
2271Will never block.
2272
1581=item $player_object->leave_link ($map, $x, $y) 2273=item $player_object->leave_link ($map, $x, $y)
1582 2274
1583Moves the player out of the specila link map onto the given map. If the 2275Moves the player out of the special C<{link}> map onto the specified
1584map is not valid (or omitted), the player will be moved back to the 2276map. If the map is not valid (or omitted), the player will be moved back
1585location he/she was before the call to C<enter_link>, or, if that fails, 2277to the location he/she was before the call to C<enter_link>, or, if that
1586to the emergency map position. 2278fails, to the emergency map position.
1587 2279
1588Might block. 2280Might block.
1589 2281
1590=cut 2282=cut
2283
2284sub link_map {
2285 unless ($LINK_MAP) {
2286 $LINK_MAP = cf::map::find "{link}"
2287 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2288 $LINK_MAP->load;
2289 }
2290
2291 $LINK_MAP
2292}
1591 2293
1592sub cf::object::player::enter_link { 2294sub cf::object::player::enter_link {
1593 my ($self) = @_; 2295 my ($self) = @_;
1594 2296
1595 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1596 2298
1597 return if $self->map == $LINK_MAP; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1598 2300
1599 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1600 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1601 2303
1602 $self->enter_map ($LINK_MAP, 20, 20); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1603} 2305}
1604 2306
1605sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1606 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1607 2311
1608 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1609 2313
1610 unless ($map) { 2314 unless ($map) {
1611 # restore original map position 2315 # restore original map position
1625 # use -1 or undef as default coordinates, not 0, 0 2329 # use -1 or undef as default coordinates, not 0, 0
1626 ($x, $y) = ($map->enter_x, $map->enter_y) 2330 ($x, $y) = ($map->enter_x, $map->enter_y)
1627 if $x <=0 && $y <= 0; 2331 if $x <=0 && $y <= 0;
1628 2332
1629 $map->load; 2333 $map->load;
2334 $map->load_neighbours;
1630 2335
1631 return unless $self->contr->active; 2336 return unless $self->contr->active;
1632 $self->activate_recursive; 2337 $self->activate_recursive;
2338
2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1633 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1634} 2341}
1635 2342
1636cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1637 on_logout => sub {
1638 my ($pl) = @_;
1639 2344
1640 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1641 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1642 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1643 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1644 }; 2349be called at the end of this process.
1645 }
1646 },
1647 on_login => sub {
1648 my ($pl) = @_;
1649 2350
1650 # try to abort aborted map switching on player login :)
1651 # should happen only on crashes
1652 if ($pl->ob->{_link_pos}) {
1653 $pl->ob->enter_link;
1654 (async {
1655 # we need this sleep as the login has a concurrent enter_exit running
1656 # and this sleep increases chances of the player not ending up in scorn
1657 $pl->ob->reply (undef,
1658 "There was an internal problem at your last logout, "
1659 . "the server will try to bring you to your intended destination in a second.",
1660 cf::NDI_RED);
1661 Coro::Timer::sleep 1;
1662 $pl->ob->leave_link;
1663 })->prio (2);
1664 }
1665 },
1666);
1667
1668=item $player_object->goto ($path, $x, $y)
1669
1670=cut 2351=cut
2352
2353our $GOTOGEN;
1671 2354
1672sub cf::object::player::goto { 2355sub cf::object::player::goto {
1673 my ($self, $path, $x, $y) = @_; 2356 my ($self, $path, $x, $y, $check, $done) = @_;
2357
2358 # do generation counting so two concurrent goto's will be executed in-order
2359 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1674 2360
1675 $self->enter_link; 2361 $self->enter_link;
1676 2362
1677 (async { 2363 (async {
1678 $path = new cf::path $path; 2364 my $map = eval {
1679
1680 my $map = cf::map::find $path->as_string; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1681 $map = $map->customise_for ($self) if $map; 2368 $map = $map->customise_for ($self);
1682 2369 $map = $check->($map) if $check && $map;
1683# warn "entering ", $map->path, " at ($x, $y)\n" 2370 } else {
1684# if $map;
1685
1686 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2371 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2372 }
1687 2373
2374 $map
2375 };
2376
2377 if ($@) {
2378 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2379 LOG llevError | logBacktrace, Carp::longmess $@;
2380 }
2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1688 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1689 })->prio (1); 2388 })->prio (1);
1690} 2389}
1691 2390
1692=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1693 2392
1695 2394
1696sub parse_random_map_params { 2395sub parse_random_map_params {
1697 my ($spec) = @_; 2396 my ($spec) = @_;
1698 2397
1699 my $rmp = { # defaults 2398 my $rmp = { # defaults
1700 xsize => 10, 2399 xsize => (cf::rndm 15, 40),
1701 ysize => 10, 2400 ysize => (cf::rndm 15, 40),
2401 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2402 #layout => string,
1702 }; 2403 };
1703 2404
1704 for (split /\n/, $spec) { 2405 for (split /\n/, $spec) {
1705 my ($k, $v) = split /\s+/, $_, 2; 2406 my ($k, $v) = split /\s+/, $_, 2;
1706 2407
1710 $rmp 2411 $rmp
1711} 2412}
1712 2413
1713sub prepare_random_map { 2414sub prepare_random_map {
1714 my ($exit) = @_; 2415 my ($exit) = @_;
2416
2417 my $guard = cf::lock_acquire "exit_prepare:$exit";
1715 2418
1716 # all this does is basically replace the /! path by 2419 # all this does is basically replace the /! path by
1717 # a new random map path (?random/...) with a seed 2420 # a new random map path (?random/...) with a seed
1718 # that depends on the exit object 2421 # that depends on the exit object
1719 2422
1720 my $rmp = parse_random_map_params $exit->msg; 2423 my $rmp = parse_random_map_params $exit->msg;
1721 2424
1722 if ($exit->map) { 2425 if ($exit->map) {
1723 $rmp->{region} = $exit->map->region_name; 2426 $rmp->{region} = $exit->region->name;
1724 $rmp->{origin_map} = $exit->map->path; 2427 $rmp->{origin_map} = $exit->map->path;
1725 $rmp->{origin_x} = $exit->x; 2428 $rmp->{origin_x} = $exit->x;
1726 $rmp->{origin_y} = $exit->y; 2429 $rmp->{origin_y} = $exit->y;
1727 } 2430 }
1728 2431
1729 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1730 2433
1731 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1732 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
2436 my $meta = "$RANDOMDIR/$md5.meta";
1733 2437
1734 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1735 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
2440 undef $fh;
2441 aio_rename "$meta~", $meta;
1736 2442
1737 $exit->slaying ("?random/$md5"); 2443 $exit->slaying ("?random/$md5");
1738 $exit->msg (undef); 2444 $exit->msg (undef);
1739 } 2445 }
1740} 2446}
1742sub cf::object::player::enter_exit { 2448sub cf::object::player::enter_exit {
1743 my ($self, $exit) = @_; 2449 my ($self, $exit) = @_;
1744 2450
1745 return unless $self->type == cf::PLAYER; 2451 return unless $self->type == cf::PLAYER;
1746 2452
2453 if ($exit->slaying eq "/!") {
2454 #TODO: this should de-fi-ni-te-ly not be a sync-job
2455 # the problem is that $exit might not survive long enough
2456 # so it needs to be done right now, right here
2457 cf::sync_job { prepare_random_map $exit };
2458 }
2459
2460 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2461 my $hp = $exit->stats->hp;
2462 my $sp = $exit->stats->sp;
2463
1747 $self->enter_link; 2464 $self->enter_link;
2465
2466 # if exit is damned, update players death & WoR home-position
2467 $self->contr->savebed ($slaying, $hp, $sp)
2468 if $exit->flag (FLAG_DAMNED);
1748 2469
1749 (async { 2470 (async {
1750 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
1751 unless (eval { 2472 unless (eval {
1752 prepare_random_map $exit 2473 $self->goto ($slaying, $hp, $sp);
1753 if $exit->slaying eq "/!";
1754
1755 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1756 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1757 2474
1758 1; 2475 1;
1759 }) { 2476 }) {
1760 $self->message ("Something went wrong deep within the crossfire server. " 2477 $self->message ("Something went wrong deep within the crossfire server. "
1761 . "I'll try to bring you back to the map you were before. " 2478 . "I'll try to bring you back to the map you were before. "
1762 . "Please report this to the dungeon master", 2479 . "Please report this to the dungeon master!",
1763 cf::NDI_UNIQUE | cf::NDI_RED); 2480 cf::NDI_UNIQUE | cf::NDI_RED);
1764 2481
1765 warn "ERROR in enter_exit: $@"; 2482 warn "ERROR in enter_exit: $@";
1766 $self->leave_link; 2483 $self->leave_link;
1767 } 2484 }
1768 })->prio (1); 2485 })->prio (1);
1781 2498
1782sub cf::client::send_drawinfo { 2499sub cf::client::send_drawinfo {
1783 my ($self, $text, $flags) = @_; 2500 my ($self, $text, $flags) = @_;
1784 2501
1785 utf8::encode $text; 2502 utf8::encode $text;
1786 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1787} 2504}
1788 2505
2506=item $client->send_msg ($channel, $msg, $color, [extra...])
2507
2508Send a drawinfo or msg packet to the client, formatting the msg for the
2509client if neccessary. C<$type> should be a string identifying the type of
2510the message, with C<log> being the default. If C<$color> is negative, suppress
2511the message unless the client supports the msg packet.
2512
2513=cut
2514
2515our %CHANNEL = (
2516 "c/identify" => {
2517 id => "identify",
2518 title => "Identify",
2519 reply => undef,
2520 tooltip => "Items recently identified",
2521 },
2522 "c/examine" => {
2523 id => "examine",
2524 title => "Examine",
2525 reply => undef,
2526 tooltip => "Signs and other items you examined",
2527 },
2528);
2529
2530sub cf::client::send_msg {
2531 my ($self, $channel, $msg, $color, @extra) = @_;
2532
2533 $msg = $self->pl->expand_cfpod ($msg);
2534
2535 $color &= cf::NDI_CLIENT_MASK; # just in case...
2536
2537 # check predefined channels, for the benefit of C
2538 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2539
2540 if (ref $channel) {
2541 # send meta info to client, if not yet sent
2542 unless (exists $self->{channel}{$channel->{id}}) {
2543 $self->{channel}{$channel->{id}} = $channel;
2544 $self->ext_msg (channel_info => $channel)
2545 if $self->can_msg;
2546 }
2547
2548 $channel = $channel->{id};
2549 }
2550
2551 return unless @extra || length $msg;
2552
2553 if ($self->can_msg) {
2554 # default colour, mask it out
2555 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2556 if $color & cf::NDI_DEF;
2557
2558 $self->send_packet ("msg " . $self->{json_coder}->encode (
2559 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2560 } else {
2561 if ($color >= 0) {
2562 # replace some tags by gcfclient-compatible ones
2563 for ($msg) {
2564 1 while
2565 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2566 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2567 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2568 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2569 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2570 }
2571
2572 $color &= cf::NDI_COLOR_MASK;
2573
2574 utf8::encode $msg;
2575
2576 if (0 && $msg =~ /\[/) {
2577 # COMMAND/INFO
2578 $self->send_packet ("drawextinfo $color 10 8 $msg")
2579 } else {
2580 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2581 $self->send_packet ("drawinfo $color $msg")
2582 }
2583 }
2584 }
2585}
2586
2587=item $client->ext_msg ($type, @msg)
2588
2589Sends an ext event to the client.
2590
2591=cut
2592
2593sub cf::client::ext_msg($$@) {
2594 my ($self, $type, @msg) = @_;
2595
2596 if ($self->extcmd == 2) {
2597 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2598 } elsif ($self->extcmd == 1) { # TODO: remove
2599 push @msg, msgtype => "event_$type";
2600 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2601 }
2602}
2603
2604=item $client->ext_reply ($msgid, @msg)
2605
2606Sends an ext reply to the client.
2607
2608=cut
2609
2610sub cf::client::ext_reply($$@) {
2611 my ($self, $id, @msg) = @_;
2612
2613 if ($self->extcmd == 2) {
2614 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2615 } elsif ($self->extcmd == 1) {
2616 #TODO: version 1, remove
2617 unshift @msg, msgtype => "reply", msgid => $id;
2618 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2619 }
2620}
1789 2621
1790=item $success = $client->query ($flags, "text", \&cb) 2622=item $success = $client->query ($flags, "text", \&cb)
1791 2623
1792Queues a query to the client, calling the given callback with 2624Queues a query to the client, calling the given callback with
1793the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2625the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1794C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2626C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1795 2627
1796Queries can fail, so check the return code. Or don't, as queries will become 2628Queries can fail, so check the return code. Or don't, as queries will
1797reliable at some point in the future. 2629become reliable at some point in the future.
1798 2630
1799=cut 2631=cut
1800 2632
1801sub cf::client::query { 2633sub cf::client::query {
1802 my ($self, $flags, $text, $cb) = @_; 2634 my ($self, $flags, $text, $cb) = @_;
1810 utf8::encode $text; 2642 utf8::encode $text;
1811 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2643 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1812 2644
1813 $self->send_packet ($self->{query_queue}[0][0]) 2645 $self->send_packet ($self->{query_queue}[0][0])
1814 if @{ $self->{query_queue} } == 1; 2646 if @{ $self->{query_queue} } == 1;
2647
2648 1
1815} 2649}
1816 2650
1817cf::client->attach ( 2651cf::client->attach (
2652 on_connect => sub {
2653 my ($ns) = @_;
2654
2655 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2656 },
1818 on_reply => sub { 2657 on_reply => sub {
1819 my ($ns, $msg) = @_; 2658 my ($ns, $msg) = @_;
1820 2659
1821 # this weird shuffling is so that direct followup queries 2660 # this weird shuffling is so that direct followup queries
1822 # get handled first 2661 # get handled first
1823 my $queue = delete $ns->{query_queue} 2662 my $queue = delete $ns->{query_queue}
1824 or return; # be conservative, not sure how that can happen, but we saw a crash here 2663 or return; # be conservative, not sure how that can happen, but we saw a crash here
1825 2664
1826 (shift @$queue)->[1]->($msg); 2665 (shift @$queue)->[1]->($msg);
2666 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1827 2667
1828 push @{ $ns->{query_queue} }, @$queue; 2668 push @{ $ns->{query_queue} }, @$queue;
1829 2669
1830 if (@{ $ns->{query_queue} } == @$queue) { 2670 if (@{ $ns->{query_queue} } == @$queue) {
1831 if (@$queue) { 2671 if (@$queue) {
1833 } else { 2673 } else {
1834 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2674 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1835 } 2675 }
1836 } 2676 }
1837 }, 2677 },
2678 on_exticmd => sub {
2679 my ($ns, $buf) = @_;
2680
2681 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2682
2683 if (ref $msg) {
2684 my ($type, $reply, @payload) =
2685 "ARRAY" eq ref $msg
2686 ? @$msg
2687 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2688
2689 my @reply;
2690
2691 if (my $cb = $EXTICMD{$type}) {
2692 @reply = $cb->($ns, @payload);
2693 }
2694
2695 $ns->ext_reply ($reply, @reply)
2696 if $reply;
2697
2698 } else {
2699 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2700 }
2701
2702 cf::override;
2703 },
1838); 2704);
1839 2705
1840=item $client->async (\&cb) 2706=item $client->async (\&cb)
1841 2707
1842Create a new coroutine, running the specified callback. The coroutine will 2708Create a new coroutine, running the specified callback. The coroutine will
1883our $safe = new Safe "safe"; 2749our $safe = new Safe "safe";
1884our $safe_hole = new Safe::Hole; 2750our $safe_hole = new Safe::Hole;
1885 2751
1886$SIG{FPE} = 'IGNORE'; 2752$SIG{FPE} = 'IGNORE';
1887 2753
1888$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2754$safe->permit_only (Opcode::opset qw(
2755 :base_core :base_mem :base_orig :base_math
2756 grepstart grepwhile mapstart mapwhile
2757 sort time
2758));
1889 2759
1890# here we export the classes and methods available to script code 2760# here we export the classes and methods available to script code
1891 2761
1892=pod 2762=pod
1893 2763
1894The following fucntions and emthods are available within a safe environment: 2764The following functions and methods are available within a safe environment:
1895 2765
1896 cf::object contr pay_amount pay_player map 2766 cf::object
2767 contr pay_amount pay_player map x y force_find force_add
2768 insert remove name archname title slaying race decrease_ob_nr
2769
1897 cf::object::player player 2770 cf::object::player
1898 cf::player peaceful 2771 player
1899 cf::map trigger 2772
2773 cf::player
2774 peaceful
2775
2776 cf::map
2777 trigger
1900 2778
1901=cut 2779=cut
1902 2780
1903for ( 2781for (
1904 ["cf::object" => qw(contr pay_amount pay_player map)], 2782 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2783 insert remove inv name archname title slaying race
2784 decrease_ob_nr)],
1905 ["cf::object::player" => qw(player)], 2785 ["cf::object::player" => qw(player)],
1906 ["cf::player" => qw(peaceful)], 2786 ["cf::player" => qw(peaceful)],
1907 ["cf::map" => qw(trigger)], 2787 ["cf::map" => qw(trigger)],
1908) { 2788) {
1909 no strict 'refs'; 2789 no strict 'refs';
1980=back 2860=back
1981 2861
1982=cut 2862=cut
1983 2863
1984############################################################################# 2864#############################################################################
2865# the server's init and main functions
1985 2866
1986=head2 EXTENSION DATABASE SUPPORT 2867sub load_facedata($) {
2868 my ($path) = @_;
1987 2869
1988Crossfire maintains a very simple database for extension use. It can 2870 # HACK to clear player env face cache, we need some signal framework
1989currently store anything that can be serialised using Storable, which 2871 # for this (global event?)
1990excludes objects. 2872 %ext::player_env::MUSIC_FACE_CACHE = ();
1991 2873
1992The parameter C<$family> should best start with the name of the extension 2874 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1993using it, it should be unique.
1994 2875
1995=over 4 2876 warn "loading facedata from $path\n";
1996 2877
1997=item $hashref = cf::db_get $family 2878 my $facedata;
2879 0 < aio_load $path, $facedata
2880 or die "$path: $!";
1998 2881
1999Return a hashref for use by the extension C<$family>, which can be 2882 $facedata = Coro::Storable::thaw $facedata;
2000modified. After modifications, you have to call C<cf::db_dirty> or
2001C<cf::db_sync>.
2002 2883
2003=item $value = cf::db_get $family => $key 2884 $facedata->{version} == 2
2885 or cf::cleanup "$path: version mismatch, cannot proceed.";
2004 2886
2005Returns a single value from the database 2887 # patch in the exptable
2006 2888 $facedata->{resource}{"res/exp_table"} = {
2007=item cf::db_put $family => $hashref 2889 type => FT_RSRC,
2008 2890 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2009Stores the given family hashref into the database. Updates are delayed, if
2010you want the data to be synced to disk immediately, use C<cf::db_sync>.
2011
2012=item cf::db_put $family => $key => $value
2013
2014Stores the given C<$value> in the family hash. Updates are delayed, if you
2015want the data to be synced to disk immediately, use C<cf::db_sync>.
2016
2017=item cf::db_dirty
2018
2019Marks the database as dirty, to be updated at a later time.
2020
2021=item cf::db_sync
2022
2023Immediately write the database to disk I<if it is dirty>.
2024
2025=cut
2026
2027our $DB;
2028
2029{
2030 my $path = cf::localdir . "/database.pst";
2031
2032 sub db_load() {
2033 $DB = stat $path ? Storable::retrieve $path : { };
2034 }
2035
2036 my $pid;
2037
2038 sub db_save() {
2039 waitpid $pid, 0 if $pid;
2040 if (0 == ($pid = fork)) {
2041 $DB->{_meta}{version} = 1;
2042 Storable::nstore $DB, "$path~";
2043 rename "$path~", $path;
2044 cf::_exit 0 if defined $pid;
2045 }
2046 }
2047
2048 my $dirty;
2049
2050 sub db_sync() {
2051 db_save if $dirty;
2052 undef $dirty;
2053 }
2054
2055 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2056 db_sync;
2057 }); 2891 };
2892 cf::cede_to_tick;
2058 2893
2059 sub db_dirty() {
2060 $dirty = 1;
2061 $idle->start;
2062 } 2894 {
2895 my $faces = $facedata->{faceinfo};
2063 2896
2064 sub db_get($;$) { 2897 while (my ($face, $info) = each %$faces) {
2065 @_ >= 2 2898 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2066 ? $DB->{$_[0]}{$_[1]} 2899 cf::face::set_visibility $idx, $info->{visibility};
2067 : ($DB->{$_[0]} ||= { }) 2900 cf::face::set_magicmap $idx, $info->{magicmap};
2068 } 2901 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2902 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2069 2903
2070 sub db_put($$;$) { 2904 cf::cede_to_tick;
2071 if (@_ >= 3) {
2072 $DB->{$_[0]}{$_[1]} = $_[2];
2073 } else {
2074 $DB->{$_[0]} = $_[1];
2075 }
2076 db_dirty;
2077 }
2078
2079 cf::global->attach (
2080 prio => 10000,
2081 on_cleanup => sub {
2082 db_sync;
2083 }, 2905 }
2084 );
2085}
2086 2906
2087############################################################################# 2907 while (my ($face, $info) = each %$faces) {
2088# the server's main() 2908 next unless $info->{smooth};
2909 my $idx = cf::face::find $face
2910 or next;
2911 if (my $smooth = cf::face::find $info->{smooth}) {
2912 cf::face::set_smooth $idx, $smooth;
2913 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2914 } else {
2915 warn "smooth face '$info->{smooth}' not found for face '$face'";
2916 }
2089 2917
2090sub cfg_load { 2918 cf::cede_to_tick;
2919 }
2920 }
2921
2922 {
2923 my $anims = $facedata->{animinfo};
2924
2925 while (my ($anim, $info) = each %$anims) {
2926 cf::anim::set $anim, $info->{frames}, $info->{facings};
2927 cf::cede_to_tick;
2928 }
2929
2930 cf::anim::invalidate_all; # d'oh
2931 }
2932
2933 {
2934 # TODO: for gcfclient pleasure, we should give resources
2935 # that gcfclient doesn't grok a >10000 face index.
2936 my $res = $facedata->{resource};
2937
2938 my $soundconf = delete $res->{"res/sound.conf"};
2939
2940 while (my ($name, $info) = each %$res) {
2941 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2942 my $data;
2943
2944 if ($info->{type} & 1) {
2945 # prepend meta info
2946
2947 my $meta = $enc->encode ({
2948 name => $name,
2949 %{ $info->{meta} || {} },
2950 });
2951
2952 $data = pack "(w/a*)*", $meta, $info->{data};
2953 } else {
2954 $data = $info->{data};
2955 }
2956
2957 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2958 cf::face::set_type $idx, $info->{type};
2959
2960 cf::cede_to_tick;
2961 }
2962
2963 if ($soundconf) {
2964 $soundconf = $enc->decode (delete $soundconf->{data});
2965
2966 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2967 my $sound = $soundconf->{compat}[$_]
2968 or next;
2969
2970 my $face = cf::face::find "sound/$sound->[1]";
2971 cf::sound::set $sound->[0] => $face;
2972 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2973 }
2974
2975 while (my ($k, $v) = each %{$soundconf->{event}}) {
2976 my $face = cf::face::find "sound/$v";
2977 cf::sound::set $k => $face;
2978 }
2979 }
2980 }
2981
2982 1
2983}
2984
2985register_exticmd fx_want => sub {
2986 my ($ns, $want) = @_;
2987
2988 while (my ($k, $v) = each %$want) {
2989 $ns->fx_want ($k, $v);
2990 }
2991};
2992
2993sub reload_regions {
2994 # HACK to clear player env face cache, we need some signal framework
2995 # for this (global event?)
2996 %ext::player_env::MUSIC_FACE_CACHE = ();
2997
2998 load_resource_file "$MAPDIR/regions"
2999 or die "unable to load regions file\n";
3000
3001 for (cf::region::list) {
3002 $_->{match} = qr/$_->{match}/
3003 if exists $_->{match};
3004 }
3005}
3006
3007sub reload_facedata {
3008 load_facedata "$DATADIR/facedata"
3009 or die "unable to load facedata\n";
3010}
3011
3012sub reload_archetypes {
3013 load_resource_file "$DATADIR/archetypes"
3014 or die "unable to load archetypes\n";
3015 #d# NEED to laod twice to resolve forward references
3016 # this really needs to be done in an extra post-pass
3017 # (which needs to be synchronous, so solve it differently)
3018 load_resource_file "$DATADIR/archetypes"
3019 or die "unable to load archetypes\n";
3020}
3021
3022sub reload_treasures {
3023 load_resource_file "$DATADIR/treasures"
3024 or die "unable to load treasurelists\n";
3025}
3026
3027sub reload_resources {
3028 warn "reloading resource files...\n";
3029
3030 reload_regions;
3031 reload_facedata;
3032 #reload_archetypes;#d#
3033 reload_archetypes;
3034 reload_treasures;
3035
3036 warn "finished reloading resource files\n";
3037}
3038
3039sub init {
3040 reload_resources;
3041}
3042
3043sub reload_config {
2091 open my $fh, "<:utf8", cf::confdir . "/config" 3044 open my $fh, "<:utf8", "$CONFDIR/config"
2092 or return; 3045 or return;
2093 3046
2094 local $/; 3047 local $/;
2095 *CFG = YAML::Syck::Load <$fh>; 3048 *CFG = YAML::Syck::Load <$fh>;
2096 3049
2099 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3052 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2100 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3053 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2101 3054
2102 if (exists $CFG{mlockall}) { 3055 if (exists $CFG{mlockall}) {
2103 eval { 3056 eval {
2104 $CFG{mlockall} ? &mlockall : &munlockall 3057 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2105 and die "WARNING: m(un)lockall failed: $!\n"; 3058 and die "WARNING: m(un)lockall failed: $!\n";
2106 }; 3059 };
2107 warn $@ if $@; 3060 warn $@ if $@;
2108 } 3061 }
2109} 3062}
2110 3063
2111sub main { 3064sub main {
2112 # we must not ever block the main coroutine 3065 # we must not ever block the main coroutine
2113 local $Coro::idle = sub { 3066 local $Coro::idle = sub {
2114 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3067 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3068 (async {
2115 async { Event::one_event }; 3069 Event::one_event;
3070 })->prio (Coro::PRIO_MAX);
2116 }; 3071 };
2117 3072
2118 cfg_load; 3073 reload_config;
2119 db_load; 3074 db_init;
2120 load_extensions; 3075 load_extensions;
3076
3077 $TICK_WATCHER->start;
2121 Event::loop; 3078 Event::loop;
2122} 3079}
2123 3080
2124############################################################################# 3081#############################################################################
2125# initialisation 3082# initialisation and cleanup
2126 3083
3084# install some emergency cleanup handlers
3085BEGIN {
3086 for my $signal (qw(INT HUP TERM)) {
3087 Event->signal (
3088 reentrant => 0,
3089 data => WF_AUTOCANCEL,
3090 signal => $signal,
3091 prio => 0,
3092 cb => sub {
3093 cf::cleanup "SIG$signal";
3094 },
3095 );
3096 }
3097}
3098
3099sub write_runtime {
3100 my $runtime = "$LOCALDIR/runtime";
3101
3102 # first touch the runtime file to show we are still running:
3103 # the fsync below can take a very very long time.
3104
3105 IO::AIO::aio_utime $runtime, undef, undef;
3106
3107 my $guard = cf::lock_acquire "write_runtime";
3108
3109 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3110 or return;
3111
3112 my $value = $cf::RUNTIME + 90 + 10;
3113 # 10 is the runtime save interval, for a monotonic clock
3114 # 60 allows for the watchdog to kill the server.
3115
3116 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3117 and return;
3118
3119 # always fsync - this file is important
3120 aio_fsync $fh
3121 and return;
3122
3123 # touch it again to show we are up-to-date
3124 aio_utime $fh, undef, undef;
3125
3126 close $fh
3127 or return;
3128
3129 aio_rename "$runtime~", $runtime
3130 and return;
3131
3132 warn "runtime file written.\n";
3133
3134 1
3135}
3136
3137sub emergency_save() {
3138 my $freeze_guard = cf::freeze_mainloop;
3139
3140 warn "enter emergency perl save\n";
3141
3142 cf::sync_job {
3143 # use a peculiar iteration method to avoid tripping on perl
3144 # refcount bugs in for. also avoids problems with players
3145 # and maps saved/destroyed asynchronously.
3146 warn "begin emergency player save\n";
3147 for my $login (keys %cf::PLAYER) {
3148 my $pl = $cf::PLAYER{$login} or next;
3149 $pl->valid or next;
3150 $pl->save;
3151 }
3152 warn "end emergency player save\n";
3153
3154 warn "begin emergency map save\n";
3155 for my $path (keys %cf::MAP) {
3156 my $map = $cf::MAP{$path} or next;
3157 $map->valid or next;
3158 $map->save;
3159 }
3160 warn "end emergency map save\n";
3161
3162 warn "begin emergency database checkpoint\n";
3163 BDB::db_env_txn_checkpoint $DB_ENV;
3164 warn "end emergency database checkpoint\n";
3165 };
3166
3167 warn "leave emergency perl save\n";
3168}
3169
3170sub post_cleanup {
3171 my ($make_core) = @_;
3172
3173 warn Carp::longmess "post_cleanup backtrace"
3174 if $make_core;
3175}
3176
2127sub reload() { 3177sub do_reload_perl() {
2128 # can/must only be called in main 3178 # can/must only be called in main
2129 if ($Coro::current != $Coro::main) { 3179 if ($Coro::current != $Coro::main) {
2130 warn "can only reload from main coroutine\n"; 3180 warn "can only reload from main coroutine";
2131 return; 3181 return;
2132 } 3182 }
2133 3183
2134 warn "reloading..."; 3184 warn "reloading...";
2135 3185
2136 my $guard = freeze_mainloop; 3186 warn "entering sync_job";
3187
3188 cf::sync_job {
3189 cf::write_runtime; # external watchdog should not bark
2137 cf::emergency_save; 3190 cf::emergency_save;
3191 cf::write_runtime; # external watchdog should not bark
2138 3192
2139 eval { 3193 warn "syncing database to disk";
3194 BDB::db_env_txn_checkpoint $DB_ENV;
3195
2140 # if anything goes wrong in here, we should simply crash as we already saved 3196 # if anything goes wrong in here, we should simply crash as we already saved
2141 3197
2142 # cancel all watchers 3198 warn "cancelling all WF_AUTOCANCEL watchers";
2143 for (Event::all_watchers) { 3199 for (Event::all_watchers) {
2144 $_->cancel if $_->data & WF_AUTOCANCEL; 3200 $_->cancel if $_->data & WF_AUTOCANCEL;
2145 } 3201 }
2146 3202
3203 warn "flushing outstanding aio requests";
3204 for (;;) {
3205 BDB::flush;
3206 IO::AIO::flush;
3207 Coro::cede;
3208 last unless IO::AIO::nreqs || BDB::nreqs;
3209 warn "iterate...";
3210 }
3211
3212 ++$RELOAD;
3213
2147 # cancel all extension coros 3214 warn "cancelling all extension coros";
2148 $_->cancel for values %EXT_CORO; 3215 $_->cancel for values %EXT_CORO;
2149 %EXT_CORO = (); 3216 %EXT_CORO = ();
2150 3217
2151 # unload all extensions 3218 warn "removing commands";
2152 for (@exts) { 3219 %COMMAND = ();
3220
3221 warn "removing ext/exti commands";
3222 %EXTCMD = ();
3223 %EXTICMD = ();
3224
3225 warn "unloading/nuking all extensions";
3226 for my $pkg (@EXTS) {
2153 warn "unloading <$_>"; 3227 warn "... unloading $pkg";
2154 unload_extension $_; 3228
3229 if (my $cb = $pkg->can ("unload")) {
3230 eval {
3231 $cb->($pkg);
3232 1
3233 } or warn "$pkg unloaded, but with errors: $@";
2155 } 3234 }
2156 3235
3236 warn "... nuking $pkg";
3237 Symbol::delete_package $pkg;
3238 }
3239
2157 # unload all modules loaded from $LIBDIR 3240 warn "unloading all perl modules loaded from $LIBDIR";
2158 while (my ($k, $v) = each %INC) { 3241 while (my ($k, $v) = each %INC) {
2159 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3242 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2160 3243
2161 warn "removing <$k>"; 3244 warn "... unloading $k";
2162 delete $INC{$k}; 3245 delete $INC{$k};
2163 3246
2164 $k =~ s/\.pm$//; 3247 $k =~ s/\.pm$//;
2165 $k =~ s/\//::/g; 3248 $k =~ s/\//::/g;
2166 3249
2169 } 3252 }
2170 3253
2171 Symbol::delete_package $k; 3254 Symbol::delete_package $k;
2172 } 3255 }
2173 3256
2174 # sync database to disk
2175 cf::db_sync;
2176 IO::AIO::flush;
2177
2178 # get rid of safe::, as good as possible 3257 warn "getting rid of safe::, as good as possible";
2179 Symbol::delete_package "safe::$_" 3258 Symbol::delete_package "safe::$_"
2180 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3259 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2181 3260
2182 # remove register_script_function callbacks
2183 # TODO
2184
2185 # unload cf.pm "a bit" 3261 warn "unloading cf.pm \"a bit\"";
2186 delete $INC{"cf.pm"}; 3262 delete $INC{"cf.pm"};
3263 delete $INC{"cf/pod.pm"};
2187 3264
2188 # don't, removes xs symbols, too, 3265 # don't, removes xs symbols, too,
2189 # and global variables created in xs 3266 # and global variables created in xs
2190 #Symbol::delete_package __PACKAGE__; 3267 #Symbol::delete_package __PACKAGE__;
2191 3268
2192 # reload cf.pm 3269 warn "unload completed, starting to reload now";
3270
2193 warn "reloading cf.pm"; 3271 warn "reloading cf.pm";
2194 require cf; 3272 require cf;
2195 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3273 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2196 3274
2197 # load config and database again 3275 warn "loading config and database again";
2198 cf::cfg_load; 3276 cf::reload_config;
2199 cf::db_load;
2200 3277
2201 # load extensions
2202 warn "load extensions"; 3278 warn "loading extensions";
2203 cf::load_extensions; 3279 cf::load_extensions;
2204 3280
2205 # reattach attachments to objects 3281 warn "reattaching attachments to objects/players";
2206 warn "reattach"; 3282 _global_reattach; # objects, sockets
2207 _global_reattach; 3283 warn "reattaching attachments to maps";
2208 reattach $_ for values %MAP; 3284 reattach $_ for values %MAP;
2209 }; 3285 warn "reattaching attachments to players";
3286 reattach $_ for values %PLAYER;
2210 3287
2211 if ($@) { 3288 warn "leaving sync_job";
3289
3290 1
3291 } or do {
2212 warn $@; 3292 warn $@;
2213 warn "error while reloading, exiting."; 3293 warn "error while reloading, exiting.";
2214 exit 1; 3294 exit 1;
2215 } 3295 };
2216 3296
2217 warn "reloaded successfully"; 3297 warn "reloaded";
2218}; 3298};
2219 3299
2220############################################################################# 3300our $RELOAD_WATCHER; # used only during reload
2221 3301
2222unless ($LINK_MAP) { 3302sub reload_perl() {
2223 $LINK_MAP = cf::map::new; 3303 # doing reload synchronously and two reloads happen back-to-back,
3304 # coro crashes during coro_state_free->destroy here.
2224 3305
2225 $LINK_MAP->width (41); 3306 $RELOAD_WATCHER ||= Event->timer (
2226 $LINK_MAP->height (41); 3307 reentrant => 0,
2227 $LINK_MAP->alloc;
2228 $LINK_MAP->path ("{link}");
2229 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2230 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2231
2232 # dirty hack because... archetypes are not yet loaded
2233 Event->timer (
2234 after => 10, 3308 after => 0,
3309 data => WF_AUTOCANCEL,
2235 cb => sub { 3310 cb => sub {
2236 $_[0]->w->cancel; 3311 do_reload_perl;
2237 3312 undef $RELOAD_WATCHER;
2238 # provide some exits "home"
2239 my $exit = cf::object::new "exit";
2240
2241 $exit->slaying ($EMERGENCY_POSITION->[0]);
2242 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2243 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2244
2245 $LINK_MAP->insert ($exit->clone, 19, 19);
2246 $LINK_MAP->insert ($exit->clone, 19, 20);
2247 $LINK_MAP->insert ($exit->clone, 19, 21);
2248 $LINK_MAP->insert ($exit->clone, 20, 19);
2249 $LINK_MAP->insert ($exit->clone, 20, 21);
2250 $LINK_MAP->insert ($exit->clone, 21, 19);
2251 $LINK_MAP->insert ($exit->clone, 21, 20);
2252 $LINK_MAP->insert ($exit->clone, 21, 21);
2253
2254 $exit->destroy;
2255 }); 3313 },
2256 3314 );
2257 $LINK_MAP->{deny_save} = 1;
2258 $LINK_MAP->{deny_reset} = 1;
2259
2260 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2261} 3315}
2262
2263register "<global>", __PACKAGE__;
2264 3316
2265register_command "reload" => sub { 3317register_command "reload" => sub {
2266 my ($who, $arg) = @_; 3318 my ($who, $arg) = @_;
2267 3319
2268 if ($who->flag (FLAG_WIZ)) { 3320 if ($who->flag (FLAG_WIZ)) {
2269 $who->message ("start of reload.");
2270 reload;
2271 $who->message ("end of reload."); 3321 $who->message ("reloading server.");
3322 async { reload_perl };
2272 } 3323 }
2273}; 3324};
2274 3325
2275unshift @INC, $LIBDIR; 3326unshift @INC, $LIBDIR;
2276 3327
3328my $bug_warning = 0;
3329
3330our @WAIT_FOR_TICK;
3331our @WAIT_FOR_TICK_BEGIN;
3332
3333sub wait_for_tick {
3334 return unless $TICK_WATCHER->is_active;
3335 return if $Coro::current == $Coro::main;
3336
3337 my $signal = new Coro::Signal;
3338 push @WAIT_FOR_TICK, $signal;
3339 $signal->wait;
3340}
3341
3342sub wait_for_tick_begin {
3343 return unless $TICK_WATCHER->is_active;
3344 return if $Coro::current == $Coro::main;
3345
3346 my $signal = new Coro::Signal;
3347 push @WAIT_FOR_TICK_BEGIN, $signal;
3348 $signal->wait;
3349}
3350
3351 my $min = 1e6;#d#
3352 my $avg = 10;
2277$TICK_WATCHER = Event->timer ( 3353$TICK_WATCHER = Event->timer (
2278 reentrant => 0, 3354 reentrant => 0,
3355 parked => 1,
2279 prio => 0, 3356 prio => 0,
2280 at => $NEXT_TICK || $TICK, 3357 at => $NEXT_TICK || $TICK,
2281 data => WF_AUTOCANCEL, 3358 data => WF_AUTOCANCEL,
2282 cb => sub { 3359 cb => sub {
3360 if ($Coro::current != $Coro::main) {
3361 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3362 unless ++$bug_warning > 10;
3363 return;
3364 }
3365
3366 $NOW = $tick_start = Event::time;
3367
2283 cf::server_tick; # one server iteration 3368 cf::server_tick; # one server iteration
3369
3370 0 && sync_job {#d#
3371 for(1..10) {
3372 my $t = Event::time;
3373 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3374 or die;
3375
3376 $map->width (50);
3377 $map->height (50);
3378 $map->alloc;
3379 $map->_load_objects ("/tmp/x.map", 1);
3380 my $t = Event::time - $t;
3381
3382 #next unless $t < 0.0013;#d#
3383 if ($t < $min) {
3384 $min = $t;
3385 }
3386 $avg = $avg * 0.99 + $t * 0.01;
3387 }
3388 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3389 exit 0;
3390 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3391 };
3392
2284 $RUNTIME += $TICK; 3393 $RUNTIME += $TICK;
2285 $NEXT_TICK += $TICK; 3394 $NEXT_TICK += $TICK;
2286 3395
3396 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3397 $NEXT_RUNTIME_WRITE = $NOW + 10;
3398 Coro::async_pool {
3399 write_runtime
3400 or warn "ERROR: unable to write runtime file: $!";
3401 };
3402 }
3403
3404# my $AFTER = Event::time;
3405# warn $AFTER - $NOW;#d#
3406
3407 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3408 $sig->send;
3409 }
3410 while (my $sig = shift @WAIT_FOR_TICK) {
3411 $sig->send;
3412 }
3413
3414 $NOW = Event::time;
3415
2287 # if we are delayed by four ticks or more, skip them all 3416 # if we are delayed by four ticks or more, skip them all
2288 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3417 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2289 3418
2290 $TICK_WATCHER->at ($NEXT_TICK); 3419 $TICK_WATCHER->at ($NEXT_TICK);
2291 $TICK_WATCHER->start; 3420 $TICK_WATCHER->start;
3421
3422 $LOAD = ($NOW - $tick_start) / $TICK;
3423 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3424
3425 _post_tick;
3426
3427
2292 }, 3428 },
2293); 3429);
2294 3430
3431{
2295IO::AIO::max_poll_time $TICK * 0.2; 3432 BDB::max_poll_time $TICK * 0.1;
2296 3433 $BDB_POLL_WATCHER = Event->io (
2297Event->io ( 3434 reentrant => 0,
2298 fd => IO::AIO::poll_fileno, 3435 fd => BDB::poll_fileno,
2299 poll => 'r', 3436 poll => 'r',
2300 prio => 5, 3437 prio => 0,
2301 data => WF_AUTOCANCEL,
2302 cb => \&IO::AIO::poll_cb,
2303);
2304
2305Event->timer (
2306 data => WF_AUTOCANCEL, 3438 data => WF_AUTOCANCEL,
2307 after => 0, 3439 cb => \&BDB::poll_cb,
2308 interval => 10, 3440 );
2309 cb => sub { 3441 BDB::min_parallel 8;
2310 (Coro::unblock_sub { 3442
2311 write_runtime 3443 BDB::set_sync_prepare {
2312 or warn "ERROR: unable to write runtime file: $!"; 3444 my $status;
3445 my $current = $Coro::current;
3446 (
3447 sub {
3448 $status = $!;
3449 $current->ready; undef $current;
3450 },
3451 sub {
3452 Coro::schedule while defined $current;
3453 $! = $status;
3454 },
3455 )
3456 };
3457
3458 unless ($DB_ENV) {
3459 $DB_ENV = BDB::db_env_create;
3460
3461 cf::sync_job {
3462 eval {
3463 BDB::db_env_open
3464 $DB_ENV,
3465 $BDBDIR,
3466 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3467 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3468 0666;
3469
3470 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3471
3472 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3473 $DB_ENV->set_lk_detect;
3474 };
3475
3476 cf::cleanup "db_env_open(db): $@" if $@;
2313 })->(); 3477 };
2314 }, 3478 }
2315); 3479}
3480
3481{
3482 IO::AIO::min_parallel 8;
3483
3484 undef $Coro::AIO::WATCHER;
3485 IO::AIO::max_poll_time $TICK * 0.1;
3486 $AIO_POLL_WATCHER = Event->io (
3487 reentrant => 0,
3488 data => WF_AUTOCANCEL,
3489 fd => IO::AIO::poll_fileno,
3490 poll => 'r',
3491 prio => 6,
3492 cb => \&IO::AIO::poll_cb,
3493 );
3494}
3495
3496my $_log_backtrace;
3497
3498sub _log_backtrace {
3499 my ($msg, @addr) = @_;
3500
3501 $msg =~ s/\n//;
3502
3503 # limit the # of concurrent backtraces
3504 if ($_log_backtrace < 2) {
3505 ++$_log_backtrace;
3506 async {
3507 my @bt = fork_call {
3508 @addr = map { sprintf "%x", $_ } @addr;
3509 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3510 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3511 or die "addr2line: $!";
3512
3513 my @funcs;
3514 my @res = <$fh>;
3515 chomp for @res;
3516 while (@res) {
3517 my ($func, $line) = splice @res, 0, 2, ();
3518 push @funcs, "[$func] $line";
3519 }
3520
3521 @funcs
3522 };
3523
3524 LOG llevInfo, "[ABT] $msg\n";
3525 LOG llevInfo, "[ABT] $_\n" for @bt;
3526 --$_log_backtrace;
3527 };
3528 } else {
3529 LOG llevInfo, "[ABT] $msg\n";
3530 LOG llevInfo, "[ABT] [suppressed]\n";
3531 }
3532}
3533
3534# load additional modules
3535use cf::pod;
2316 3536
2317END { cf::emergency_save } 3537END { cf::emergency_save }
2318 3538
23191 35391
2320 3540

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines