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.356 by root, Tue Sep 4 05:43:21 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines