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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines