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.147 by root, Mon Jan 8 12:23:33 2007 UTC vs.
Revision 1.362 by root, Mon Sep 10 12:44:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines