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.337 by root, Tue Aug 21 00:54:01 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines