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.159 by root, Wed Jan 10 22:50:12 2007 UTC vs.
Revision 1.355 by root, Sun Sep 2 12:45:44 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines