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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines