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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines