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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines