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.150 by root, Mon Jan 8 19:25:53 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines