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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines