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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines