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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.360 by root, Sun Sep 9 06:25:46 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines