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.132 by root, Thu Jan 4 01:35:56 2007 UTC vs.
Revision 1.356 by root, Tue Sep 4 05:43:21 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines