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.162 by root, Thu Jan 11 00:41:08 2007 UTC vs.
Revision 1.361 by root, Sun Sep 9 12:52:48 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
478 $path
479}
480
481# the original (read-only) location
482sub load_path {
483 my ($self) = @_;
484
485 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
486}
487
488# the temporary/swap location
489sub save_path {
490 my ($self) = @_;
491
492 $self->{user_rel}
493 ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
494 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
495}
496
497# the unique path, undef == no special unique path
498sub uniq_path {
499 my ($self) = @_;
500
501 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
502}
503
504# this is somewhat ugly, but style maps do need special treatment
505sub is_style_map {
506 $_[0]{path} =~ m{^/styles/}
507}
508
509sub load_orig {
510 my ($self) = @_;
511
512 &cf::map::load_map_header ($self->load_path)
513}
514
515sub load_temp {
516 my ($self) = @_;
517
518 &cf::map::load_map_header ($self->save_path)
519}
520
521package cf;
522 634
523############################################################################# 635#############################################################################
524 636
525=head2 ATTACHABLE OBJECTS 637=head2 ATTACHABLE OBJECTS
526 638
528attach callbacks/event handlers (a collection of which is called an "attachment") 640attach callbacks/event handlers (a collection of which is called an "attachment")
529to it. All such attachable objects support the following methods. 641to it. All such attachable objects support the following methods.
530 642
531In 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>
532C<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
533crossfire+). 645Crossfire TRT).
534 646
535=over 4 647=over 4
536 648
537=item $attachable->attach ($attachment, key => $value...) 649=item $attachable->attach ($attachment, key => $value...)
538 650
652our @CB_TYPE = (); # registry for type (cf-object class) based events 764our @CB_TYPE = (); # registry for type (cf-object class) based events
653our @CB_MAP = (); 765our @CB_MAP = ();
654 766
655my %attachment; 767my %attachment;
656 768
769sub cf::attachable::thawer_merge {
770 # simply override everything except _meta
771 local $_[0]{_meta};
772 %{$_[0]} = %{$_[1]};
773}
774
657sub _attach_cb($$$$) { 775sub _attach_cb($$$$) {
658 my ($registry, $event, $prio, $cb) = @_; 776 my ($registry, $event, $prio, $cb) = @_;
659 777
660 use sort 'stable'; 778 use sort 'stable';
661 779
695 $registry = $CB_TYPE[$object_type] ||= []; 813 $registry = $CB_TYPE[$object_type] ||= [];
696 814
697 } elsif ($type eq "subtype") { 815 } elsif ($type eq "subtype") {
698 defined $object_type or Carp::croak "subtype specified without type"; 816 defined $object_type or Carp::croak "subtype specified without type";
699 my $object_subtype = shift @arg; 817 my $object_subtype = shift @arg;
700 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 818 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
701 819
702 } elsif ($type eq "package") { 820 } elsif ($type eq "package") {
703 my $pkg = shift @arg; 821 my $pkg = shift @arg;
704 822
705 while (my ($name, $id) = each %cb_id) { 823 while (my ($name, $id) = each %cb_id) {
734 _attach $registry, $klass, @attach; 852 _attach $registry, $klass, @attach;
735 } 853 }
736 854
737 $obj->{$name} = \%arg; 855 $obj->{$name} = \%arg;
738 } else { 856 } else {
739 warn "object uses attachment '$name' that is not available, postponing.\n"; 857 warn "object uses attachment '$name' which is not available, postponing.\n";
740 } 858 }
741 859
742 $obj->{_attachment}{$name} = undef; 860 $obj->{_attachment}{$name} = undef;
743} 861}
744 862
746 if (ref $_[0]) { 864 if (ref $_[0]) {
747 _object_attach @_; 865 _object_attach @_;
748 } else { 866 } else {
749 _attach shift->_attach_registry, @_; 867 _attach shift->_attach_registry, @_;
750 } 868 }
869 _recalc_want;
751}; 870};
752 871
753# all those should be optimised 872# all those should be optimised
754sub cf::attachable::detach { 873sub cf::attachable::detach {
755 my ($obj, $name) = @_; 874 my ($obj, $name) = @_;
758 delete $obj->{_attachment}{$name}; 877 delete $obj->{_attachment}{$name};
759 reattach ($obj); 878 reattach ($obj);
760 } else { 879 } else {
761 Carp::croak "cannot, currently, detach class attachments"; 880 Carp::croak "cannot, currently, detach class attachments";
762 } 881 }
882 _recalc_want;
763}; 883};
764 884
765sub cf::attachable::attached { 885sub cf::attachable::attached {
766 my ($obj, $name) = @_; 886 my ($obj, $name) = @_;
767 887
782 "; 902 ";
783 die if $@; 903 die if $@;
784} 904}
785 905
786our $override; 906our $override;
787our @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?
788 908
789sub override { 909sub override {
790 $override = 1; 910 $override = 1;
791 @invoke_results = (); 911 @INVOKE_RESULTS = (@_);
792} 912}
793 913
794sub do_invoke { 914sub do_invoke {
795 my $event = shift; 915 my $event = shift;
796 my $callbacks = shift; 916 my $callbacks = shift;
797 917
798 @invoke_results = (); 918 @INVOKE_RESULTS = ();
799 919
800 local $override; 920 local $override;
801 921
802 for (@$callbacks) { 922 for (@$callbacks) {
803 eval { &{$_->[1]} }; 923 eval { &{$_->[1]} };
820 940
821Generate an object-specific event with the given arguments. 941Generate an object-specific event with the given arguments.
822 942
823This 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
824removed 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
825results (if you must, access C<@cf::invoke_results> directly). 945results (if you must, access C<@cf::INVOKE_RESULTS> directly).
826 946
827=back 947=back
828 948
829=cut 949=cut
830 950
831############################################################################# 951#############################################################################
832# 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}
833 964
834sub reattach { 965sub reattach {
835 # basically do the same as instantiate, without calling instantiate 966 # basically do the same as instantiate, without calling instantiate
836 my ($obj) = @_; 967 my ($obj) = @_;
968
969 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
837 970
838 my $registry = $obj->registry; 971 my $registry = $obj->registry;
839 972
840 @$registry = (); 973 @$registry = ();
841 974
880); 1013);
881 1014
882sub object_freezer_save { 1015sub object_freezer_save {
883 my ($filename, $rdata, $objs) = @_; 1016 my ($filename, $rdata, $objs) = @_;
884 1017
1018 my $guard = cf::lock_acquire "io";
1019
885 sync_job { 1020 sync_job {
886 if (length $$rdata) { 1021 if (length $$rdata) {
887 warn sprintf "saving %s (%d,%d)\n", 1022 warn sprintf "saving %s (%d,%d)\n",
888 $filename, length $$rdata, scalar @$objs; 1023 $filename, length $$rdata, scalar @$objs;
889 1024
890 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1025 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
891 chmod SAVE_MODE, $fh; 1026 chmod SAVE_MODE, $fh;
892 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1027 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
893 aio_fsync $fh; 1028 aio_fsync $fh if $cf::USE_FSYNC;
894 close $fh; 1029 close $fh;
895 1030
896 if (@$objs) { 1031 if (@$objs) {
897 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) {
898 chmod SAVE_MODE, $fh; 1033 chmod SAVE_MODE, $fh;
899 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1034 my $data = Storable::nfreeze { version => 1, objs => $objs };
900 aio_write $fh, 0, (length $data), $data, 0; 1035 aio_write $fh, 0, (length $data), $data, 0;
901 aio_fsync $fh; 1036 aio_fsync $fh if $cf::USE_FSYNC;
902 close $fh; 1037 close $fh;
903 aio_rename "$filename.pst~", "$filename.pst"; 1038 aio_rename "$filename.pst~", "$filename.pst";
904 } 1039 }
905 } else { 1040 } else {
906 aio_unlink "$filename.pst"; 1041 aio_unlink "$filename.pst";
912 } 1047 }
913 } else { 1048 } else {
914 aio_unlink $filename; 1049 aio_unlink $filename;
915 aio_unlink "$filename.pst"; 1050 aio_unlink "$filename.pst";
916 } 1051 }
917 } 1052 };
1053
1054 undef $guard;
918} 1055}
919 1056
920sub object_freezer_as_string { 1057sub object_freezer_as_string {
921 my ($rdata, $objs) = @_; 1058 my ($rdata, $objs) = @_;
922 1059
927 1064
928sub object_thawer_load { 1065sub object_thawer_load {
929 my ($filename) = @_; 1066 my ($filename) = @_;
930 1067
931 my ($data, $av); 1068 my ($data, $av);
1069
1070 my $guard = cf::lock_acquire "io";
932 1071
933 (aio_load $filename, $data) >= 0 1072 (aio_load $filename, $data) >= 0
934 or return; 1073 or return;
935 1074
936 unless (aio_stat "$filename.pst") { 1075 unless (aio_stat "$filename.pst") {
937 (aio_load "$filename.pst", $av) >= 0 1076 (aio_load "$filename.pst", $av) >= 0
938 or return; 1077 or return;
1078
1079 undef $guard;
939 $av = eval { (Storable::thaw $av)->{objs} }; 1080 $av = eval { (Storable::thaw $av)->{objs} };
940 } 1081 }
941 1082
942 warn sprintf "loading %s (%d)\n", 1083 warn sprintf "loading %s (%d)\n",
943 $filename, length $data, scalar @{$av || []};#d# 1084 $filename, length $data, scalar @{$av || []};
1085
944 return ($data, $av); 1086 ($data, $av)
945} 1087}
1088
1089=head2 COMMAND CALLBACKS
1090
1091=over 4
1092
1093=cut
946 1094
947############################################################################# 1095#############################################################################
948# command handling &c 1096# command handling &c
949 1097
950=item cf::register_command $name => \&callback($ob,$args); 1098=item cf::register_command $name => \&callback($ob,$args);
963 push @{ $COMMAND{$name} }, [$caller, $cb]; 1111 push @{ $COMMAND{$name} }, [$caller, $cb];
964} 1112}
965 1113
966=item cf::register_extcmd $name => \&callback($pl,$packet); 1114=item cf::register_extcmd $name => \&callback($pl,$packet);
967 1115
968Register 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.
969 1121
970If 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
971called. 1123called.
972 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
973=cut 1136=cut
974 1137
975sub register_extcmd { 1138sub register_extcmd {
976 my ($name, $cb) = @_; 1139 my ($name, $cb) = @_;
977 1140
978 $EXTCMD{$name} = $cb; 1141 $EXTCMD{$name} = $cb;
1142}
1143
1144sub register_exticmd {
1145 my ($name, $cb) = @_;
1146
1147 $EXTICMD{$name} = $cb;
979} 1148}
980 1149
981cf::player->attach ( 1150cf::player->attach (
982 on_command => sub { 1151 on_command => sub {
983 my ($pl, $name, $params) = @_; 1152 my ($pl, $name, $params) = @_;
992 cf::override; 1161 cf::override;
993 }, 1162 },
994 on_extcmd => sub { 1163 on_extcmd => sub {
995 my ($pl, $buf) = @_; 1164 my ($pl, $buf) = @_;
996 1165
997 my $msg = eval { from_json $buf }; 1166 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
998 1167
999 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
1000 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1176 if (my $cb = $EXTCMD{$type}) {
1001 if (my %reply = $cb->($pl, $msg)) { 1177 @reply = $cb->($pl, @payload);
1002 $pl->ext_reply ($msg->{msgid}, %reply);
1003 }
1004 } 1178 }
1179
1180 $pl->ext_reply ($reply, @reply)
1181 if $reply;
1182
1005 } else { 1183 } else {
1006 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1184 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1007 } 1185 }
1008 1186
1009 cf::override; 1187 cf::override;
1010 }, 1188 },
1011); 1189);
1012 1190
1013sub load_extension {
1014 my ($path) = @_;
1015
1016 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1017 my $base = $1;
1018 my $pkg = $1;
1019 $pkg =~ s/[^[:word:]]/_/g;
1020 $pkg = "ext::$pkg";
1021
1022 warn "... loading '$path' into '$pkg'\n";
1023
1024 open my $fh, "<:utf8", $path
1025 or die "$path: $!";
1026
1027 my $source =
1028 "package $pkg; use strict; use utf8;\n"
1029 . "#line 1 \"$path\"\n{\n"
1030 . (do { local $/; <$fh> })
1031 . "\n};\n1";
1032
1033 eval $source
1034 or die $@ ? "$path: $@\n"
1035 : "extension disabled.\n";
1036
1037 push @EXTS, $pkg;
1038}
1039
1040sub load_extensions { 1191sub load_extensions {
1192 cf::sync_job {
1193 my %todo;
1194
1041 for my $ext (<$LIBDIR/*.ext>) { 1195 for my $path (<$LIBDIR/*.ext>) {
1042 next unless -r $ext; 1196 next unless -r $path;
1043 eval { 1197
1044 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;
1045 1 1255 }
1046 } or warn "$ext not loaded: $@"; 1256
1257 skip:
1258 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1259 unless $progress;
1260 }
1047 } 1261 };
1048} 1262}
1049 1263
1050############################################################################# 1264#############################################################################
1051# load/save/clean perl data associated with a map
1052 1265
1053*cf::mapsupport::on_clean = sub { 1266=back
1054 my ($map) = @_;
1055
1056 my $path = $map->tmpname;
1057 defined $path or return;
1058
1059 unlink "$path.pst";
1060};
1061
1062cf::map->attach (prio => -10000, package => cf::mapsupport::);
1063
1064#############################################################################
1065 1267
1066=head2 CORE EXTENSIONS 1268=head2 CORE EXTENSIONS
1067 1269
1068Functions and methods that extend core crossfire objects. 1270Functions and methods that extend core crossfire objects.
1069 1271
1075 1277
1076=head3 cf::player 1278=head3 cf::player
1077 1279
1078=over 4 1280=over 4
1079 1281
1282=item cf::player::num_playing
1283
1284Returns the official number of playing players, as per the Crossfire metaserver rules.
1285
1286=cut
1287
1288sub num_playing {
1289 scalar grep
1290 $_->ob->map
1291 && !$_->hidden
1292 && !$_->ob->flag (cf::FLAG_WIZ),
1293 cf::player::list
1294}
1295
1080=item cf::player::find $login 1296=item cf::player::find $login
1081 1297
1082Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
1083 1299
1084=cut 1300=cut
1085 1301
1086sub playerdir($) { 1302sub playerdir($) {
1087 cf::localdir 1303 "$PLAYERDIR/"
1088 . "/"
1089 . cf::playerdir
1090 . "/"
1091 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1092} 1305}
1093 1306
1094sub path($) { 1307sub path($) {
1095 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1096 1309
1097 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
1098} 1311}
1099 1312
1100sub find_active($) { 1313sub find_active($) {
1101 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
1102 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
1105 1318
1106sub exists($) { 1319sub exists($) {
1107 my ($login) = @_; 1320 my ($login) = @_;
1108 1321
1109 $cf::PLAYER{$login} 1322 $cf::PLAYER{$login}
1110 or cf::sync_job { !aio_stat $login } 1323 or cf::sync_job { !aio_stat path $login }
1111} 1324}
1112 1325
1113sub find($) { 1326sub find($) {
1114 return $cf::PLAYER{$_[0]} || do { 1327 return $cf::PLAYER{$_[0]} || do {
1115 my $login = $_[0]; 1328 my $login = $_[0];
1116 1329
1117 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
1118 1331
1119 $cf::PLAYER{$_[0]} || do { 1332 $cf::PLAYER{$_[0]} || do {
1120 my $pl = load_pl path $login 1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
1340 my $f = new_from_file cf::object::thawer path $login
1121 or return; 1341 or return;
1342
1343 $f->next;
1344 my $pl = cf::player::load_pl $f
1345 or return;
1346 local $cf::PLAYER_LOADING{$login} = $pl;
1347 $f->resolve_delayed_derefs;
1122 $cf::PLAYER{$login} = $pl 1348 $cf::PLAYER{$login} = $pl
1123 } 1349 }
1124 } 1350 }
1125} 1351}
1126 1352
1136 1362
1137 aio_mkdir playerdir $pl, 0770; 1363 aio_mkdir playerdir $pl, 0770;
1138 $pl->{last_save} = $cf::RUNTIME; 1364 $pl->{last_save} = $cf::RUNTIME;
1139 1365
1140 $pl->save_pl ($path); 1366 $pl->save_pl ($path);
1141 Coro::cede; 1367 cf::cede_to_tick;
1142} 1368}
1143 1369
1144sub new($) { 1370sub new($) {
1145 my ($login) = @_; 1371 my ($login) = @_;
1146 1372
1152 $cf::PLAYER{$login} = $self; 1378 $cf::PLAYER{$login} = $self;
1153 1379
1154 $self 1380 $self
1155} 1381}
1156 1382
1383=item $player->send_msg ($channel, $msg, $color, [extra...])
1384
1385=cut
1386
1387sub send_msg {
1388 my $ns = shift->ns
1389 or return;
1390 $ns->send_msg (@_);
1391}
1392
1157=item $pl->quit_character 1393=item $pl->quit_character
1158 1394
1159Nukes the player without looking back. If logged in, the connection will 1395Nukes the player without looking back. If logged in, the connection will
1160be destroyed. May block for a long time. 1396be destroyed. May block for a long time.
1161 1397
1162=cut 1398=cut
1163 1399
1164sub quit_character { 1400sub quit_character {
1165 my ($pl) = @_; 1401 my ($pl) = @_;
1402
1403 my $name = $pl->ob->name;
1166 1404
1167 $pl->{deny_save} = 1; 1405 $pl->{deny_save} = 1;
1168 $pl->password ("*"); # this should lock out the player until we nuked the dir 1406 $pl->password ("*"); # this should lock out the player until we nuked the dir
1169 1407
1170 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1408 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1175 my $path = playerdir $pl; 1413 my $path = playerdir $pl;
1176 my $temp = "$path~$cf::RUNTIME~deleting~"; 1414 my $temp = "$path~$cf::RUNTIME~deleting~";
1177 aio_rename $path, $temp; 1415 aio_rename $path, $temp;
1178 delete $cf::PLAYER{$pl->ob->name}; 1416 delete $cf::PLAYER{$pl->ob->name};
1179 $pl->destroy; 1417 $pl->destroy;
1418
1419 my $prefix = qr<^~\Q$name\E/>;
1420
1421 # nuke player maps
1422 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1423
1180 IO::AIO::aio_rmtree $temp; 1424 IO::AIO::aio_rmtree $temp;
1425}
1426
1427=item $pl->kick
1428
1429Kicks a player out of the game. This destroys the connection.
1430
1431=cut
1432
1433sub kick {
1434 my ($pl, $kicker) = @_;
1435
1436 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1437 $pl->killer ("kicked");
1438 $pl->ns->destroy;
1181} 1439}
1182 1440
1183=item cf::player::list_logins 1441=item cf::player::list_logins
1184 1442
1185Returns am arrayref of all valid playernames in the system, can take a 1443Returns am arrayref of all valid playernames in the system, can take a
1186while and may block, so not sync_job-capable, ever. 1444while and may block, so not sync_job-capable, ever.
1187 1445
1188=cut 1446=cut
1189 1447
1190sub list_logins { 1448sub list_logins {
1191 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1449 my $dirs = aio_readdir $PLAYERDIR
1192 or return []; 1450 or return [];
1193 1451
1194 my @logins; 1452 my @logins;
1195 1453
1196 for my $login (@$dirs) { 1454 for my $login (@$dirs) {
1455 my $path = path $login;
1456
1457 # a .pst is a dead give-away for a valid player
1458 unless (-e "$path.pst") {
1197 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1459 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1198 aio_read $fh, 0, 512, my $buf, 0 or next; 1460 aio_read $fh, 0, 512, my $buf, 0 or next;
1199 $buf !~ /^password -------------$/m or next; # official not-valid tag 1461 $buf !~ /^password -------------$/m or next; # official not-valid tag
1462 }
1200 1463
1201 utf8::decode $login; 1464 utf8::decode $login;
1202 push @logins, $login; 1465 push @logins, $login;
1203 } 1466 }
1204 1467
1205 \@logins 1468 \@logins
1206} 1469}
1207 1470
1208=item $player->maps 1471=item $player->maps
1209 1472
1210Returns an arrayref of cf::path's of all maps that are private for this 1473Returns an arrayref of map paths that are private for this
1211player. May block. 1474player. May block.
1212 1475
1213=cut 1476=cut
1214 1477
1215sub maps($) { 1478sub maps($) {
1216 my ($pl) = @_; 1479 my ($pl) = @_;
1480
1481 $pl = ref $pl ? $pl->ob->name : $pl;
1217 1482
1218 my $files = aio_readdir playerdir $pl 1483 my $files = aio_readdir playerdir $pl
1219 or return; 1484 or return;
1220 1485
1221 my @paths; 1486 my @paths;
1223 for (@$files) { 1488 for (@$files) {
1224 utf8::decode $_; 1489 utf8::decode $_;
1225 next if /\.(?:pl|pst)$/; 1490 next if /\.(?:pl|pst)$/;
1226 next unless /^$PATH_SEP/o; 1491 next unless /^$PATH_SEP/o;
1227 1492
1228 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; 1493 push @paths, cf::map::normalise "~$pl/$_";
1229 } 1494 }
1230 1495
1231 \@paths 1496 \@paths
1232} 1497}
1233 1498
1499=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1500
1501Expand crossfire pod fragments into protocol xml.
1502
1503=cut
1504
1505sub expand_cfpod {
1506 ((my $self), (local $_)) = @_;
1507
1508 # escape & and <
1509 s/&/&amp;/g;
1510 s/(?<![BIUGHT])</&lt;/g;
1511
1512 # this is buggy, it needs to properly take care of nested <'s
1513
1514 1 while
1515 # replace B<>, I<>, U<> etc.
1516 s/B<([^\>]*)>/<b>$1<\/b>/
1517 || s/I<([^\>]*)>/<i>$1<\/i>/
1518 || s/U<([^\>]*)>/<u>$1<\/u>/
1519 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1520 # replace G<male|female> tags
1521 || s{G<([^>|]*)\|([^>]*)>}{
1522 $self->gender ? $2 : $1
1523 }ge
1524 # replace H<hint text>
1525 || s{H<([^\>]*)>}
1526 {
1527 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1528 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1529 "")
1530 [$self->{hintmode}]
1531 }ge;
1532
1533 # create single paragraphs (very hackish)
1534 s/(?<=\S)\n(?=\w)/ /g;
1535
1536 # compress some whitespace
1537 s/\s+\n/\n/g; # ws line-ends
1538 s/\n\n+/\n/g; # double lines
1539 s/^\n+//; # beginning lines
1540 s/\n+$//; # ending lines
1541
1542 $_
1543}
1544
1545sub hintmode {
1546 $_[0]{hintmode} = $_[1] if @_ > 1;
1547 $_[0]{hintmode}
1548}
1549
1234=item $player->ext_reply ($msgid, $msgtype, %msg) 1550=item $player->ext_reply ($msgid, @msg)
1235 1551
1236Sends an ext reply to the player. 1552Sends an ext reply to the player.
1237 1553
1238=cut 1554=cut
1239 1555
1240sub ext_reply($$$%) { 1556sub ext_reply($$@) {
1241 my ($self, $id, %msg) = @_; 1557 my ($self, $id, @msg) = @_;
1242 1558
1243 $msg{msgid} = $id; 1559 $self->ns->ext_reply ($id, @msg)
1244
1245 $self->send ("ext " . cf::to_json \%msg);
1246} 1560}
1247 1561
1248package cf; 1562=item $player->ext_msg ($type, @msg)
1563
1564Sends an ext event to the client.
1565
1566=cut
1567
1568sub ext_msg($$@) {
1569 my ($self, $type, @msg) = @_;
1570
1571 $self->ns->ext_msg ($type, @msg);
1572}
1573
1574=head3 cf::region
1575
1576=over 4
1577
1578=cut
1579
1580package cf::region;
1581
1582=item cf::region::find_by_path $path
1583
1584Tries to decuce the likely region for a map knowing only its path.
1585
1586=cut
1587
1588sub find_by_path($) {
1589 my ($path) = @_;
1590
1591 my ($match, $specificity);
1592
1593 for my $region (list) {
1594 if ($region->{match} && $path =~ $region->{match}) {
1595 ($match, $specificity) = ($region, $region->specificity)
1596 if $region->specificity > $specificity;
1597 }
1598 }
1599
1600 $match
1601}
1249 1602
1250=back 1603=back
1251
1252 1604
1253=head3 cf::map 1605=head3 cf::map
1254 1606
1255=over 4 1607=over 4
1256 1608
1259package cf::map; 1611package cf::map;
1260 1612
1261use Fcntl; 1613use Fcntl;
1262use Coro::AIO; 1614use Coro::AIO;
1263 1615
1616use overload
1617 '""' => \&as_string,
1618 fallback => 1;
1619
1264our $MAX_RESET = 3600; 1620our $MAX_RESET = 3600;
1265our $DEFAULT_RESET = 3000; 1621our $DEFAULT_RESET = 3000;
1266 1622
1267sub generate_random_map { 1623sub generate_random_map {
1268 my ($path, $rmp) = @_; 1624 my ($self, $rmp) = @_;
1269
1270 # mit "rum" bekleckern, nicht 1625 # mit "rum" bekleckern, nicht
1271 cf::map::_create_random_map ( 1626 $self->_create_random_map (
1272 $path,
1273 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1627 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1274 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1628 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1275 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1629 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1276 $rmp->{exit_on_final_map}, 1630 $rmp->{exit_on_final_map},
1277 $rmp->{xsize}, $rmp->{ysize}, 1631 $rmp->{xsize}, $rmp->{ysize},
1282 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1636 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1283 (cf::region::find $rmp->{region}), $rmp->{custom} 1637 (cf::region::find $rmp->{region}), $rmp->{custom}
1284 ) 1638 )
1285} 1639}
1286 1640
1641=item cf::map->register ($regex, $prio)
1642
1643Register a handler for the map path matching the given regex at the
1644givne priority (higher is better, built-in handlers have priority 0, the
1645default).
1646
1647=cut
1648
1649sub register {
1650 my (undef, $regex, $prio) = @_;
1651 my $pkg = caller;
1652
1653 no strict;
1654 push @{"$pkg\::ISA"}, __PACKAGE__;
1655
1656 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1657}
1658
1659# also paths starting with '/'
1660$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1661
1662sub thawer_merge {
1663 my ($self, $merge) = @_;
1664
1665 # we have to keep some variables in memory intact
1666 local $self->{path};
1667 local $self->{load_path};
1668
1669 $self->SUPER::thawer_merge ($merge);
1670}
1671
1672sub normalise {
1673 my ($path, $base) = @_;
1674
1675 $path = "$path"; # make sure its a string
1676
1677 $path =~ s/\.map$//;
1678
1679 # map plan:
1680 #
1681 # /! non-realised random map exit (special hack!)
1682 # {... are special paths that are not being touched
1683 # ?xxx/... are special absolute paths
1684 # ?random/... random maps
1685 # /... normal maps
1686 # ~user/... per-player map of a specific user
1687
1688 $path =~ s/$PATH_SEP/\//go;
1689
1690 # treat it as relative path if it starts with
1691 # something that looks reasonable
1692 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1693 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1694
1695 $base =~ s{[^/]+/?$}{};
1696 $path = "$base/$path";
1697 }
1698
1699 for ($path) {
1700 redo if s{//}{/};
1701 redo if s{/\.?/}{/};
1702 redo if s{/[^/]+/\.\./}{/};
1703 }
1704
1705 $path
1706}
1707
1708sub new_from_path {
1709 my (undef, $path, $base) = @_;
1710
1711 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1712
1713 $path = normalise $path, $base;
1714
1715 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1716 if ($path =~ $EXT_MAP{$pkg}[1]) {
1717 my $self = bless cf::map::new, $pkg;
1718 $self->{path} = $path; $self->path ($path);
1719 $self->init; # pass $1 etc.
1720 return $self;
1721 }
1722 }
1723
1724 Carp::cluck "unable to resolve path '$path' (base '$base').";
1725 ()
1726}
1727
1728sub init {
1729 my ($self) = @_;
1730
1731 $self
1732}
1733
1734sub as_string {
1735 my ($self) = @_;
1736
1737 "$self->{path}"
1738}
1739
1740# the displayed name, this is a one way mapping
1741sub visible_name {
1742 &as_string
1743}
1744
1745# the original (read-only) location
1746sub load_path {
1747 my ($self) = @_;
1748
1749 "$MAPDIR/$self->{path}.map"
1750}
1751
1752# the temporary/swap location
1753sub save_path {
1754 my ($self) = @_;
1755
1756 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1757 "$TMPDIR/$path.map"
1758}
1759
1760# the unique path, undef == no special unique path
1761sub uniq_path {
1762 my ($self) = @_;
1763
1764 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1765 "$UNIQUEDIR/$path"
1766}
1767
1287# and all this just because we cannot iterate over 1768# and all this just because we cannot iterate over
1288# all maps in C++... 1769# all maps in C++...
1289sub change_all_map_light { 1770sub change_all_map_light {
1290 my ($change) = @_; 1771 my ($change) = @_;
1291 1772
1292 $_->change_map_light ($change) 1773 $_->change_map_light ($change)
1293 for grep $_->outdoor, values %cf::MAP; 1774 for grep $_->outdoor, values %cf::MAP;
1294} 1775}
1295 1776
1777sub decay_objects {
1778 my ($self) = @_;
1779
1780 return if $self->{deny_reset};
1781
1782 $self->do_decay_objects;
1783}
1784
1785sub unlink_save {
1786 my ($self) = @_;
1787
1788 utf8::encode (my $save = $self->save_path);
1789 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1790 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1791}
1792
1296sub load_map_header($) { 1793sub load_header_from($) {
1297 my ($path) = @_; 1794 my ($self, $path) = @_;
1298 1795
1299 utf8::encode $path; 1796 utf8::encode $path;
1300 aio_open $path, O_RDONLY, 0 1797 my $f = new_from_file cf::object::thawer $path
1301 or return; 1798 or return;
1302 1799
1303 my $map = cf::map::new 1800 $self->_load_header ($f)
1304 or return; 1801 or return;
1305 1802
1306 # for better error messages only, will be overwritten later 1803 local $MAP_LOADING{$self->{path}} = $self;
1307 $map->path ($path); 1804 $f->resolve_delayed_derefs;
1308 1805
1309 $map->load_header ($path) 1806 $self->{load_path} = $path;
1807
1808 1
1809}
1810
1811sub load_header_orig {
1812 my ($self) = @_;
1813
1814 $self->load_header_from ($self->load_path)
1815}
1816
1817sub load_header_temp {
1818 my ($self) = @_;
1819
1820 $self->load_header_from ($self->save_path)
1821}
1822
1823sub prepare_temp {
1824 my ($self) = @_;
1825
1826 $self->last_access ((delete $self->{last_access})
1827 || $cf::RUNTIME); #d#
1828 # safety
1829 $self->{instantiate_time} = $cf::RUNTIME
1830 if $self->{instantiate_time} > $cf::RUNTIME;
1831}
1832
1833sub prepare_orig {
1834 my ($self) = @_;
1835
1836 $self->{load_original} = 1;
1837 $self->{instantiate_time} = $cf::RUNTIME;
1838 $self->last_access ($cf::RUNTIME);
1839 $self->instantiate;
1840}
1841
1842sub load_header {
1843 my ($self) = @_;
1844
1845 if ($self->load_header_temp) {
1846 $self->prepare_temp;
1847 } else {
1848 $self->load_header_orig
1310 or return; 1849 or return;
1850 $self->prepare_orig;
1851 }
1311 1852
1312 $map->{load_path} = $path; 1853 $self->{deny_reset} = 1
1854 if $self->no_reset;
1313 1855
1314 $map 1856 $self->default_region (cf::region::find_by_path $self->{path})
1857 unless $self->default_region;
1858
1859 1
1315} 1860}
1316 1861
1317sub find; 1862sub find;
1318sub find { 1863sub find {
1319 my ($path, $origin) = @_; 1864 my ($path, $origin) = @_;
1320 1865
1321 #warn "find<$path,$origin>\n";#d#
1322
1323 $path = new cf::path $path, $origin && $origin->path; 1866 $path = normalise $path, $origin && $origin->path;
1324 my $key = $path->as_string;
1325 1867
1868 cf::lock_wait "map_data:$path";#d#remove
1326 cf::lock_wait "map_find:$key"; 1869 cf::lock_wait "map_find:$path";
1327 1870
1328 $cf::MAP{$key} || do { 1871 $cf::MAP{$path} || do {
1329 my $guard = cf::lock_acquire "map_find:$key"; 1872 my $guard1 = cf::lock_acquire "map_find:$path";
1873 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1330 1874
1331 # do it the slow way 1875 my $map = new_from_path cf::map $path
1332 my $map = $path->load_temp;
1333
1334 Coro::cede;
1335
1336 if ($map) {
1337 $map->last_access ((delete $map->{last_access})
1338 || $cf::RUNTIME); #d#
1339 # safety
1340 $map->{instantiate_time} = $cf::RUNTIME
1341 if $map->{instantiate_time} > $cf::RUNTIME;
1342 } else {
1343 $map = $path->load_orig
1344 or return; 1876 or return;
1345 1877
1346 $map->{load_original} = 1;
1347 $map->{instantiate_time} = $cf::RUNTIME;
1348 $map->last_access ($cf::RUNTIME);
1349 $map->instantiate;
1350
1351 # per-player maps become, after loading, normal maps
1352 $map->per_player (0) if $path->{user_rel};
1353 }
1354
1355 $map->path ($key);
1356 $map->{path} = $path;
1357 $map->{last_save} = $cf::RUNTIME; 1878 $map->{last_save} = $cf::RUNTIME;
1358 1879
1359 Coro::cede; 1880 $map->load_header
1881 or return;
1360 1882
1361 if ($map->should_reset) { 1883 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1884 # doing this can freeze the server in a sync job, obviously
1885 #$cf::WAIT_FOR_TICK->wait;
1886 undef $guard1;
1887 undef $guard2;
1362 $map->reset; 1888 $map->reset;
1363 undef $guard;
1364 $map = find $path 1889 return find $path;
1365 or return;
1366 } 1890 }
1367 1891
1368 $cf::MAP{$key} = $map 1892 $cf::MAP{$path} = $map
1369 } 1893 }
1370} 1894}
1895
1896sub pre_load { }
1897sub post_load { }
1371 1898
1372sub load { 1899sub load {
1373 my ($self) = @_; 1900 my ($self) = @_;
1374 1901
1902 local $self->{deny_reset} = 1; # loading can take a long time
1903
1375 my $path = $self->{path}; 1904 my $path = $self->{path};
1905
1906 {
1376 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1907 my $guard = cf::lock_acquire "map_data:$path";
1377 1908
1909 return unless $self->valid;
1378 return if $self->in_memory != cf::MAP_SWAPPED; 1910 return unless $self->in_memory == cf::MAP_SWAPPED;
1379 1911
1380 $self->in_memory (cf::MAP_LOADING); 1912 $self->in_memory (cf::MAP_LOADING);
1381 1913
1382 $self->alloc; 1914 $self->alloc;
1383 $self->load_objects ($self->{load_path}, 1) 1915
1916 $self->pre_load;
1917 cf::cede_to_tick;
1918
1919 my $f = new_from_file cf::object::thawer $self->{load_path};
1920 $f->skip_block;
1921 $self->_load_objects ($f)
1384 or return; 1922 or return;
1385 1923
1386 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1924 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1387 if delete $self->{load_original}; 1925 if delete $self->{load_original};
1388 1926
1389 if (my $uniq = $path->uniq_path) { 1927 if (my $uniq = $self->uniq_path) {
1390 utf8::encode $uniq; 1928 utf8::encode $uniq;
1391 if (aio_open $uniq, O_RDONLY, 0) { 1929 unless (aio_stat $uniq) {
1930 if (my $f = new_from_file cf::object::thawer $uniq) {
1392 $self->clear_unique_items; 1931 $self->clear_unique_items;
1393 $self->load_objects ($uniq, 0); 1932 $self->_load_objects ($f);
1933 $f->resolve_delayed_derefs;
1934 }
1394 } 1935 }
1395 } 1936 }
1396 1937
1397 Coro::cede; 1938 $f->resolve_delayed_derefs;
1398 1939
1940 cf::cede_to_tick;
1399 # now do the right thing for maps 1941 # now do the right thing for maps
1400 $self->link_multipart_objects; 1942 $self->link_multipart_objects;
1401
1402 if ($self->{path}->is_style_map) {
1403 $self->{deny_save} = 1;
1404 $self->{deny_reset} = 1;
1405 } else {
1406 $self->fix_auto_apply;
1407 $self->decay_objects;
1408 $self->update_buttons;
1409 $self->set_darkness_map;
1410 $self->difficulty ($self->estimate_difficulty) 1943 $self->difficulty ($self->estimate_difficulty)
1411 unless $self->difficulty; 1944 unless $self->difficulty;
1945 cf::cede_to_tick;
1946
1947 unless ($self->{deny_activate}) {
1948 $self->decay_objects;
1949 $self->fix_auto_apply;
1950 $self->update_buttons;
1951 cf::cede_to_tick;
1952 $self->set_darkness_map;
1953 cf::cede_to_tick;
1412 $self->activate; 1954 $self->activate;
1413 } 1955 }
1414 1956
1415 Coro::cede; 1957 $self->{last_save} = $cf::RUNTIME;
1958 $self->last_access ($cf::RUNTIME);
1416 1959
1417 $self->in_memory (cf::MAP_IN_MEMORY); 1960 $self->in_memory (cf::MAP_IN_MEMORY);
1961 }
1962
1963 $self->post_load;
1964}
1965
1966sub customise_for {
1967 my ($self, $ob) = @_;
1968
1969 return find "~" . $ob->name . "/" . $self->{path}
1970 if $self->per_player;
1971
1972# return find "?party/" . $ob->name . "/" . $self->{path}
1973# if $self->per_party;
1974
1975 $self
1418} 1976}
1419 1977
1420# find and load all maps in the 3x3 area around a map 1978# find and load all maps in the 3x3 area around a map
1421sub load_diag { 1979sub load_neighbours {
1422 my ($map) = @_; 1980 my ($map) = @_;
1423 1981
1424 my @diag; # diagonal neighbours 1982 my @neigh; # diagonal neighbours
1425 1983
1426 for (0 .. 3) { 1984 for (0 .. 3) {
1427 my $neigh = $map->tile_path ($_) 1985 my $neigh = $map->tile_path ($_)
1428 or next; 1986 or next;
1429 $neigh = find $neigh, $map 1987 $neigh = find $neigh, $map
1430 or next; 1988 or next;
1431 $neigh->load; 1989 $neigh->load;
1432 1990
1991 push @neigh,
1433 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1992 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1434 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1993 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1435 } 1994 }
1436 1995
1437 for (@diag) { 1996 for (grep defined $_->[0], @neigh) {
1997 my ($path, $origin) = @$_;
1438 my $neigh = find @$_ 1998 my $neigh = find $path, $origin
1439 or next; 1999 or next;
1440 $neigh->load; 2000 $neigh->load;
1441 } 2001 }
1442} 2002}
1443 2003
1448} 2008}
1449 2009
1450sub do_load_sync { 2010sub do_load_sync {
1451 my ($map) = @_; 2011 my ($map) = @_;
1452 2012
2013 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2014 if $Coro::current == $Coro::main;
2015
1453 cf::sync_job { $map->load }; 2016 cf::sync_job { $map->load };
1454} 2017}
1455 2018
1456our %MAP_PREFETCH; 2019our %MAP_PREFETCH;
2020our $MAP_PREFETCHER = undef;
2021
2022sub find_async {
2023 my ($path, $origin, $load) = @_;
2024
2025 $path = normalise $path, $origin && $origin->{path};
2026
2027 if (my $map = $cf::MAP{$path}) {
2028 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
2029 }
2030
2031 $MAP_PREFETCH{$path} |= $load;
2032
1457our $MAP_PREFETCHER = Coro::async { 2033 $MAP_PREFETCHER ||= cf::async {
1458 while () {
1459 while (%MAP_PREFETCH) { 2034 while (%MAP_PREFETCH) {
1460 my $key = each %MAP_PREFETCH 2035 while (my ($k, $v) = each %MAP_PREFETCH) {
1461 or next; 2036 if (my $map = find $k) {
2037 $map->load if $v;
2038 }
2039
1462 my $path = delete $MAP_PREFETCH{$key}; 2040 delete $MAP_PREFETCH{$k};
1463
1464 my $map = find $path
1465 or next;
1466 $map->load;
1467 } 2041 }
1468 Coro::schedule; 2042 }
2043 undef $MAP_PREFETCHER;
1469 } 2044 };
1470};
1471
1472sub find_async {
1473 my ($path, $origin) = @_;
1474
1475 $path = new cf::path $path, $origin && $origin->path;
1476 my $key = $path->as_string;
1477
1478 if (my $map = $cf::MAP{$key}) {
1479 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1480 }
1481
1482 $MAP_PREFETCH{$key} = $path;
1483 $MAP_PREFETCHER->ready; 2045 $MAP_PREFETCHER->prio (6);
1484 2046
1485 () 2047 ()
1486} 2048}
1487 2049
1488sub save { 2050sub save {
1489 my ($self) = @_; 2051 my ($self) = @_;
1490 2052
1491 my $lock = cf::lock_acquire "map_data:" . $self->path; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1492 2054
1493 $self->{last_save} = $cf::RUNTIME; 2055 $self->{last_save} = $cf::RUNTIME;
1494 2056
1495 return unless $self->dirty; 2057 return unless $self->dirty;
1496 2058
1497 my $save = $self->{path}->save_path; utf8::encode $save; 2059 my $save = $self->save_path; utf8::encode $save;
1498 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2060 my $uniq = $self->uniq_path; utf8::encode $uniq;
1499 2061
1500 $self->{load_path} = $save; 2062 $self->{load_path} = $save;
1501 2063
1502 return if $self->{deny_save}; 2064 return if $self->{deny_save};
1503 2065
1506 cf::async { 2068 cf::async {
1507 $_->contr->save for $self->players; 2069 $_->contr->save for $self->players;
1508 }; 2070 };
1509 2071
1510 if ($uniq) { 2072 if ($uniq) {
1511 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2073 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1512 $self->save_objects ($uniq, cf::IO_UNIQUES); 2074 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1513 } else { 2075 } else {
1514 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2076 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1515 } 2077 }
1516} 2078}
1517 2079
1518sub swap_out { 2080sub swap_out {
1519 my ($self) = @_; 2081 my ($self) = @_;
1520 2082
1521 # save first because save cedes 2083 # save first because save cedes
1522 $self->save; 2084 $self->save;
1523 2085
1524 my $lock = cf::lock_acquire "map_data:" . $self->path; 2086 my $lock = cf::lock_acquire "map_data:$self->{path}";
1525 2087
1526 return if $self->players; 2088 return if $self->players;
1527 return if $self->in_memory != cf::MAP_IN_MEMORY; 2089 return if $self->in_memory != cf::MAP_IN_MEMORY;
1528 return if $self->{deny_save}; 2090 return if $self->{deny_save};
1529 2091
2092 $self->in_memory (cf::MAP_SWAPPED);
2093
2094 $self->deactivate;
2095 $_->clear_links_to ($self) for values %cf::MAP;
1530 $self->clear; 2096 $self->clear;
1531 $self->in_memory (cf::MAP_SWAPPED);
1532} 2097}
1533 2098
1534sub reset_at { 2099sub reset_at {
1535 my ($self) = @_; 2100 my ($self) = @_;
1536 2101
1537 # TODO: safety, remove and allow resettable per-player maps 2102 # TODO: safety, remove and allow resettable per-player maps
1538 return 1e99 if $self->{path}{user_rel};
1539 return 1e99 if $self->{deny_reset}; 2103 return 1e99 if $self->{deny_reset};
1540 2104
1541 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2105 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1542 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2106 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1543 2107
1548 my ($self) = @_; 2112 my ($self) = @_;
1549 2113
1550 $self->reset_at <= $cf::RUNTIME 2114 $self->reset_at <= $cf::RUNTIME
1551} 2115}
1552 2116
1553sub unlink_save {
1554 my ($self) = @_;
1555
1556 utf8::encode (my $save = $self->{path}->save_path);
1557 aioreq_pri 3; IO::AIO::aio_unlink $save;
1558 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1559}
1560
1561sub rename {
1562 my ($self, $new_path) = @_;
1563
1564 $self->unlink_save;
1565
1566 delete $cf::MAP{$self->path};
1567 $self->{path} = new cf::path $new_path;
1568 $self->path ($self->{path}->as_string);
1569 $cf::MAP{$self->path} = $self;
1570
1571 $self->save;
1572}
1573
1574sub reset { 2117sub reset {
1575 my ($self) = @_; 2118 my ($self) = @_;
1576 2119
1577 my $lock = cf::lock_acquire "map_data:" . $self->path; 2120 my $lock = cf::lock_acquire "map_data:$self->{path}";
1578 2121
1579 return if $self->players; 2122 return if $self->players;
1580 return if $self->{path}{user_rel};#d#
1581 2123
1582 warn "resetting map ", $self->path;#d# 2124 warn "resetting map ", $self->path;
2125
2126 $self->in_memory (cf::MAP_SWAPPED);
2127
2128 # need to save uniques path
2129 unless ($self->{deny_save}) {
2130 my $uniq = $self->uniq_path; utf8::encode $uniq;
2131
2132 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2133 if $uniq;
2134 }
1583 2135
1584 delete $cf::MAP{$self->path}; 2136 delete $cf::MAP{$self->path};
1585 2137
2138 $self->deactivate;
1586 $_->clear_links_to ($self) for values %cf::MAP; 2139 $_->clear_links_to ($self) for values %cf::MAP;
2140 $self->clear;
1587 2141
1588 $self->unlink_save; 2142 $self->unlink_save;
1589 $self->destroy; 2143 $self->destroy;
1590} 2144}
1591 2145
1592my $nuke_counter = "aaaa"; 2146my $nuke_counter = "aaaa";
1593 2147
1594sub nuke { 2148sub nuke {
1595 my ($self) = @_; 2149 my ($self) = @_;
1596 2150
2151 {
2152 my $lock = cf::lock_acquire "map_data:$self->{path}";
2153
2154 delete $cf::MAP{$self->path};
2155
2156 $self->unlink_save;
2157
2158 bless $self, "cf::map";
2159 delete $self->{deny_reset};
1597 $self->{deny_save} = 1; 2160 $self->{deny_save} = 1;
1598 $self->reset_timeout (1); 2161 $self->reset_timeout (1);
1599 $self->rename ("{nuke}/" . ($nuke_counter++)); 2162 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2163
2164 $cf::MAP{$self->path} = $self;
2165 }
2166
1600 $self->reset; # polite request, might not happen 2167 $self->reset; # polite request, might not happen
1601} 2168}
1602 2169
1603sub customise_for { 2170=item $maps = cf::map::tmp_maps
1604 my ($map, $ob) = @_;
1605 2171
1606 if ($map->per_player) { 2172Returns an arrayref with all map paths of currently instantiated and saved
1607 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2173maps. May block.
2174
2175=cut
2176
2177sub tmp_maps() {
1608 } 2178 [
2179 map {
2180 utf8::decode $_;
2181 /\.map$/
2182 ? normalise $_
2183 : ()
2184 } @{ aio_readdir $TMPDIR or [] }
2185 ]
2186}
1609 2187
1610 $map 2188=item $maps = cf::map::random_maps
2189
2190Returns an arrayref with all map paths of currently instantiated and saved
2191random maps. May block.
2192
2193=cut
2194
2195sub random_maps() {
2196 [
2197 map {
2198 utf8::decode $_;
2199 /\.map$/
2200 ? normalise "?random/$_"
2201 : ()
2202 } @{ aio_readdir $RANDOMDIR or [] }
2203 ]
1611} 2204}
1612 2205
1613=item cf::map::unique_maps 2206=item cf::map::unique_maps
1614 2207
1615Returns an arrayref of cf::path's of all shared maps that have 2208Returns an arrayref of paths of all shared maps that have
1616instantiated unique items. May block. 2209instantiated unique items. May block.
1617 2210
1618=cut 2211=cut
1619 2212
1620sub unique_maps() { 2213sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2214 [
1622 or return; 2215 map {
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_; 2216 utf8::decode $_;
1628 next if /\.pst$/; 2217 /\.map$/
1629 next unless /^$PATH_SEP/o; 2218 ? normalise $_
1630 2219 : ()
1631 push @paths, new cf::path $_; 2220 } @{ aio_readdir $UNIQUEDIR or [] }
1632 } 2221 ]
1633
1634 \@paths
1635} 2222}
1636 2223
1637package cf; 2224package cf;
1638 2225
1639=back 2226=back
1657 map { $_, inv_recursive_ $_->inv } @_ 2244 map { $_, inv_recursive_ $_->inv } @_
1658} 2245}
1659 2246
1660sub inv_recursive { 2247sub inv_recursive {
1661 inv_recursive_ inv $_[0] 2248 inv_recursive_ inv $_[0]
2249}
2250
2251=item $ref = $ob->ref
2252
2253creates and returns a persistent reference to an objetc that can be stored as a string.
2254
2255=item $ob = cf::object::deref ($refstring)
2256
2257returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2258even if the object actually exists. May block.
2259
2260=cut
2261
2262sub deref {
2263 my ($ref) = @_;
2264
2265 # temporary compatibility#TODO#remove
2266 $ref =~ s{^<}{player/<};
2267
2268 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2269 my ($uuid, $name) = ($1, $2);
2270 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2271 or return;
2272 $pl->ob->uuid eq $uuid
2273 or return;
2274
2275 $pl->ob
2276 } else {
2277 warn "$ref: cannot resolve object reference\n";
2278 undef
2279 }
1662} 2280}
1663 2281
1664package cf; 2282package cf;
1665 2283
1666=back 2284=back
1685 2303
1686 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2304 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1687 2305
1688 if ($self->{record_replies}) { 2306 if ($self->{record_replies}) {
1689 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2307 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2308
1690 } else { 2309 } else {
2310 my $pl = $self->contr;
2311
2312 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2313 my $dialog = $pl->{npc_dialog};
2314 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2315
2316 } else {
1691 $msg = $npc->name . " says: $msg" if $npc; 2317 $msg = $npc->name . " says: $msg" if $npc;
1692 $self->message ($msg, $flags); 2318 $self->message ($msg, $flags);
2319 }
1693 } 2320 }
2321}
2322
2323=item $object->send_msg ($channel, $msg, $color, [extra...])
2324
2325=cut
2326
2327sub cf::object::send_msg {
2328 my $pl = shift->contr
2329 or return;
2330 $pl->send_msg (@_);
1694} 2331}
1695 2332
1696=item $player_object->may ("access") 2333=item $player_object->may ("access")
1697 2334
1698Returns wether the given player is authorized to access resource "access" 2335Returns wether the given player is authorized to access resource "access"
1711 2348
1712=item $player_object->enter_link 2349=item $player_object->enter_link
1713 2350
1714Freezes the player and moves him/her to a special map (C<{link}>). 2351Freezes the player and moves him/her to a special map (C<{link}>).
1715 2352
1716The player should be reaosnably safe there for short amounts of time. You 2353The player should be reasonably safe there for short amounts of time. You
1717I<MUST> call C<leave_link> as soon as possible, though. 2354I<MUST> call C<leave_link> as soon as possible, though.
1718 2355
2356Will never block.
2357
1719=item $player_object->leave_link ($map, $x, $y) 2358=item $player_object->leave_link ($map, $x, $y)
1720 2359
1721Moves the player out of the specila link map onto the given map. If the 2360Moves the player out of the special C<{link}> map onto the specified
1722map is not valid (or omitted), the player will be moved back to the 2361map. If the map is not valid (or omitted), the player will be moved back
1723location he/she was before the call to C<enter_link>, or, if that fails, 2362to the location he/she was before the call to C<enter_link>, or, if that
1724to the emergency map position. 2363fails, to the emergency map position.
1725 2364
1726Might block. 2365Might block.
1727 2366
1728=cut 2367=cut
2368
2369sub link_map {
2370 unless ($LINK_MAP) {
2371 $LINK_MAP = cf::map::find "{link}"
2372 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2373 $LINK_MAP->load;
2374 }
2375
2376 $LINK_MAP
2377}
1729 2378
1730sub cf::object::player::enter_link { 2379sub cf::object::player::enter_link {
1731 my ($self) = @_; 2380 my ($self) = @_;
1732 2381
1733 $self->deactivate_recursive; 2382 $self->deactivate_recursive;
1734 2383
1735 return if $self->map == $LINK_MAP; 2384 return if UNIVERSAL::isa $self->map, "ext::map_link";
1736 2385
1737 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2386 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1738 if $self->map; 2387 if $self->map && $self->map->{path} ne "{link}";
1739 2388
1740 $self->enter_map ($LINK_MAP, 20, 20); 2389 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1741} 2390}
1742 2391
1743sub cf::object::player::leave_link { 2392sub cf::object::player::leave_link {
1744 my ($self, $map, $x, $y) = @_; 2393 my ($self, $map, $x, $y) = @_;
2394
2395 return unless $self->contr->active;
1745 2396
1746 my $link_pos = delete $self->{_link_pos}; 2397 my $link_pos = delete $self->{_link_pos};
1747 2398
1748 unless ($map) { 2399 unless ($map) {
1749 # restore original map position 2400 # restore original map position
1763 # use -1 or undef as default coordinates, not 0, 0 2414 # use -1 or undef as default coordinates, not 0, 0
1764 ($x, $y) = ($map->enter_x, $map->enter_y) 2415 ($x, $y) = ($map->enter_x, $map->enter_y)
1765 if $x <=0 && $y <= 0; 2416 if $x <=0 && $y <= 0;
1766 2417
1767 $map->load; 2418 $map->load;
1768 $map->load_diag; 2419 $map->load_neighbours;
1769 2420
1770 return unless $self->contr->active; 2421 return unless $self->contr->active;
1771 $self->activate_recursive; 2422 $self->activate_recursive;
2423
2424 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1772 $self->enter_map ($map, $x, $y); 2425 $self->enter_map ($map, $x, $y);
1773} 2426}
1774 2427
1775cf::player->attach ( 2428=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1776 on_logout => sub {
1777 my ($pl) = @_;
1778 2429
1779 # abort map switching before logout 2430Moves the player to the given map-path and coordinates by first freezing
1780 if ($pl->ob->{_link_pos}) { 2431her, loading and preparing them map, calling the provided $check callback
1781 cf::sync_job { 2432that has to return the map if sucecssful, and then unfreezes the player on
1782 $pl->ob->leave_link 2433the new (success) or old (failed) map position. In either case, $done will
1783 }; 2434be called at the end of this process.
1784 }
1785 },
1786 on_login => sub {
1787 my ($pl) = @_;
1788 2435
1789 # try to abort aborted map switching on player login :)
1790 # should happen only on crashes
1791 if ($pl->ob->{_link_pos}) {
1792 $pl->ob->enter_link;
1793 (async {
1794 # we need this sleep as the login has a concurrent enter_exit running
1795 # and this sleep increases chances of the player not ending up in scorn
1796 $pl->ob->reply (undef,
1797 "There was an internal problem at your last logout, "
1798 . "the server will try to bring you to your intended destination in a second.",
1799 cf::NDI_RED);
1800 Coro::Timer::sleep 1;
1801 $pl->ob->leave_link;
1802 })->prio (2);
1803 }
1804 },
1805);
1806
1807=item $player_object->goto ($path, $x, $y)
1808
1809=cut 2436=cut
2437
2438our $GOTOGEN;
1810 2439
1811sub cf::object::player::goto { 2440sub cf::object::player::goto {
1812 my ($self, $path, $x, $y) = @_; 2441 my ($self, $path, $x, $y, $check, $done) = @_;
1813 2442
1814 $path = new cf::path $path; 2443 # do generation counting so two concurrent goto's will be executed in-order
2444 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1815 2445
1816 $self->enter_link; 2446 $self->enter_link;
1817 2447
1818 (async { 2448 (async {
2449 my $map = eval {
1819 my $map = cf::map::find $path->as_string; 2450 my $map = cf::map::find $path;
2451
2452 if ($map) {
1820 $map = $map->customise_for ($self) if $map; 2453 $map = $map->customise_for ($self);
1821 2454 $map = $check->($map) if $check && $map;
1822# warn "entering ", $map->path, " at ($x, $y)\n" 2455 } else {
1823# if $map;
1824
1825 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2456 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2457 }
1826 2458
2459 $map
2460 };
2461
2462 if ($@) {
2463 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2464 LOG llevError | logBacktrace, Carp::longmess $@;
2465 }
2466
2467 if ($gen == $self->{_goto_generation}) {
2468 delete $self->{_goto_generation};
1827 $self->leave_link ($map, $x, $y); 2469 $self->leave_link ($map, $x, $y);
2470 }
2471
2472 $done->() if $done;
1828 })->prio (1); 2473 })->prio (1);
1829} 2474}
1830 2475
1831=item $player_object->enter_exit ($exit_object) 2476=item $player_object->enter_exit ($exit_object)
1832 2477
1834 2479
1835sub parse_random_map_params { 2480sub parse_random_map_params {
1836 my ($spec) = @_; 2481 my ($spec) = @_;
1837 2482
1838 my $rmp = { # defaults 2483 my $rmp = { # defaults
1839 xsize => 10, 2484 xsize => (cf::rndm 15, 40),
1840 ysize => 10, 2485 ysize => (cf::rndm 15, 40),
2486 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2487 #layout => string,
1841 }; 2488 };
1842 2489
1843 for (split /\n/, $spec) { 2490 for (split /\n/, $spec) {
1844 my ($k, $v) = split /\s+/, $_, 2; 2491 my ($k, $v) = split /\s+/, $_, 2;
1845 2492
1849 $rmp 2496 $rmp
1850} 2497}
1851 2498
1852sub prepare_random_map { 2499sub prepare_random_map {
1853 my ($exit) = @_; 2500 my ($exit) = @_;
2501
2502 my $guard = cf::lock_acquire "exit_prepare:$exit";
1854 2503
1855 # all this does is basically replace the /! path by 2504 # all this does is basically replace the /! path by
1856 # a new random map path (?random/...) with a seed 2505 # a new random map path (?random/...) with a seed
1857 # that depends on the exit object 2506 # that depends on the exit object
1858 2507
1859 my $rmp = parse_random_map_params $exit->msg; 2508 my $rmp = parse_random_map_params $exit->msg;
1860 2509
1861 if ($exit->map) { 2510 if ($exit->map) {
1862 $rmp->{region} = $exit->map->region_name; 2511 $rmp->{region} = $exit->region->name;
1863 $rmp->{origin_map} = $exit->map->path; 2512 $rmp->{origin_map} = $exit->map->path;
1864 $rmp->{origin_x} = $exit->x; 2513 $rmp->{origin_x} = $exit->x;
1865 $rmp->{origin_y} = $exit->y; 2514 $rmp->{origin_y} = $exit->y;
1866 } 2515 }
1867 2516
1868 $rmp->{random_seed} ||= $exit->random_seed; 2517 $rmp->{random_seed} ||= $exit->random_seed;
1869 2518
1870 my $data = cf::to_json $rmp; 2519 my $data = cf::to_json $rmp;
1871 my $md5 = Digest::MD5::md5_hex $data; 2520 my $md5 = Digest::MD5::md5_hex $data;
2521 my $meta = "$RANDOMDIR/$md5.meta";
1872 2522
1873 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2523 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1874 aio_write $fh, 0, (length $data), $data, 0; 2524 aio_write $fh, 0, (length $data), $data, 0;
2525 undef $fh;
2526 aio_rename "$meta~", $meta;
1875 2527
1876 $exit->slaying ("?random/$md5"); 2528 $exit->slaying ("?random/$md5");
1877 $exit->msg (undef); 2529 $exit->msg (undef);
1878 } 2530 }
1879} 2531}
1881sub cf::object::player::enter_exit { 2533sub cf::object::player::enter_exit {
1882 my ($self, $exit) = @_; 2534 my ($self, $exit) = @_;
1883 2535
1884 return unless $self->type == cf::PLAYER; 2536 return unless $self->type == cf::PLAYER;
1885 2537
2538 if ($exit->slaying eq "/!") {
2539 #TODO: this should de-fi-ni-te-ly not be a sync-job
2540 # the problem is that $exit might not survive long enough
2541 # so it needs to be done right now, right here
2542 cf::sync_job { prepare_random_map $exit };
2543 }
2544
2545 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2546 my $hp = $exit->stats->hp;
2547 my $sp = $exit->stats->sp;
2548
1886 $self->enter_link; 2549 $self->enter_link;
2550
2551 # if exit is damned, update players death & WoR home-position
2552 $self->contr->savebed ($slaying, $hp, $sp)
2553 if $exit->flag (FLAG_DAMNED);
1887 2554
1888 (async { 2555 (async {
1889 $self->deactivate_recursive; # just to be sure 2556 $self->deactivate_recursive; # just to be sure
1890 unless (eval { 2557 unless (eval {
1891 prepare_random_map $exit 2558 $self->goto ($slaying, $hp, $sp);
1892 if $exit->slaying eq "/!";
1893
1894 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1895 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1896 2559
1897 1; 2560 1;
1898 }) { 2561 }) {
1899 $self->message ("Something went wrong deep within the crossfire server. " 2562 $self->message ("Something went wrong deep within the crossfire server. "
1900 . "I'll try to bring you back to the map you were before. " 2563 . "I'll try to bring you back to the map you were before. "
1901 . "Please report this to the dungeon master!", 2564 . "Please report this to the dungeon master!",
1902 cf::NDI_UNIQUE | cf::NDI_RED); 2565 cf::NDI_UNIQUE | cf::NDI_RED);
1903 2566
1904 warn "ERROR in enter_exit: $@"; 2567 warn "ERROR in enter_exit: $@";
1905 $self->leave_link; 2568 $self->leave_link;
1906 } 2569 }
1907 })->prio (1); 2570 })->prio (1);
1920 2583
1921sub cf::client::send_drawinfo { 2584sub cf::client::send_drawinfo {
1922 my ($self, $text, $flags) = @_; 2585 my ($self, $text, $flags) = @_;
1923 2586
1924 utf8::encode $text; 2587 utf8::encode $text;
1925 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2588 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1926} 2589}
1927 2590
2591=item $client->send_msg ($channel, $msg, $color, [extra...])
2592
2593Send a drawinfo or msg packet to the client, formatting the msg for the
2594client if neccessary. C<$type> should be a string identifying the type of
2595the message, with C<log> being the default. If C<$color> is negative, suppress
2596the message unless the client supports the msg packet.
2597
2598=cut
2599
2600our %CHANNEL = (
2601 "c/identify" => {
2602 id => "identify",
2603 title => "Identify",
2604 reply => undef,
2605 tooltip => "Items recently identified",
2606 },
2607 "c/examine" => {
2608 id => "examine",
2609 title => "Examine",
2610 reply => undef,
2611 tooltip => "Signs and other items you examined",
2612 },
2613);
2614
2615sub cf::client::send_msg {
2616 my ($self, $channel, $msg, $color, @extra) = @_;
2617
2618 $msg = $self->pl->expand_cfpod ($msg);
2619
2620 $color &= cf::NDI_CLIENT_MASK; # just in case...
2621
2622 # check predefined channels, for the benefit of C
2623 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2624
2625 if (ref $channel) {
2626 # send meta info to client, if not yet sent
2627 unless (exists $self->{channel}{$channel->{id}}) {
2628 $self->{channel}{$channel->{id}} = $channel;
2629 $self->ext_msg (channel_info => $channel)
2630 if $self->can_msg;
2631 }
2632
2633 $channel = $channel->{id};
2634 }
2635
2636 return unless @extra || length $msg;
2637
2638 if ($self->can_msg) {
2639 # default colour, mask it out
2640 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2641 if $color & cf::NDI_DEF;
2642
2643 $self->send_packet ("msg " . $self->{json_coder}->encode (
2644 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2645 } else {
2646 if ($color >= 0) {
2647 # replace some tags by gcfclient-compatible ones
2648 for ($msg) {
2649 1 while
2650 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2651 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2652 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2653 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2654 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2655 }
2656
2657 $color &= cf::NDI_COLOR_MASK;
2658
2659 utf8::encode $msg;
2660
2661 if (0 && $msg =~ /\[/) {
2662 # COMMAND/INFO
2663 $self->send_packet ("drawextinfo $color 10 8 $msg")
2664 } else {
2665 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2666 $self->send_packet ("drawinfo $color $msg")
2667 }
2668 }
2669 }
2670}
2671
2672=item $client->ext_msg ($type, @msg)
2673
2674Sends an ext event to the client.
2675
2676=cut
2677
2678sub cf::client::ext_msg($$@) {
2679 my ($self, $type, @msg) = @_;
2680
2681 if ($self->extcmd == 2) {
2682 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2683 } elsif ($self->extcmd == 1) { # TODO: remove
2684 push @msg, msgtype => "event_$type";
2685 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2686 }
2687}
2688
2689=item $client->ext_reply ($msgid, @msg)
2690
2691Sends an ext reply to the client.
2692
2693=cut
2694
2695sub cf::client::ext_reply($$@) {
2696 my ($self, $id, @msg) = @_;
2697
2698 if ($self->extcmd == 2) {
2699 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2700 } elsif ($self->extcmd == 1) {
2701 #TODO: version 1, remove
2702 unshift @msg, msgtype => "reply", msgid => $id;
2703 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2704 }
2705}
1928 2706
1929=item $success = $client->query ($flags, "text", \&cb) 2707=item $success = $client->query ($flags, "text", \&cb)
1930 2708
1931Queues a query to the client, calling the given callback with 2709Queues a query to the client, calling the given callback with
1932the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2710the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1933C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2711C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1934 2712
1935Queries can fail, so check the return code. Or don't, as queries will become 2713Queries can fail, so check the return code. Or don't, as queries will
1936reliable at some point in the future. 2714become reliable at some point in the future.
1937 2715
1938=cut 2716=cut
1939 2717
1940sub cf::client::query { 2718sub cf::client::query {
1941 my ($self, $flags, $text, $cb) = @_; 2719 my ($self, $flags, $text, $cb) = @_;
1949 utf8::encode $text; 2727 utf8::encode $text;
1950 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2728 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1951 2729
1952 $self->send_packet ($self->{query_queue}[0][0]) 2730 $self->send_packet ($self->{query_queue}[0][0])
1953 if @{ $self->{query_queue} } == 1; 2731 if @{ $self->{query_queue} } == 1;
2732
2733 1
1954} 2734}
1955 2735
1956cf::client->attach ( 2736cf::client->attach (
2737 on_connect => sub {
2738 my ($ns) = @_;
2739
2740 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2741 },
1957 on_reply => sub { 2742 on_reply => sub {
1958 my ($ns, $msg) = @_; 2743 my ($ns, $msg) = @_;
1959 2744
1960 # this weird shuffling is so that direct followup queries 2745 # this weird shuffling is so that direct followup queries
1961 # get handled first 2746 # get handled first
1962 my $queue = delete $ns->{query_queue} 2747 my $queue = delete $ns->{query_queue}
1963 or return; # be conservative, not sure how that can happen, but we saw a crash here 2748 or return; # be conservative, not sure how that can happen, but we saw a crash here
1964 2749
1965 (shift @$queue)->[1]->($msg); 2750 (shift @$queue)->[1]->($msg);
2751 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1966 2752
1967 push @{ $ns->{query_queue} }, @$queue; 2753 push @{ $ns->{query_queue} }, @$queue;
1968 2754
1969 if (@{ $ns->{query_queue} } == @$queue) { 2755 if (@{ $ns->{query_queue} } == @$queue) {
1970 if (@$queue) { 2756 if (@$queue) {
1972 } else { 2758 } else {
1973 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2759 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1974 } 2760 }
1975 } 2761 }
1976 }, 2762 },
2763 on_exticmd => sub {
2764 my ($ns, $buf) = @_;
2765
2766 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2767
2768 if (ref $msg) {
2769 my ($type, $reply, @payload) =
2770 "ARRAY" eq ref $msg
2771 ? @$msg
2772 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2773
2774 my @reply;
2775
2776 if (my $cb = $EXTICMD{$type}) {
2777 @reply = $cb->($ns, @payload);
2778 }
2779
2780 $ns->ext_reply ($reply, @reply)
2781 if $reply;
2782
2783 } else {
2784 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2785 }
2786
2787 cf::override;
2788 },
1977); 2789);
1978 2790
1979=item $client->async (\&cb) 2791=item $client->async (\&cb)
1980 2792
1981Create a new coroutine, running the specified callback. The coroutine will 2793Create a new coroutine, running the specified callback. The coroutine will
2022our $safe = new Safe "safe"; 2834our $safe = new Safe "safe";
2023our $safe_hole = new Safe::Hole; 2835our $safe_hole = new Safe::Hole;
2024 2836
2025$SIG{FPE} = 'IGNORE'; 2837$SIG{FPE} = 'IGNORE';
2026 2838
2027$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2839$safe->permit_only (Opcode::opset qw(
2840 :base_core :base_mem :base_orig :base_math
2841 grepstart grepwhile mapstart mapwhile
2842 sort time
2843));
2028 2844
2029# here we export the classes and methods available to script code 2845# here we export the classes and methods available to script code
2030 2846
2031=pod 2847=pod
2032 2848
2033The following fucntions and emthods are available within a safe environment: 2849The following functions and methods are available within a safe environment:
2034 2850
2035 cf::object contr pay_amount pay_player map 2851 cf::object
2852 contr pay_amount pay_player map x y force_find force_add
2853 insert remove name archname title slaying race decrease_ob_nr
2854
2036 cf::object::player player 2855 cf::object::player
2037 cf::player peaceful 2856 player
2038 cf::map trigger 2857
2858 cf::player
2859 peaceful
2860
2861 cf::map
2862 trigger
2039 2863
2040=cut 2864=cut
2041 2865
2042for ( 2866for (
2043 ["cf::object" => qw(contr pay_amount pay_player map)], 2867 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2868 insert remove inv name archname title slaying race
2869 decrease_ob_nr)],
2044 ["cf::object::player" => qw(player)], 2870 ["cf::object::player" => qw(player)],
2045 ["cf::player" => qw(peaceful)], 2871 ["cf::player" => qw(peaceful)],
2046 ["cf::map" => qw(trigger)], 2872 ["cf::map" => qw(trigger)],
2047) { 2873) {
2048 no strict 'refs'; 2874 no strict 'refs';
2119=back 2945=back
2120 2946
2121=cut 2947=cut
2122 2948
2123############################################################################# 2949#############################################################################
2950# the server's init and main functions
2124 2951
2125=head2 EXTENSION DATABASE SUPPORT 2952sub load_facedata($) {
2953 my ($path) = @_;
2126 2954
2127Crossfire maintains a very simple database for extension use. It can 2955 # HACK to clear player env face cache, we need some signal framework
2128currently store anything that can be serialised using Storable, which 2956 # for this (global event?)
2129excludes objects. 2957 %ext::player_env::MUSIC_FACE_CACHE = ();
2130 2958
2131The parameter C<$family> should best start with the name of the extension 2959 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2132using it, it should be unique.
2133 2960
2134=over 4 2961 warn "loading facedata from $path\n";
2135 2962
2136=item $hashref = cf::db_get $family 2963 my $facedata;
2964 0 < aio_load $path, $facedata
2965 or die "$path: $!";
2137 2966
2138Return a hashref for use by the extension C<$family>, which can be 2967 $facedata = Coro::Storable::thaw $facedata;
2139modified. After modifications, you have to call C<cf::db_dirty> or
2140C<cf::db_sync>.
2141 2968
2142=item $value = cf::db_get $family => $key 2969 $facedata->{version} == 2
2970 or cf::cleanup "$path: version mismatch, cannot proceed.";
2143 2971
2144Returns a single value from the database 2972 # patch in the exptable
2145 2973 $facedata->{resource}{"res/exp_table"} = {
2146=item cf::db_put $family => $hashref 2974 type => FT_RSRC,
2147 2975 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2148Stores the given family hashref into the database. Updates are delayed, if
2149you want the data to be synced to disk immediately, use C<cf::db_sync>.
2150
2151=item cf::db_put $family => $key => $value
2152
2153Stores the given C<$value> in the family hash. Updates are delayed, if you
2154want the data to be synced to disk immediately, use C<cf::db_sync>.
2155
2156=item cf::db_dirty
2157
2158Marks the database as dirty, to be updated at a later time.
2159
2160=item cf::db_sync
2161
2162Immediately write the database to disk I<if it is dirty>.
2163
2164=cut
2165
2166our $DB;
2167
2168{
2169 my $path = cf::localdir . "/database.pst";
2170
2171 sub db_load() {
2172 $DB = stat $path ? Storable::retrieve $path : { };
2173 }
2174
2175 my $pid;
2176
2177 sub db_save() {
2178 waitpid $pid, 0 if $pid;
2179 if (0 == ($pid = fork)) {
2180 $DB->{_meta}{version} = 1;
2181 Storable::nstore $DB, "$path~";
2182 rename "$path~", $path;
2183 cf::_exit 0 if defined $pid;
2184 }
2185 }
2186
2187 my $dirty;
2188
2189 sub db_sync() {
2190 db_save if $dirty;
2191 undef $dirty;
2192 }
2193
2194 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2195 db_sync;
2196 }); 2976 };
2977 cf::cede_to_tick;
2197 2978
2198 sub db_dirty() {
2199 $dirty = 1;
2200 $idle->start;
2201 } 2979 {
2980 my $faces = $facedata->{faceinfo};
2202 2981
2203 sub db_get($;$) { 2982 while (my ($face, $info) = each %$faces) {
2204 @_ >= 2 2983 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2205 ? $DB->{$_[0]}{$_[1]} 2984 cf::face::set_visibility $idx, $info->{visibility};
2206 : ($DB->{$_[0]} ||= { }) 2985 cf::face::set_magicmap $idx, $info->{magicmap};
2207 } 2986 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2987 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2208 2988
2209 sub db_put($$;$) { 2989 cf::cede_to_tick;
2210 if (@_ >= 3) {
2211 $DB->{$_[0]}{$_[1]} = $_[2];
2212 } else {
2213 $DB->{$_[0]} = $_[1];
2214 }
2215 db_dirty;
2216 }
2217
2218 cf::global->attach (
2219 prio => 10000,
2220 on_cleanup => sub {
2221 db_sync;
2222 }, 2990 }
2223 );
2224}
2225 2991
2226############################################################################# 2992 while (my ($face, $info) = each %$faces) {
2227# the server's main() 2993 next unless $info->{smooth};
2994 my $idx = cf::face::find $face
2995 or next;
2996 if (my $smooth = cf::face::find $info->{smooth}) {
2997 cf::face::set_smooth $idx, $smooth;
2998 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2999 } else {
3000 warn "smooth face '$info->{smooth}' not found for face '$face'";
3001 }
2228 3002
2229sub cfg_load { 3003 cf::cede_to_tick;
3004 }
3005 }
3006
3007 {
3008 my $anims = $facedata->{animinfo};
3009
3010 while (my ($anim, $info) = each %$anims) {
3011 cf::anim::set $anim, $info->{frames}, $info->{facings};
3012 cf::cede_to_tick;
3013 }
3014
3015 cf::anim::invalidate_all; # d'oh
3016 }
3017
3018 {
3019 # TODO: for gcfclient pleasure, we should give resources
3020 # that gcfclient doesn't grok a >10000 face index.
3021 my $res = $facedata->{resource};
3022
3023 my $soundconf = delete $res->{"res/sound.conf"};
3024
3025 while (my ($name, $info) = each %$res) {
3026 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3027 my $data;
3028
3029 if ($info->{type} & 1) {
3030 # prepend meta info
3031
3032 my $meta = $enc->encode ({
3033 name => $name,
3034 %{ $info->{meta} || {} },
3035 });
3036
3037 $data = pack "(w/a*)*", $meta, $info->{data};
3038 } else {
3039 $data = $info->{data};
3040 }
3041
3042 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3043 cf::face::set_type $idx, $info->{type};
3044
3045 cf::cede_to_tick;
3046 }
3047
3048 if ($soundconf) {
3049 $soundconf = $enc->decode (delete $soundconf->{data});
3050
3051 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3052 my $sound = $soundconf->{compat}[$_]
3053 or next;
3054
3055 my $face = cf::face::find "sound/$sound->[1]";
3056 cf::sound::set $sound->[0] => $face;
3057 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3058 }
3059
3060 while (my ($k, $v) = each %{$soundconf->{event}}) {
3061 my $face = cf::face::find "sound/$v";
3062 cf::sound::set $k => $face;
3063 }
3064 }
3065 }
3066
3067 1
3068}
3069
3070register_exticmd fx_want => sub {
3071 my ($ns, $want) = @_;
3072
3073 while (my ($k, $v) = each %$want) {
3074 $ns->fx_want ($k, $v);
3075 }
3076};
3077
3078sub reload_regions {
3079 # HACK to clear player env face cache, we need some signal framework
3080 # for this (global event?)
3081 %ext::player_env::MUSIC_FACE_CACHE = ();
3082
3083 load_resource_file "$MAPDIR/regions"
3084 or die "unable to load regions file\n";
3085
3086 for (cf::region::list) {
3087 $_->{match} = qr/$_->{match}/
3088 if exists $_->{match};
3089 }
3090}
3091
3092sub reload_facedata {
3093 load_facedata "$DATADIR/facedata"
3094 or die "unable to load facedata\n";
3095}
3096
3097sub reload_archetypes {
3098 load_resource_file "$DATADIR/archetypes"
3099 or die "unable to load archetypes\n";
3100 #d# NEED to laod twice to resolve forward references
3101 # this really needs to be done in an extra post-pass
3102 # (which needs to be synchronous, so solve it differently)
3103 load_resource_file "$DATADIR/archetypes"
3104 or die "unable to load archetypes\n";
3105}
3106
3107sub reload_treasures {
3108 load_resource_file "$DATADIR/treasures"
3109 or die "unable to load treasurelists\n";
3110}
3111
3112sub reload_resources {
3113 warn "reloading resource files...\n";
3114
3115 reload_regions;
3116 reload_facedata;
3117 #reload_archetypes;#d#
3118 reload_archetypes;
3119 reload_treasures;
3120
3121 warn "finished reloading resource files\n";
3122}
3123
3124sub init {
3125 reload_resources;
3126}
3127
3128sub reload_config {
2230 open my $fh, "<:utf8", cf::confdir . "/config" 3129 open my $fh, "<:utf8", "$CONFDIR/config"
2231 or return; 3130 or return;
2232 3131
2233 local $/; 3132 local $/;
2234 *CFG = YAML::Syck::Load <$fh>; 3133 *CFG = YAML::Syck::Load <$fh>;
2235 3134
2249 3148
2250sub main { 3149sub main {
2251 # we must not ever block the main coroutine 3150 # we must not ever block the main coroutine
2252 local $Coro::idle = sub { 3151 local $Coro::idle = sub {
2253 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3152 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3153 (async {
2254 async { Event::one_event }; 3154 Event::one_event;
3155 })->prio (Coro::PRIO_MAX);
2255 }; 3156 };
2256 3157
2257 cfg_load; 3158 reload_config;
2258 db_load; 3159 db_init;
2259 load_extensions; 3160 load_extensions;
3161
3162 $TICK_WATCHER->start;
2260 Event::loop; 3163 Event::loop;
2261} 3164}
2262 3165
2263############################################################################# 3166#############################################################################
2264# initialisation and cleanup 3167# initialisation and cleanup
2265 3168
2266# install some emergency cleanup handlers 3169# install some emergency cleanup handlers
2267BEGIN { 3170BEGIN {
2268 for my $signal (qw(INT HUP TERM)) { 3171 for my $signal (qw(INT HUP TERM)) {
2269 Event->signal ( 3172 Event->signal (
3173 reentrant => 0,
2270 data => WF_AUTOCANCEL, 3174 data => WF_AUTOCANCEL,
2271 signal => $signal, 3175 signal => $signal,
3176 prio => 0,
2272 cb => sub { 3177 cb => sub {
2273 cf::cleanup "SIG$signal"; 3178 cf::cleanup "SIG$signal";
2274 }, 3179 },
2275 ); 3180 );
2276 } 3181 }
2277} 3182}
2278 3183
3184sub write_runtime {
3185 my $runtime = "$LOCALDIR/runtime";
3186
3187 # first touch the runtime file to show we are still running:
3188 # the fsync below can take a very very long time.
3189
3190 IO::AIO::aio_utime $runtime, undef, undef;
3191
3192 my $guard = cf::lock_acquire "write_runtime";
3193
3194 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3195 or return;
3196
3197 my $value = $cf::RUNTIME + 90 + 10;
3198 # 10 is the runtime save interval, for a monotonic clock
3199 # 60 allows for the watchdog to kill the server.
3200
3201 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3202 and return;
3203
3204 # always fsync - this file is important
3205 aio_fsync $fh
3206 and return;
3207
3208 # touch it again to show we are up-to-date
3209 aio_utime $fh, undef, undef;
3210
3211 close $fh
3212 or return;
3213
3214 aio_rename "$runtime~", $runtime
3215 and return;
3216
3217 warn "runtime file written.\n";
3218
3219 1
3220}
3221
2279sub emergency_save() { 3222sub emergency_save() {
2280 my $freeze_guard = cf::freeze_mainloop; 3223 my $freeze_guard = cf::freeze_mainloop;
2281 3224
2282 warn "enter emergency perl save\n"; 3225 warn "enter emergency perl save\n";
2283 3226
2284 cf::sync_job { 3227 cf::sync_job {
2285 # use a peculiar iteration method to avoid tripping on perl 3228 # use a peculiar iteration method to avoid tripping on perl
2286 # refcount bugs in for. also avoids problems with players 3229 # refcount bugs in for. also avoids problems with players
2287 # and maps saved/Destroyed asynchronously. 3230 # and maps saved/destroyed asynchronously.
2288 warn "begin emergency player save\n"; 3231 warn "begin emergency player save\n";
2289 for my $login (keys %cf::PLAYER) { 3232 for my $login (keys %cf::PLAYER) {
2290 my $pl = $cf::PLAYER{$login} or next; 3233 my $pl = $cf::PLAYER{$login} or next;
2291 $pl->valid or next; 3234 $pl->valid or next;
2292 $pl->save; 3235 $pl->save;
2298 my $map = $cf::MAP{$path} or next; 3241 my $map = $cf::MAP{$path} or next;
2299 $map->valid or next; 3242 $map->valid or next;
2300 $map->save; 3243 $map->save;
2301 } 3244 }
2302 warn "end emergency map save\n"; 3245 warn "end emergency map save\n";
3246
3247 warn "begin emergency database checkpoint\n";
3248 BDB::db_env_txn_checkpoint $DB_ENV;
3249 warn "end emergency database checkpoint\n";
2303 }; 3250 };
2304 3251
2305 warn "leave emergency perl save\n"; 3252 warn "leave emergency perl save\n";
2306} 3253}
2307 3254
3255sub post_cleanup {
3256 my ($make_core) = @_;
3257
3258 warn Carp::longmess "post_cleanup backtrace"
3259 if $make_core;
3260}
3261
2308sub reload() { 3262sub do_reload_perl() {
2309 # can/must only be called in main 3263 # can/must only be called in main
2310 if ($Coro::current != $Coro::main) { 3264 if ($Coro::current != $Coro::main) {
2311 warn "can only reload from main coroutine\n"; 3265 warn "can only reload from main coroutine";
2312 return; 3266 return;
2313 } 3267 }
2314 3268
2315 warn "reloading..."; 3269 warn "reloading...";
2316 3270
2317 warn "freezing server"; 3271 warn "entering sync_job";
2318 my $guard = freeze_mainloop; 3272
3273 cf::sync_job {
3274 cf::write_runtime; # external watchdog should not bark
2319 cf::emergency_save; 3275 cf::emergency_save;
3276 cf::write_runtime; # external watchdog should not bark
2320 3277
2321 warn "sync database to disk"; 3278 warn "syncing database to disk";
2322 cf::db_sync; 3279 BDB::db_env_txn_checkpoint $DB_ENV;
2323 IO::AIO::flush;
2324 3280
2325 eval {
2326 # if anything goes wrong in here, we should simply crash as we already saved 3281 # if anything goes wrong in here, we should simply crash as we already saved
2327 3282
2328 warn "cancel all watchers"; 3283 warn "cancelling all WF_AUTOCANCEL watchers";
2329 for (Event::all_watchers) { 3284 for (Event::all_watchers) {
2330 $_->cancel if $_->data & WF_AUTOCANCEL; 3285 $_->cancel if $_->data & WF_AUTOCANCEL;
2331 } 3286 }
2332 3287
3288 warn "flushing outstanding aio requests";
3289 for (;;) {
3290 BDB::flush;
3291 IO::AIO::flush;
3292 Coro::cede;
3293 last unless IO::AIO::nreqs || BDB::nreqs;
3294 warn "iterate...";
3295 }
3296
3297 ++$RELOAD;
3298
2333 warn "cancel all extension coros"; 3299 warn "cancelling all extension coros";
2334 $_->cancel for values %EXT_CORO; 3300 $_->cancel for values %EXT_CORO;
2335 %EXT_CORO = (); 3301 %EXT_CORO = ();
2336 3302
2337 warn "remove commands"; 3303 warn "removing commands";
2338 %COMMAND = (); 3304 %COMMAND = ();
2339 3305
2340 warn "remove ext commands"; 3306 warn "removing ext/exti commands";
2341 %EXTCMD = (); 3307 %EXTCMD = ();
3308 %EXTICMD = ();
2342 3309
2343 warn "unload/nuke all extensions"; 3310 warn "unloading/nuking all extensions";
2344 for my $pkg (@EXTS) { 3311 for my $pkg (@EXTS) {
2345 warn "... unloading $pkg"; 3312 warn "... unloading $pkg";
2346 3313
2347 if (my $cb = $pkg->can ("unload")) { 3314 if (my $cb = $pkg->can ("unload")) {
2348 eval { 3315 eval {
2353 3320
2354 warn "... nuking $pkg"; 3321 warn "... nuking $pkg";
2355 Symbol::delete_package $pkg; 3322 Symbol::delete_package $pkg;
2356 } 3323 }
2357 3324
2358 warn "unload all perl modules loaded from $LIBDIR"; 3325 warn "unloading all perl modules loaded from $LIBDIR";
2359 while (my ($k, $v) = each %INC) { 3326 while (my ($k, $v) = each %INC) {
2360 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3327 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2361 3328
2362 warn "removing <$k>"; 3329 warn "... unloading $k";
2363 delete $INC{$k}; 3330 delete $INC{$k};
2364 3331
2365 $k =~ s/\.pm$//; 3332 $k =~ s/\.pm$//;
2366 $k =~ s/\//::/g; 3333 $k =~ s/\//::/g;
2367 3334
2370 } 3337 }
2371 3338
2372 Symbol::delete_package $k; 3339 Symbol::delete_package $k;
2373 } 3340 }
2374 3341
2375 warn "get rid of safe::, as good as possible"; 3342 warn "getting rid of safe::, as good as possible";
2376 Symbol::delete_package "safe::$_" 3343 Symbol::delete_package "safe::$_"
2377 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3344 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2378 3345
2379 warn "unload cf.pm \"a bit\""; 3346 warn "unloading cf.pm \"a bit\"";
2380 delete $INC{"cf.pm"}; 3347 delete $INC{"cf.pm"};
3348 delete $INC{"cf/pod.pm"};
2381 3349
2382 # don't, removes xs symbols, too, 3350 # don't, removes xs symbols, too,
2383 # and global variables created in xs 3351 # and global variables created in xs
2384 #Symbol::delete_package __PACKAGE__; 3352 #Symbol::delete_package __PACKAGE__;
2385 3353
3354 warn "unload completed, starting to reload now";
3355
2386 warn "reloading cf.pm"; 3356 warn "reloading cf.pm";
2387 require cf; 3357 require cf;
2388 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3358 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2389 3359
2390 warn "load config and database again"; 3360 warn "loading config and database again";
2391 cf::cfg_load; 3361 cf::reload_config;
2392 cf::db_load;
2393 3362
2394 warn "load extensions"; 3363 warn "loading extensions";
2395 cf::load_extensions; 3364 cf::load_extensions;
2396 3365
2397 warn "reattach attachments to objects/players"; 3366 warn "reattaching attachments to objects/players";
2398 _global_reattach; 3367 _global_reattach; # objects, sockets
2399 warn "reattach attachments to maps"; 3368 warn "reattaching attachments to maps";
2400 reattach $_ for values %MAP; 3369 reattach $_ for values %MAP;
2401 }; 3370 warn "reattaching attachments to players";
3371 reattach $_ for values %PLAYER;
2402 3372
2403 if ($@) { 3373 warn "leaving sync_job";
3374
3375 1
3376 } or do {
2404 warn $@; 3377 warn $@;
2405 warn "error while reloading, exiting."; 3378 warn "error while reloading, exiting.";
2406 exit 1; 3379 exit 1;
2407 } 3380 };
2408 3381
2409 warn "reloaded"; 3382 warn "reloaded";
2410}; 3383};
2411 3384
2412############################################################################# 3385our $RELOAD_WATCHER; # used only during reload
2413 3386
2414unless ($LINK_MAP) { 3387sub reload_perl() {
2415 $LINK_MAP = cf::map::new; 3388 # doing reload synchronously and two reloads happen back-to-back,
3389 # coro crashes during coro_state_free->destroy here.
2416 3390
2417 $LINK_MAP->width (41); 3391 $RELOAD_WATCHER ||= Event->timer (
2418 $LINK_MAP->height (41); 3392 reentrant => 0,
2419 $LINK_MAP->alloc;
2420 $LINK_MAP->path ("{link}");
2421 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2422 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2423
2424 # dirty hack because... archetypes are not yet loaded
2425 Event->timer (
2426 after => 10, 3393 after => 0,
3394 data => WF_AUTOCANCEL,
2427 cb => sub { 3395 cb => sub {
2428 $_[0]->w->cancel; 3396 do_reload_perl;
2429 3397 undef $RELOAD_WATCHER;
2430 # provide some exits "home"
2431 my $exit = cf::object::new "exit";
2432
2433 $exit->slaying ($EMERGENCY_POSITION->[0]);
2434 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2435 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2436
2437 $LINK_MAP->insert ($exit->clone, 19, 19);
2438 $LINK_MAP->insert ($exit->clone, 19, 20);
2439 $LINK_MAP->insert ($exit->clone, 19, 21);
2440 $LINK_MAP->insert ($exit->clone, 20, 19);
2441 $LINK_MAP->insert ($exit->clone, 20, 21);
2442 $LINK_MAP->insert ($exit->clone, 21, 19);
2443 $LINK_MAP->insert ($exit->clone, 21, 20);
2444 $LINK_MAP->insert ($exit->clone, 21, 21);
2445
2446 $exit->destroy;
2447 }); 3398 },
2448 3399 );
2449 $LINK_MAP->{deny_save} = 1;
2450 $LINK_MAP->{deny_reset} = 1;
2451
2452 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2453} 3400}
2454 3401
2455register_command "reload" => sub { 3402register_command "reload" => sub {
2456 my ($who, $arg) = @_; 3403 my ($who, $arg) = @_;
2457 3404
2458 if ($who->flag (FLAG_WIZ)) { 3405 if ($who->flag (FLAG_WIZ)) {
2459 $who->message ("start of reload.");
2460 reload;
2461 $who->message ("end of reload."); 3406 $who->message ("reloading server.");
3407 async { reload_perl };
2462 } 3408 }
2463}; 3409};
2464 3410
2465unshift @INC, $LIBDIR; 3411unshift @INC, $LIBDIR;
2466 3412
3413my $bug_warning = 0;
3414
3415our @WAIT_FOR_TICK;
3416our @WAIT_FOR_TICK_BEGIN;
3417
3418sub wait_for_tick {
3419 return unless $TICK_WATCHER->is_active;
3420 return if $Coro::current == $Coro::main;
3421
3422 my $signal = new Coro::Signal;
3423 push @WAIT_FOR_TICK, $signal;
3424 $signal->wait;
3425}
3426
3427sub wait_for_tick_begin {
3428 return unless $TICK_WATCHER->is_active;
3429 return if $Coro::current == $Coro::main;
3430
3431 my $signal = new Coro::Signal;
3432 push @WAIT_FOR_TICK_BEGIN, $signal;
3433 $signal->wait;
3434}
3435
3436 my $min = 1e6;#d#
3437 my $avg = 10;
2467$TICK_WATCHER = Event->timer ( 3438$TICK_WATCHER = Event->timer (
2468 reentrant => 0, 3439 reentrant => 0,
3440 parked => 1,
2469 prio => 0, 3441 prio => 0,
2470 at => $NEXT_TICK || $TICK, 3442 at => $NEXT_TICK || $TICK,
2471 data => WF_AUTOCANCEL, 3443 data => WF_AUTOCANCEL,
2472 cb => sub { 3444 cb => sub {
3445 if ($Coro::current != $Coro::main) {
3446 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3447 unless ++$bug_warning > 10;
3448 return;
3449 }
3450
3451 $NOW = $tick_start = Event::time;
3452
2473 cf::server_tick; # one server iteration 3453 cf::server_tick; # one server iteration
3454
3455 0 && sync_job {#d#
3456 for(1..10) {
3457 my $t = Event::time;
3458 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3459 or die;
3460
3461 $map->width (50);
3462 $map->height (50);
3463 $map->alloc;
3464 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
3465 my $t = Event::time - $t;
3466
3467 #next unless $t < 0.0013;#d#
3468 if ($t < $min) {
3469 $min = $t;
3470 }
3471 $avg = $avg * 0.99 + $t * 0.01;
3472 }
3473 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3474 exit 0;
3475 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3476 };
3477
2474 $RUNTIME += $TICK; 3478 $RUNTIME += $TICK;
2475 $NEXT_TICK += $TICK; 3479 $NEXT_TICK += $TICK;
2476 3480
2477 $WAIT_FOR_TICK->broadcast; 3481 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2478 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3482 $NEXT_RUNTIME_WRITE = $NOW + 10;
3483 Coro::async_pool {
3484 write_runtime
3485 or warn "ERROR: unable to write runtime file: $!";
3486 };
3487 }
3488
3489# my $AFTER = Event::time;
3490# warn $AFTER - $NOW;#d#
3491
3492 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3493 $sig->send;
3494 }
3495 while (my $sig = shift @WAIT_FOR_TICK) {
3496 $sig->send;
3497 }
3498
3499 $NOW = Event::time;
2479 3500
2480 # if we are delayed by four ticks or more, skip them all 3501 # if we are delayed by four ticks or more, skip them all
2481 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3502 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2482 3503
2483 $TICK_WATCHER->at ($NEXT_TICK); 3504 $TICK_WATCHER->at ($NEXT_TICK);
2484 $TICK_WATCHER->start; 3505 $TICK_WATCHER->start;
3506
3507 $LOAD = ($NOW - $tick_start) / $TICK;
3508 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3509
3510 _post_tick;
3511
3512
2485 }, 3513 },
2486); 3514);
2487 3515
3516{
2488IO::AIO::max_poll_time $TICK * 0.2; 3517 BDB::max_poll_time $TICK * 0.1;
2489 3518 $BDB_POLL_WATCHER = Event->io (
2490Event->io ( 3519 reentrant => 0,
2491 fd => IO::AIO::poll_fileno, 3520 fd => BDB::poll_fileno,
2492 poll => 'r', 3521 poll => 'r',
2493 prio => 5, 3522 prio => 0,
2494 data => WF_AUTOCANCEL,
2495 cb => \&IO::AIO::poll_cb,
2496);
2497
2498Event->timer (
2499 data => WF_AUTOCANCEL, 3523 data => WF_AUTOCANCEL,
2500 after => 0, 3524 cb => \&BDB::poll_cb,
2501 interval => 10, 3525 );
2502 cb => sub { 3526 BDB::min_parallel 8;
2503 (Coro::unblock_sub { 3527
2504 write_runtime 3528 BDB::set_sync_prepare {
2505 or warn "ERROR: unable to write runtime file: $!"; 3529 my $status;
3530 my $current = $Coro::current;
3531 (
3532 sub {
3533 $status = $!;
3534 $current->ready; undef $current;
3535 },
3536 sub {
3537 Coro::schedule while defined $current;
3538 $! = $status;
3539 },
3540 )
3541 };
3542
3543 unless ($DB_ENV) {
3544 $DB_ENV = BDB::db_env_create;
3545
3546 cf::sync_job {
3547 eval {
3548 BDB::db_env_open
3549 $DB_ENV,
3550 $BDBDIR,
3551 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3552 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3553 0666;
3554
3555 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3556
3557 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3558 $DB_ENV->set_lk_detect;
3559 };
3560
3561 cf::cleanup "db_env_open(db): $@" if $@;
2506 })->(); 3562 };
2507 }, 3563 }
2508); 3564}
3565
3566{
3567 IO::AIO::min_parallel 8;
3568
3569 undef $Coro::AIO::WATCHER;
3570 IO::AIO::max_poll_time $TICK * 0.1;
3571 $AIO_POLL_WATCHER = Event->io (
3572 reentrant => 0,
3573 data => WF_AUTOCANCEL,
3574 fd => IO::AIO::poll_fileno,
3575 poll => 'r',
3576 prio => 6,
3577 cb => \&IO::AIO::poll_cb,
3578 );
3579}
3580
3581my $_log_backtrace;
3582
3583sub _log_backtrace {
3584 my ($msg, @addr) = @_;
3585
3586 $msg =~ s/\n//;
3587
3588 # limit the # of concurrent backtraces
3589 if ($_log_backtrace < 2) {
3590 ++$_log_backtrace;
3591 async {
3592 my @bt = fork_call {
3593 @addr = map { sprintf "%x", $_ } @addr;
3594 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3595 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3596 or die "addr2line: $!";
3597
3598 my @funcs;
3599 my @res = <$fh>;
3600 chomp for @res;
3601 while (@res) {
3602 my ($func, $line) = splice @res, 0, 2, ();
3603 push @funcs, "[$func] $line";
3604 }
3605
3606 @funcs
3607 };
3608
3609 LOG llevInfo, "[ABT] $msg\n";
3610 LOG llevInfo, "[ABT] $_\n" for @bt;
3611 --$_log_backtrace;
3612 };
3613 } else {
3614 LOG llevInfo, "[ABT] $msg\n";
3615 LOG llevInfo, "[ABT] [suppressed]\n";
3616 }
3617}
3618
3619# load additional modules
3620use cf::pod;
2509 3621
2510END { cf::emergency_save } 3622END { cf::emergency_save }
2511 3623
25121 36241
2513 3625

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines