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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines