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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines