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.140 by root, Fri Jan 5 20:04:02 2007 UTC vs.
Revision 1.345 by root, Tue Aug 28 19:30:11 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines