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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines