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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines