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.146 by root, Sun Jan 7 23:10:43 2007 UTC vs.
Revision 1.343 by root, Mon Aug 27 01:13:48 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines