ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines