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.112 by root, Mon Jan 1 13:31:47 2007 UTC vs.
Revision 1.366 by root, Tue Sep 11 16:05:35 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 if ($path =~ s{^\?random/}{}) {
295 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
296 $self->{random} = cf::from_json $data;
297 } else {
298 if ($path =~ s{^~([^/]+)?}{}) {
299 $self->{user_rel} = 1;
300
301 if (defined $1) {
302 $self->{user} = $1;
303 } elsif ($base =~ m{^~([^/]+)/}) {
304 $self->{user} = $1;
305 } else {
306 warn "cannot resolve user-relative path without user <$path,$base>\n";
307 }
308 } elsif ($path =~ /^\//) {
309 # already absolute
310 } else {
311 $base =~ s{[^/]+/?$}{};
312 return $class->new ("$base/$path");
313 }
314
315 for ($path) {
316 redo if s{/\.?/}{/};
317 redo if s{/[^/]+/\.\./}{/};
318 }
319 }
320
321 $self->{path} = $path;
322
323 $self
324}
325
326# the name / primary key / in-game path
327sub as_string {
328 my ($self) = @_;
329
330 $self->{user_rel} ? "~$self->{user}$self->{path}"
331 : $self->{random} ? "?random/$self->{path}"
332 : $self->{path}
333}
334
335# the displayed name, this is a one way mapping
336sub visible_name {
337 my ($self) = @_;
338
339# if (my $rmp = $self->{random}) {
340# # todo: be more intelligent about this
341# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
342# } else {
343 $self->as_string
344# }
345}
346
347# escape the /'s in the path
348sub _escaped_path {
349 # ∕ is U+2215
350 (my $path = $_[0]{path}) =~ s/\//∕/g;
351 $path
352}
353
354# the original (read-only) location
355sub load_path {
356 my ($self) = @_;
357
358 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
359}
360
361# the temporary/swap location
362sub save_path {
363 my ($self) = @_;
364
365 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
366 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
367 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
368}
369
370# the unique path, might be eq to save_path
371sub uniq_path {
372 my ($self) = @_;
373
374 $self->{user_rel} || $self->{random}
375 ? undef
376 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
377}
378
379# return random map parameters, or undef
380sub random_map_params {
381 my ($self) = @_;
382
383 $self->{random}
384}
385
386# this is somewhat ugly, but style maps do need special treatment
387sub is_style_map {
388 $_[0]{path} =~ m{^/styles/}
389}
390
391package cf;
392 646
393############################################################################# 647#############################################################################
394 648
395=head2 ATTACHABLE OBJECTS 649=head2 ATTACHABLE OBJECTS
396 650
398attach callbacks/event handlers (a collection of which is called an "attachment") 652attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 653to it. All such attachable objects support the following methods.
400 654
401In 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>
402C<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
403crossfire+). 657Crossfire TRT).
404 658
405=over 4 659=over 4
406 660
407=item $attachable->attach ($attachment, key => $value...) 661=item $attachable->attach ($attachment, key => $value...)
408 662
522our @CB_TYPE = (); # registry for type (cf-object class) based events 776our @CB_TYPE = (); # registry for type (cf-object class) based events
523our @CB_MAP = (); 777our @CB_MAP = ();
524 778
525my %attachment; 779my %attachment;
526 780
781sub cf::attachable::thawer_merge {
782 # simply override everything except _meta
783 local $_[0]{_meta};
784 %{$_[0]} = %{$_[1]};
785}
786
527sub _attach_cb($$$$) { 787sub _attach_cb($$$$) {
528 my ($registry, $event, $prio, $cb) = @_; 788 my ($registry, $event, $prio, $cb) = @_;
529 789
530 use sort 'stable'; 790 use sort 'stable';
531 791
565 $registry = $CB_TYPE[$object_type] ||= []; 825 $registry = $CB_TYPE[$object_type] ||= [];
566 826
567 } elsif ($type eq "subtype") { 827 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 828 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 829 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 830 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 831
572 } elsif ($type eq "package") { 832 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 833 my $pkg = shift @arg;
574 834
575 while (my ($name, $id) = each %cb_id) { 835 while (my ($name, $id) = each %cb_id) {
604 _attach $registry, $klass, @attach; 864 _attach $registry, $klass, @attach;
605 } 865 }
606 866
607 $obj->{$name} = \%arg; 867 $obj->{$name} = \%arg;
608 } else { 868 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 869 warn "object uses attachment '$name' which is not available, postponing.\n";
610 } 870 }
611 871
612 $obj->{_attachment}{$name} = undef; 872 $obj->{_attachment}{$name} = undef;
613} 873}
614 874
616 if (ref $_[0]) { 876 if (ref $_[0]) {
617 _object_attach @_; 877 _object_attach @_;
618 } else { 878 } else {
619 _attach shift->_attach_registry, @_; 879 _attach shift->_attach_registry, @_;
620 } 880 }
881 _recalc_want;
621}; 882};
622 883
623# all those should be optimised 884# all those should be optimised
624sub cf::attachable::detach { 885sub cf::attachable::detach {
625 my ($obj, $name) = @_; 886 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 889 delete $obj->{_attachment}{$name};
629 reattach ($obj); 890 reattach ($obj);
630 } else { 891 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 892 Carp::croak "cannot, currently, detach class attachments";
632 } 893 }
894 _recalc_want;
633}; 895};
634 896
635sub cf::attachable::attached { 897sub cf::attachable::attached {
636 my ($obj, $name) = @_; 898 my ($obj, $name) = @_;
637 899
652 "; 914 ";
653 die if $@; 915 die if $@;
654} 916}
655 917
656our $override; 918our $override;
657our @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?
658 920
659sub override { 921sub override {
660 $override = 1; 922 $override = 1;
661 @invoke_results = (); 923 @INVOKE_RESULTS = (@_);
662} 924}
663 925
664sub do_invoke { 926sub do_invoke {
665 my $event = shift; 927 my $event = shift;
666 my $callbacks = shift; 928 my $callbacks = shift;
667 929
668 @invoke_results = (); 930 @INVOKE_RESULTS = ();
669 931
670 local $override; 932 local $override;
671 933
672 for (@$callbacks) { 934 for (@$callbacks) {
673 eval { &{$_->[1]} }; 935 eval { &{$_->[1]} };
690 952
691Generate an object-specific event with the given arguments. 953Generate an object-specific event with the given arguments.
692 954
693This 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
694removed 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
695results (if you must, access C<@cf::invoke_results> directly). 957results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 958
697=back 959=back
698 960
699=cut 961=cut
700 962
701############################################################################# 963#############################################################################
702# 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}
703 976
704sub reattach { 977sub reattach {
705 # basically do the same as instantiate, without calling instantiate 978 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 979 my ($obj) = @_;
980
981 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
707 982
708 my $registry = $obj->registry; 983 my $registry = $obj->registry;
709 984
710 @$registry = (); 985 @$registry = ();
711 986
750); 1025);
751 1026
752sub object_freezer_save { 1027sub object_freezer_save {
753 my ($filename, $rdata, $objs) = @_; 1028 my ($filename, $rdata, $objs) = @_;
754 1029
1030 my $guard = cf::lock_acquire "io";
1031
755 sync_job { 1032 sync_job {
756 if (length $$rdata) { 1033 if (length $$rdata) {
1034 utf8::decode (my $decname = $filename);
757 warn sprintf "saving %s (%d,%d)\n", 1035 warn sprintf "saving %s (%d,%d)\n",
758 $filename, length $$rdata, scalar @$objs; 1036 $decname, length $$rdata, scalar @$objs;
759 1037
760 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1038 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
761 chmod SAVE_MODE, $fh; 1039 chmod SAVE_MODE, $fh;
762 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1040 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
763 aio_fsync $fh; 1041 aio_fsync $fh if $cf::USE_FSYNC;
764 close $fh; 1042 close $fh;
765 1043
766 if (@$objs) { 1044 if (@$objs) {
767 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) {
768 chmod SAVE_MODE, $fh; 1046 chmod SAVE_MODE, $fh;
769 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1047 my $data = Storable::nfreeze { version => 1, objs => $objs };
770 aio_write $fh, 0, (length $data), $data, 0; 1048 aio_write $fh, 0, (length $data), $data, 0;
771 aio_fsync $fh; 1049 aio_fsync $fh if $cf::USE_FSYNC;
772 close $fh; 1050 close $fh;
773 aio_rename "$filename.pst~", "$filename.pst"; 1051 aio_rename "$filename.pst~", "$filename.pst";
774 } 1052 }
775 } else { 1053 } else {
776 aio_unlink "$filename.pst"; 1054 aio_unlink "$filename.pst";
782 } 1060 }
783 } else { 1061 } else {
784 aio_unlink $filename; 1062 aio_unlink $filename;
785 aio_unlink "$filename.pst"; 1063 aio_unlink "$filename.pst";
786 } 1064 }
787 } 1065 };
1066
1067 undef $guard;
788} 1068}
789 1069
790sub object_freezer_as_string { 1070sub object_freezer_as_string {
791 my ($rdata, $objs) = @_; 1071 my ($rdata, $objs) = @_;
792 1072
797 1077
798sub object_thawer_load { 1078sub object_thawer_load {
799 my ($filename) = @_; 1079 my ($filename) = @_;
800 1080
801 my ($data, $av); 1081 my ($data, $av);
1082
1083 my $guard = cf::lock_acquire "io";
802 1084
803 (aio_load $filename, $data) >= 0 1085 (aio_load $filename, $data) >= 0
804 or return; 1086 or return;
805 1087
806 unless (aio_stat "$filename.pst") { 1088 unless (aio_stat "$filename.pst") {
807 (aio_load "$filename.pst", $av) >= 0 1089 (aio_load "$filename.pst", $av) >= 0
808 or return; 1090 or return;
1091
1092 undef $guard;
809 $av = eval { (Storable::thaw <$av>)->{objs} }; 1093 $av = eval { (Storable::thaw $av)->{objs} };
810 } 1094 }
811 1095
1096 utf8::decode (my $decname = $filename);
1097 warn sprintf "loading %s (%d,%d)\n",
1098 $decname, length $data, scalar @{$av || []};
1099
812 return ($data, $av); 1100 ($data, $av)
813} 1101}
1102
1103=head2 COMMAND CALLBACKS
1104
1105=over 4
1106
1107=cut
814 1108
815############################################################################# 1109#############################################################################
816# command handling &c 1110# command handling &c
817 1111
818=item cf::register_command $name => \&callback($ob,$args); 1112=item cf::register_command $name => \&callback($ob,$args);
831 push @{ $COMMAND{$name} }, [$caller, $cb]; 1125 push @{ $COMMAND{$name} }, [$caller, $cb];
832} 1126}
833 1127
834=item cf::register_extcmd $name => \&callback($pl,$packet); 1128=item cf::register_extcmd $name => \&callback($pl,$packet);
835 1129
836Register 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.
837 1135
838If 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
839called. 1137called.
840 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
841=cut 1150=cut
842 1151
843sub register_extcmd { 1152sub register_extcmd {
844 my ($name, $cb) = @_; 1153 my ($name, $cb) = @_;
845 1154
846 my $caller = caller;
847 #warn "registering extcmd '$name' to '$caller'";
848
849 $EXTCMD{$name} = [$cb, $caller]; 1155 $EXTCMD{$name} = $cb;
1156}
1157
1158sub register_exticmd {
1159 my ($name, $cb) = @_;
1160
1161 $EXTICMD{$name} = $cb;
850} 1162}
851 1163
852cf::player->attach ( 1164cf::player->attach (
853 on_command => sub { 1165 on_command => sub {
854 my ($pl, $name, $params) = @_; 1166 my ($pl, $name, $params) = @_;
863 cf::override; 1175 cf::override;
864 }, 1176 },
865 on_extcmd => sub { 1177 on_extcmd => sub {
866 my ($pl, $buf) = @_; 1178 my ($pl, $buf) = @_;
867 1179
868 my $msg = eval { from_json $buf }; 1180 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
869 1181
870 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
871 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1190 if (my $cb = $EXTCMD{$type}) {
872 if (my %reply = $cb->[0]->($pl, $msg)) { 1191 @reply = $cb->($pl, @payload);
873 $pl->ext_reply ($msg->{msgid}, %reply);
874 }
875 } 1192 }
1193
1194 $pl->ext_reply ($reply, @reply)
1195 if $reply;
1196
876 } else { 1197 } else {
877 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
878 } 1199 }
879 1200
880 cf::override; 1201 cf::override;
881 }, 1202 },
882); 1203);
883 1204
884sub register {
885 my ($base, $pkg) = @_;
886
887 #TODO
888}
889
890sub 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($) {
891 my ($path) = @_; 1603 my ($path) = @_;
892 1604
893 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1605 my ($match, $specificity);
894 my $base = $1;
895 my $pkg = $1;
896 $pkg =~ s/[^[:word:]]/_/g;
897 $pkg = "ext::$pkg";
898 1606
899 warn "loading '$path' into '$pkg'\n"; 1607 for my $region (list) {
900 1608 if ($region->{match} && $path =~ $region->{match}) {
901 open my $fh, "<:utf8", $path 1609 ($match, $specificity) = ($region, $region->specificity)
902 or die "$path: $!"; 1610 if $region->specificity > $specificity;
903 1611 }
904 my $source =
905 "package $pkg; use strict; use utf8;\n"
906 . "#line 1 \"$path\"\n{\n"
907 . (do { local $/; <$fh> })
908 . "\n};\n1";
909
910 eval $source
911 or die $@ ? "$path: $@\n"
912 : "extension disabled.\n";
913
914 push @exts, $pkg;
915 $ext_pkg{$base} = $pkg;
916
917# no strict 'refs';
918# @{"$pkg\::ISA"} = ext::;
919
920 register $base, $pkg;
921}
922
923sub unload_extension {
924 my ($pkg) = @_;
925
926 warn "removing extension $pkg\n";
927
928 # remove hooks
929 #TODO
930# for my $idx (0 .. $#PLUGIN_EVENT) {
931# delete $hook[$idx]{$pkg};
932# } 1612 }
933 1613
934 # remove commands 1614 $match
935 for my $name (keys %COMMAND) {
936 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
937
938 if (@cb) {
939 $COMMAND{$name} = \@cb;
940 } else {
941 delete $COMMAND{$name};
942 }
943 }
944
945 # remove extcmds
946 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
947 delete $EXTCMD{$name};
948 }
949
950 if (my $cb = $pkg->can ("unload")) {
951 eval {
952 $cb->($pkg);
953 1
954 } or warn "$pkg unloaded, but with errors: $@";
955 }
956
957 Symbol::delete_package $pkg;
958}
959
960sub load_extensions {
961 for my $ext (<$LIBDIR/*.ext>) {
962 next unless -r $ext;
963 eval {
964 load_extension $ext;
965 1
966 } or warn "$ext not loaded: $@";
967 }
968}
969
970#############################################################################
971# load/save/clean perl data associated with a map
972
973*cf::mapsupport::on_clean = sub {
974 my ($map) = @_;
975
976 my $path = $map->tmpname;
977 defined $path or return;
978
979 unlink "$path.pst";
980};
981
982cf::map->attach (prio => -10000, package => cf::mapsupport::);
983
984#############################################################################
985# load/save perl data associated with player->ob objects
986
987sub all_objects(@) {
988 @_, map all_objects ($_->inv), @_
989}
990
991# TODO: compatibility cruft, remove when no longer needed
992cf::player->attach (
993 on_load => sub {
994 my ($pl, $path) = @_;
995
996 for my $o (all_objects $pl->ob) {
997 if (my $value = $o->get_ob_key_value ("_perl_data")) {
998 $o->set_ob_key_value ("_perl_data");
999
1000 %$o = %{ Storable::thaw pack "H*", $value };
1001 }
1002 }
1003 },
1004);
1005
1006#############################################################################
1007
1008=head2 CORE EXTENSIONS
1009
1010Functions and methods that extend core crossfire objects.
1011
1012=head3 cf::player
1013
1014=over 4
1015
1016=item cf::player::exists $login
1017
1018Returns true when the given account exists.
1019
1020=cut
1021
1022sub cf::player::exists($) {
1023 cf::player::find $_[0]
1024 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1025}
1026
1027=item $player->ext_reply ($msgid, $msgtype, %msg)
1028
1029Sends an ext reply to the player.
1030
1031=cut
1032
1033sub cf::player::ext_reply($$$%) {
1034 my ($self, $id, %msg) = @_;
1035
1036 $msg{msgid} = $id;
1037
1038 $self->send ("ext " . to_json \%msg);
1039} 1615}
1040 1616
1041=back 1617=back
1042
1043 1618
1044=head3 cf::map 1619=head3 cf::map
1045 1620
1046=over 4 1621=over 4
1047 1622
1050package cf::map; 1625package cf::map;
1051 1626
1052use Fcntl; 1627use Fcntl;
1053use Coro::AIO; 1628use Coro::AIO;
1054 1629
1630use overload
1631 '""' => \&as_string,
1632 fallback => 1;
1633
1055our $MAX_RESET = 7200; 1634our $MAX_RESET = 3600;
1056our $DEFAULT_RESET = 3600; 1635our $DEFAULT_RESET = 3000;
1057 1636
1058sub generate_random_map { 1637sub generate_random_map {
1059 my ($path, $rmp) = @_; 1638 my ($self, $rmp) = @_;
1060
1061 # mit "rum" bekleckern, nicht 1639 # mit "rum" bekleckern, nicht
1062 cf::map::_create_random_map 1640 $self->_create_random_map (
1063 $path,
1064 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1641 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1065 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1642 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1066 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1643 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1067 $rmp->{exit_on_final_map}, 1644 $rmp->{exit_on_final_map},
1068 $rmp->{xsize}, $rmp->{ysize}, 1645 $rmp->{xsize}, $rmp->{ysize},
1069 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1646 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1070 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1647 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1071 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1648 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1072 $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},
1073 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1650 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1074 (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"
1075} 1780}
1076 1781
1077# and all this just because we cannot iterate over 1782# and all this just because we cannot iterate over
1078# all maps in C++... 1783# all maps in C++...
1079sub change_all_map_light { 1784sub change_all_map_light {
1080 my ($change) = @_; 1785 my ($change) = @_;
1081 1786
1082 $_->change_map_light ($change) for values %cf::MAP; 1787 $_->change_map_light ($change)
1788 for grep $_->outdoor, values %cf::MAP;
1083} 1789}
1084 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
1085sub try_load_header($) { 1807sub load_header_from($) {
1086 my ($path) = @_; 1808 my ($self, $path) = @_;
1087 1809
1088 utf8::encode $path; 1810 utf8::encode $path;
1089 aio_open $path, O_RDONLY, 0 1811 my $f = new_from_file cf::object::thawer $path
1090 or return; 1812 or return;
1091 1813
1092 my $map = cf::map::new 1814 $self->_load_header ($f)
1093 or return; 1815 or return;
1094 1816
1095 $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
1096 or return; 1863 or return;
1864 $self->prepare_orig;
1865 }
1097 1866
1098 $map->{load_path} = $path; 1867 $self->{deny_reset} = 1
1868 if $self->no_reset;
1099 1869
1100 $map 1870 $self->default_region (cf::region::find_by_path $self->{path})
1101} 1871 unless $self->default_region;
1102 1872
1873 1
1874}
1875
1876sub find;
1103sub find_map { 1877sub find {
1104 my ($path, $origin) = @_; 1878 my ($path, $origin) = @_;
1105 1879
1106 #warn "find_map<$path,$origin>\n";#d#
1107
1108 $path = new cf::path $path, $origin && $origin->path; 1880 $path = normalise $path, $origin && $origin->path;
1109 my $key = $path->as_string;
1110 1881
1882 cf::lock_wait "map_data:$path";#d#remove
1883 cf::lock_wait "map_find:$path";
1884
1111 $cf::MAP{$key} || do { 1885 $cf::MAP{$path} || do {
1112 # do it the slow way 1886 my $guard1 = cf::lock_acquire "map_find:$path";
1113 my $map = try_load_header $path->save_path; 1887 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1114 1888
1115 if ($map) { 1889 my $map = new_from_path cf::map $path
1116 # safety
1117 $map->{instantiate_time} = $cf::RUNTIME
1118 if $map->{instantiate_time} > $cf::RUNTIME;
1119 } else {
1120 if (my $rmp = $path->random_map_params) {
1121 $map = generate_random_map $key, $rmp;
1122 } else {
1123 $map = try_load_header $path->load_path;
1124 }
1125
1126 $map or return; 1890 or return;
1127 1891
1128 $map->{load_original} = 1;
1129 $map->{instantiate_time} = $cf::RUNTIME;
1130 $map->instantiate;
1131
1132 # per-player maps become, after loading, normal maps
1133 $map->per_player (0) if $path->{user_rel};
1134 }
1135
1136 $map->path ($key);
1137 $map->{path} = $path;
1138 $map->last_access ($cf::RUNTIME); 1892 $map->{last_save} = $cf::RUNTIME;
1139 1893
1140 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;
1141 $map->reset; 1902 $map->reset;
1142 $map = find_map $path; 1903 return find $path;
1143 } 1904 }
1144 1905
1145 $cf::MAP{$key} = $map 1906 $cf::MAP{$path} = $map
1146 } 1907 }
1147} 1908}
1909
1910sub pre_load { }
1911sub post_load { }
1148 1912
1149sub load { 1913sub load {
1150 my ($self) = @_; 1914 my ($self) = @_;
1151 1915
1152 return if $self->in_memory != cf::MAP_SWAPPED; 1916 local $self->{deny_reset} = 1; # loading can take a long time
1153
1154 $self->in_memory (cf::MAP_LOADING);
1155 1917
1156 my $path = $self->{path}; 1918 my $path = $self->{path};
1157 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
1158 $self->alloc; 1928 $self->alloc;
1159 $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)
1160 or return; 1936 or return;
1161 1937
1162 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1938 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1163 if delete $self->{load_original}; 1939 if delete $self->{load_original};
1164 1940
1165 if (my $uniq = $path->uniq_path) { 1941 if (my $uniq = $self->uniq_path) {
1166 utf8::encode $uniq; 1942 utf8::encode $uniq;
1167 if (aio_open $uniq, O_RDONLY, 0) { 1943 unless (aio_stat $uniq) {
1944 if (my $f = new_from_file cf::object::thawer $uniq) {
1168 $self->clear_unique_items; 1945 $self->clear_unique_items;
1169 $self->load_objects ($uniq, 0); 1946 $self->_load_objects ($f);
1947 $f->resolve_delayed_derefs;
1948 }
1170 } 1949 }
1171 } 1950 }
1172 1951
1952 $f->resolve_delayed_derefs;
1953
1954 cf::cede_to_tick;
1173 # now do the right thing for maps 1955 # now do the right thing for maps
1174 $self->link_multipart_objects; 1956 $self->link_multipart_objects;
1175
1176 if ($self->{path}->is_style_map) {
1177 $self->{deny_save} = 1;
1178 $self->{deny_reset} = 1;
1179 } else {
1180 $self->fix_auto_apply;
1181 $self->decay_objects;
1182 $self->update_buttons;
1183 $self->set_darkness_map;
1184 $self->difficulty ($self->estimate_difficulty) 1957 $self->difficulty ($self->estimate_difficulty)
1185 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;
1186 $self->activate; 1968 $self->activate;
1187 } 1969 }
1188 1970
1971 $self->{last_save} = $cf::RUNTIME;
1972 $self->last_access ($cf::RUNTIME);
1973
1189 $self->in_memory (cf::MAP_IN_MEMORY); 1974 $self->in_memory (cf::MAP_IN_MEMORY);
1190} 1975 }
1191 1976
1192sub 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 {
1193 my ($path, $origin) = @_; 2019 my ($path, $origin) = @_;
1194 2020
1195 #warn "load_map_sync<$path, $origin>\n";#d# 2021 cf::sync_job { find $path, $origin }
2022}
1196 2023
1197 cf::sync_job { 2024sub do_load_sync {
1198 my $map = cf::map::find_map $path, $origin 2025 my ($map) = @_;
1199 or return; 2026
1200 $map->load; 2027 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1201 $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;
1202 } 2058 };
2059 $MAP_PREFETCHER->prio (6);
2060
2061 ()
1203} 2062}
1204 2063
1205sub save { 2064sub save {
1206 my ($self) = @_; 2065 my ($self) = @_;
1207 2066
1208 my $save = $self->{path}->save_path; utf8::encode $save; 2067 my $lock = cf::lock_acquire "map_data:$self->{path}";
1209 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1210 2068
1211 $self->{last_save} = $cf::RUNTIME; 2069 $self->{last_save} = $cf::RUNTIME;
1212 2070
1213 return unless $self->dirty; 2071 return unless $self->dirty;
1214 2072
2073 my $save = $self->save_path; utf8::encode $save;
2074 my $uniq = $self->uniq_path; utf8::encode $uniq;
2075
1215 $self->{load_path} = $save; 2076 $self->{load_path} = $save;
1216 2077
1217 return if $self->{deny_save}; 2078 return if $self->{deny_save};
1218 2079
2080 local $self->{last_access} = $self->last_access;#d#
2081
2082 cf::async {
2083 $_->contr->save for $self->players;
2084 };
2085
1219 if ($uniq) { 2086 if ($uniq) {
1220 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2087 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1221 $self->save_objects ($uniq, cf::IO_UNIQUES); 2088 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1222 } else { 2089 } else {
1223 $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);
1224 } 2091 }
1225} 2092}
1226 2093
1227sub swap_out { 2094sub swap_out {
1228 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}";
1229 2101
1230 return if $self->players; 2102 return if $self->players;
1231 return if $self->in_memory != cf::MAP_IN_MEMORY; 2103 return if $self->in_memory != cf::MAP_IN_MEMORY;
1232 return if $self->{deny_save}; 2104 return if $self->{deny_save};
1233 2105
2106 $self->in_memory (cf::MAP_SWAPPED);
2107
1234 $self->save; 2108 $self->deactivate;
2109 $_->clear_links_to ($self) for values %cf::MAP;
1235 $self->clear; 2110 $self->clear;
1236 $self->in_memory (cf::MAP_SWAPPED);
1237} 2111}
1238 2112
1239sub reset_at { 2113sub reset_at {
1240 my ($self) = @_; 2114 my ($self) = @_;
1241 2115
1242 # TODO: safety, remove and allow resettable per-player maps 2116 # TODO: safety, remove and allow resettable per-player maps
1243 return 1e100 if $self->{path}{user_rel};
1244 return 1e100 if $self->{deny_reset}; 2117 return 1e99 if $self->{deny_reset};
1245 2118
1246 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2119 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1247 my $to = $self->reset_timeout || $DEFAULT_RESET; 2120 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1248 $to = $MAX_RESET if $to > $MAX_RESET;
1249 2121
1250 $time + $to 2122 $time + $to
1251} 2123}
1252 2124
1253sub should_reset { 2125sub should_reset {
1254 my ($self) = @_; 2126 my ($self) = @_;
1255 2127
1256 $self->reset_at <= $cf::RUNTIME 2128 $self->reset_at <= $cf::RUNTIME
1257} 2129}
1258 2130
1259sub unlink_save {
1260 my ($self) = @_;
1261
1262 utf8::encode (my $save = $self->{path}->save_path);
1263 aioreq_pri 3; IO::AIO::aio_unlink $save;
1264 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1265}
1266
1267sub reset { 2131sub reset {
1268 my ($self) = @_; 2132 my ($self) = @_;
1269 2133
2134 my $lock = cf::lock_acquire "map_data:$self->{path}";
2135
1270 return if $self->players; 2136 return if $self->players;
1271 return if $self->{path}{user_rel};#d#
1272 2137
1273 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 }
1274 2149
1275 delete $cf::MAP{$self->path}; 2150 delete $cf::MAP{$self->path};
1276 2151
2152 $self->deactivate;
1277 $_->clear_links_to ($self) for values %cf::MAP; 2153 $_->clear_links_to ($self) for values %cf::MAP;
2154 $self->clear;
1278 2155
1279 $self->unlink_save; 2156 $self->unlink_save;
1280 $self->destroy; 2157 $self->destroy;
1281} 2158}
1282 2159
1283sub customise_for { 2160my $nuke_counter = "aaaa";
1284 my ($map, $ob) = @_;
1285 2161
1286 if ($map->per_player) { 2162sub nuke {
1287 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2163 my ($self) = @_;
2164
1288 } 2165 {
2166 my $lock = cf::lock_acquire "map_data:$self->{path}";
1289 2167
1290 $map 2168 delete $cf::MAP{$self->path};
1291}
1292 2169
1293sub emergency_save { 2170 $self->unlink_save;
1294 local $cf::FREEZE = 1;
1295 2171
1296 warn "enter emergency map save\n"; 2172 bless $self, "cf::map";
2173 delete $self->{deny_reset};
2174 $self->{deny_save} = 1;
2175 $self->reset_timeout (1);
2176 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1297 2177
1298 cf::sync_job { 2178 $cf::MAP{$self->path} = $self;
1299 warn "begin emergency map save\n";
1300 $_->save for values %cf::MAP;
1301 }; 2179 }
1302 2180
1303 warn "end emergency map save\n"; 2181 $self->reset; # polite request, might not happen
2182}
2183
2184=item $maps = cf::map::tmp_maps
2185
2186Returns an arrayref with all map paths of currently instantiated and saved
2187maps. May block.
2188
2189=cut
2190
2191sub tmp_maps() {
2192 [
2193 map {
2194 utf8::decode $_;
2195 /\.map$/
2196 ? normalise $_
2197 : ()
2198 } @{ aio_readdir $TMPDIR or [] }
2199 ]
2200}
2201
2202=item $maps = cf::map::random_maps
2203
2204Returns an arrayref with all map paths of currently instantiated and saved
2205random maps. May block.
2206
2207=cut
2208
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 ]
1304} 2236}
1305 2237
1306package cf; 2238package cf;
1307 2239
1308=back 2240=back
1309 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
1310 2299
1311=head3 cf::object::player 2300=head3 cf::object::player
1312 2301
1313=over 4 2302=over 4
1314 2303
1328 2317
1329 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2318 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1330 2319
1331 if ($self->{record_replies}) { 2320 if ($self->{record_replies}) {
1332 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2321 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2322
1333 } 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 {
1334 $msg = $npc->name . " says: $msg" if $npc; 2331 $msg = $npc->name . " says: $msg" if $npc;
1335 $self->message ($msg, $flags); 2332 $self->message ($msg, $flags);
2333 }
1336 } 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 (@_);
1337} 2345}
1338 2346
1339=item $player_object->may ("access") 2347=item $player_object->may ("access")
1340 2348
1341Returns wether the given player is authorized to access resource "access" 2349Returns wether the given player is authorized to access resource "access"
1350 (ref $cf::CFG{"may_$access"} 2358 (ref $cf::CFG{"may_$access"}
1351 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2359 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1352 : $cf::CFG{"may_$access"}) 2360 : $cf::CFG{"may_$access"})
1353} 2361}
1354 2362
2363=item $player_object->enter_link
2364
2365Freezes the player and moves him/her to a special map (C<{link}>).
2366
2367The player should be reasonably safe there for short amounts of time. You
2368I<MUST> call C<leave_link> as soon as possible, though.
2369
2370Will never block.
2371
2372=item $player_object->leave_link ($map, $x, $y)
2373
2374Moves the player out of the special C<{link}> map onto the specified
2375map. If the map is not valid (or omitted), the player will be moved back
2376to the location he/she was before the call to C<enter_link>, or, if that
2377fails, to the emergency map position.
2378
2379Might block.
2380
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}
2392
1355sub cf::object::player::enter_link { 2393sub cf::object::player::enter_link {
1356 my ($self) = @_; 2394 my ($self) = @_;
1357 2395
1358 return if $self->map == $LINK_MAP;
1359
1360 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1361 if $self->map;
1362
1363 $self->enter_map ($LINK_MAP, 20, 20);
1364 $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);
1365} 2404}
1366 2405
1367sub cf::object::player::leave_link { 2406sub cf::object::player::leave_link {
1368 my ($self, $map, $x, $y) = @_; 2407 my ($self, $map, $x, $y) = @_;
1369 2408
2409 return unless $self->contr->active;
2410
1370 my $link_pos = delete $self->{_link_pos}; 2411 my $link_pos = delete $self->{_link_pos};
1371 2412
1372 unless ($map) { 2413 unless ($map) {
1373 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1374
1375 # restore original map position 2414 # restore original map position
1376 ($map, $x, $y) = @{ $link_pos || [] }; 2415 ($map, $x, $y) = @{ $link_pos || [] };
1377 $map = cf::map::find_map $map; 2416 $map = cf::map::find $map;
1378 2417
1379 unless ($map) { 2418 unless ($map) {
1380 ($map, $x, $y) = @$EMERGENCY_POSITION; 2419 ($map, $x, $y) = @$EMERGENCY_POSITION;
1381 $map = cf::map::find_map $map 2420 $map = cf::map::find $map
1382 or die "FATAL: cannot load emergency map\n"; 2421 or die "FATAL: cannot load emergency map\n";
1383 } 2422 }
1384 } 2423 }
1385 2424
1386 ($x, $y) = (-1, -1) 2425 ($x, $y) = (-1, -1)
1389 # use -1 or undef as default coordinates, not 0, 0 2428 # use -1 or undef as default coordinates, not 0, 0
1390 ($x, $y) = ($map->enter_x, $map->enter_y) 2429 ($x, $y) = ($map->enter_x, $map->enter_y)
1391 if $x <=0 && $y <= 0; 2430 if $x <=0 && $y <= 0;
1392 2431
1393 $map->load; 2432 $map->load;
2433 $map->load_neighbours;
1394 2434
2435 return unless $self->contr->active;
1395 $self->activate_recursive; 2436 $self->activate_recursive;
2437
2438 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1396 $self->enter_map ($map, $x, $y); 2439 $self->enter_map ($map, $x, $y);
1397} 2440}
1398 2441
1399=item $player_object->goto_map ($map, $x, $y) 2442=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1400 2443
1401=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.
1402 2449
2450=cut
2451
2452our $GOTOGEN;
2453
1403sub cf::object::player::goto_map { 2454sub cf::object::player::goto {
1404 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;
1405 2459
1406 $self->enter_link; 2460 $self->enter_link;
1407 2461
1408 (Coro::async { 2462 (async {
1409 $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];
1410 2467
2468 # todo: use ob_blocked to check all tiles of the destination "object"
2469 # for suitability.
2470
2471 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2472 }
2473 }
2474
2475 my $map = eval {
1411 my $map = cf::map::find_map $path->as_string; 2476 my $map = cf::map::find $path;
2477
2478 if ($map) {
1412 $map = $map->customise_for ($self) if $map; 2479 $map = $map->customise_for ($self);
2480 $map = $check->($map) if $check && $map;
2481 } else {
2482 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2483 }
1413 2484
1414 warn "entering ", $map->path, " at ($x, $y)\n"
1415 if $map; 2485 $map
2486 };
1416 2487
2488 if ($@) {
2489 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2490 LOG llevError | logBacktrace, Carp::longmess $@;
2491 }
2492
2493 if ($gen == $self->{_goto_generation}) {
2494 delete $self->{_goto_generation};
1417 $self->leave_link ($map, $x, $y); 2495 $self->leave_link ($map, $x, $y);
2496 }
2497
2498 $done->() if $done;
1418 })->prio (1); 2499 })->prio (1);
1419} 2500}
1420 2501
1421=item $player_object->enter_exit ($exit_object) 2502=item $player_object->enter_exit ($exit_object)
1422 2503
1424 2505
1425sub parse_random_map_params { 2506sub parse_random_map_params {
1426 my ($spec) = @_; 2507 my ($spec) = @_;
1427 2508
1428 my $rmp = { # defaults 2509 my $rmp = { # defaults
1429 xsize => 10, 2510 xsize => (cf::rndm 15, 40),
1430 ysize => 10, 2511 ysize => (cf::rndm 15, 40),
2512 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2513 #layout => string,
1431 }; 2514 };
1432 2515
1433 for (split /\n/, $spec) { 2516 for (split /\n/, $spec) {
1434 my ($k, $v) = split /\s+/, $_, 2; 2517 my ($k, $v) = split /\s+/, $_, 2;
1435 2518
1439 $rmp 2522 $rmp
1440} 2523}
1441 2524
1442sub prepare_random_map { 2525sub prepare_random_map {
1443 my ($exit) = @_; 2526 my ($exit) = @_;
2527
2528 my $guard = cf::lock_acquire "exit_prepare:$exit";
1444 2529
1445 # all this does is basically replace the /! path by 2530 # all this does is basically replace the /! path by
1446 # a new random map path (?random/...) with a seed 2531 # a new random map path (?random/...) with a seed
1447 # that depends on the exit object 2532 # that depends on the exit object
1448 2533
1449 my $rmp = parse_random_map_params $exit->msg; 2534 my $rmp = parse_random_map_params $exit->msg;
1450 2535
1451 if ($exit->map) { 2536 if ($exit->map) {
1452 $rmp->{region} = $exit->map->region_name; 2537 $rmp->{region} = $exit->region->name;
1453 $rmp->{origin_map} = $exit->map->path; 2538 $rmp->{origin_map} = $exit->map->path;
1454 $rmp->{origin_x} = $exit->x; 2539 $rmp->{origin_x} = $exit->x;
1455 $rmp->{origin_y} = $exit->y; 2540 $rmp->{origin_y} = $exit->y;
1456 } 2541 }
1457 2542
1458 $rmp->{random_seed} ||= $exit->random_seed; 2543 $rmp->{random_seed} ||= $exit->random_seed;
1459 2544
1460 my $data = cf::to_json $rmp; 2545 my $data = cf::to_json $rmp;
1461 my $md5 = Digest::MD5::md5_hex $data; 2546 my $md5 = Digest::MD5::md5_hex $data;
2547 my $meta = "$RANDOMDIR/$md5.meta";
1462 2548
1463 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2549 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1464 aio_write $fh, 0, (length $data), $data, 0; 2550 aio_write $fh, 0, (length $data), $data, 0;
2551 undef $fh;
2552 aio_rename "$meta~", $meta;
1465 2553
1466 $exit->slaying ("?random/$md5"); 2554 $exit->slaying ("?random/$md5");
1467 $exit->msg (undef); 2555 $exit->msg (undef);
1468 } 2556 }
1469} 2557}
1471sub cf::object::player::enter_exit { 2559sub cf::object::player::enter_exit {
1472 my ($self, $exit) = @_; 2560 my ($self, $exit) = @_;
1473 2561
1474 return unless $self->type == cf::PLAYER; 2562 return unless $self->type == cf::PLAYER;
1475 2563
2564 if ($exit->slaying eq "/!") {
2565 #TODO: this should de-fi-ni-te-ly not be a sync-job
2566 # the problem is that $exit might not survive long enough
2567 # so it needs to be done right now, right here
2568 cf::sync_job { prepare_random_map $exit };
2569 }
2570
2571 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2572 my $hp = $exit->stats->hp;
2573 my $sp = $exit->stats->sp;
2574
1476 $self->enter_link; 2575 $self->enter_link;
1477 2576
2577 # if exit is damned, update players death & WoR home-position
2578 $self->contr->savebed ($slaying, $hp, $sp)
2579 if $exit->flag (FLAG_DAMNED);
2580
1478 (Coro::async { 2581 (async {
2582 $self->deactivate_recursive; # just to be sure
1479 unless (eval { 2583 unless (eval {
1480 2584 $self->goto ($slaying, $hp, $sp);
1481 prepare_random_map $exit
1482 if $exit->slaying eq "/!";
1483
1484 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1485 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1486 2585
1487 1; 2586 1;
1488 }) { 2587 }) {
1489 $self->message ("Something went wrong deep within the crossfire server. " 2588 $self->message ("Something went wrong deep within the crossfire server. "
1490 . "I'll try to bring you back to the map you were before. " 2589 . "I'll try to bring you back to the map you were before. "
1491 . "Please report this to the dungeon master", 2590 . "Please report this to the dungeon master!",
1492 cf::NDI_UNIQUE | cf::NDI_RED); 2591 cf::NDI_UNIQUE | cf::NDI_RED);
1493 2592
1494 warn "ERROR in enter_exit: $@"; 2593 warn "ERROR in enter_exit: $@";
1495 $self->leave_link; 2594 $self->leave_link;
1496 } 2595 }
1497 })->prio (1); 2596 })->prio (1);
1510 2609
1511sub cf::client::send_drawinfo { 2610sub cf::client::send_drawinfo {
1512 my ($self, $text, $flags) = @_; 2611 my ($self, $text, $flags) = @_;
1513 2612
1514 utf8::encode $text; 2613 utf8::encode $text;
1515 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2614 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1516} 2615}
1517 2616
2617=item $client->send_msg ($channel, $msg, $color, [extra...])
2618
2619Send a drawinfo or msg packet to the client, formatting the msg for the
2620client if neccessary. C<$type> should be a string identifying the type of
2621the message, with C<log> being the default. If C<$color> is negative, suppress
2622the message unless the client supports the msg packet.
2623
2624=cut
2625
2626our %CHANNEL = (
2627 "c/identify" => {
2628 id => "identify",
2629 title => "Identify",
2630 reply => undef,
2631 tooltip => "Items recently identified",
2632 },
2633 "c/examine" => {
2634 id => "examine",
2635 title => "Examine",
2636 reply => undef,
2637 tooltip => "Signs and other items you examined",
2638 },
2639);
2640
2641sub cf::client::send_msg {
2642 my ($self, $channel, $msg, $color, @extra) = @_;
2643
2644 $msg = $self->pl->expand_cfpod ($msg);
2645
2646 $color &= cf::NDI_CLIENT_MASK; # just in case...
2647
2648 # check predefined channels, for the benefit of C
2649 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2650
2651 if (ref $channel) {
2652 # send meta info to client, if not yet sent
2653 unless (exists $self->{channel}{$channel->{id}}) {
2654 $self->{channel}{$channel->{id}} = $channel;
2655 $self->ext_msg (channel_info => $channel)
2656 if $self->can_msg;
2657 }
2658
2659 $channel = $channel->{id};
2660 }
2661
2662 return unless @extra || length $msg;
2663
2664 if ($self->can_msg) {
2665 # default colour, mask it out
2666 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2667 if $color & cf::NDI_DEF;
2668
2669 $self->send_packet ("msg " . $self->{json_coder}->encode (
2670 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2671 } else {
2672 if ($color >= 0) {
2673 # replace some tags by gcfclient-compatible ones
2674 for ($msg) {
2675 1 while
2676 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2677 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2678 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2679 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2680 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2681 }
2682
2683 $color &= cf::NDI_COLOR_MASK;
2684
2685 utf8::encode $msg;
2686
2687 if (0 && $msg =~ /\[/) {
2688 # COMMAND/INFO
2689 $self->send_packet ("drawextinfo $color 10 8 $msg")
2690 } else {
2691 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2692 $self->send_packet ("drawinfo $color $msg")
2693 }
2694 }
2695 }
2696}
2697
2698=item $client->ext_msg ($type, @msg)
2699
2700Sends an ext event to the client.
2701
2702=cut
2703
2704sub cf::client::ext_msg($$@) {
2705 my ($self, $type, @msg) = @_;
2706
2707 if ($self->extcmd == 2) {
2708 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2709 } elsif ($self->extcmd == 1) { # TODO: remove
2710 push @msg, msgtype => "event_$type";
2711 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2712 }
2713}
2714
2715=item $client->ext_reply ($msgid, @msg)
2716
2717Sends an ext reply to the client.
2718
2719=cut
2720
2721sub cf::client::ext_reply($$@) {
2722 my ($self, $id, @msg) = @_;
2723
2724 if ($self->extcmd == 2) {
2725 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2726 } elsif ($self->extcmd == 1) {
2727 #TODO: version 1, remove
2728 unshift @msg, msgtype => "reply", msgid => $id;
2729 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2730 }
2731}
1518 2732
1519=item $success = $client->query ($flags, "text", \&cb) 2733=item $success = $client->query ($flags, "text", \&cb)
1520 2734
1521Queues a query to the client, calling the given callback with 2735Queues a query to the client, calling the given callback with
1522the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2736the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1523C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2737C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1524 2738
1525Queries can fail, so check the return code. Or don't, as queries will become 2739Queries can fail, so check the return code. Or don't, as queries will
1526reliable at some point in the future. 2740become reliable at some point in the future.
1527 2741
1528=cut 2742=cut
1529 2743
1530sub cf::client::query { 2744sub cf::client::query {
1531 my ($self, $flags, $text, $cb) = @_; 2745 my ($self, $flags, $text, $cb) = @_;
1539 utf8::encode $text; 2753 utf8::encode $text;
1540 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2754 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1541 2755
1542 $self->send_packet ($self->{query_queue}[0][0]) 2756 $self->send_packet ($self->{query_queue}[0][0])
1543 if @{ $self->{query_queue} } == 1; 2757 if @{ $self->{query_queue} } == 1;
2758
2759 1
1544} 2760}
1545 2761
1546cf::client->attach ( 2762cf::client->attach (
2763 on_connect => sub {
2764 my ($ns) = @_;
2765
2766 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2767 },
1547 on_reply => sub { 2768 on_reply => sub {
1548 my ($ns, $msg) = @_; 2769 my ($ns, $msg) = @_;
1549 2770
1550 # this weird shuffling is so that direct followup queries 2771 # this weird shuffling is so that direct followup queries
1551 # get handled first 2772 # get handled first
1552 my $queue = delete $ns->{query_queue}; 2773 my $queue = delete $ns->{query_queue}
2774 or return; # be conservative, not sure how that can happen, but we saw a crash here
1553 2775
1554 (shift @$queue)->[1]->($msg); 2776 (shift @$queue)->[1]->($msg);
2777 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1555 2778
1556 push @{ $ns->{query_queue} }, @$queue; 2779 push @{ $ns->{query_queue} }, @$queue;
1557 2780
1558 if (@{ $ns->{query_queue} } == @$queue) { 2781 if (@{ $ns->{query_queue} } == @$queue) {
1559 if (@$queue) { 2782 if (@$queue) {
1561 } else { 2784 } else {
1562 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2785 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1563 } 2786 }
1564 } 2787 }
1565 }, 2788 },
2789 on_exticmd => sub {
2790 my ($ns, $buf) = @_;
2791
2792 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2793
2794 if (ref $msg) {
2795 my ($type, $reply, @payload) =
2796 "ARRAY" eq ref $msg
2797 ? @$msg
2798 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2799
2800 my @reply;
2801
2802 if (my $cb = $EXTICMD{$type}) {
2803 @reply = $cb->($ns, @payload);
2804 }
2805
2806 $ns->ext_reply ($reply, @reply)
2807 if $reply;
2808
2809 } else {
2810 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2811 }
2812
2813 cf::override;
2814 },
1566); 2815);
1567 2816
1568=item $client->coro (\&cb) 2817=item $client->async (\&cb)
1569 2818
1570Create a new coroutine, running the specified callback. The coroutine will 2819Create a new coroutine, running the specified callback. The coroutine will
1571be automatically cancelled when the client gets destroyed (e.g. on logout, 2820be automatically cancelled when the client gets destroyed (e.g. on logout,
1572or loss of connection). 2821or loss of connection).
1573 2822
1574=cut 2823=cut
1575 2824
1576sub cf::client::coro { 2825sub cf::client::async {
1577 my ($self, $cb) = @_; 2826 my ($self, $cb) = @_;
1578 2827
1579 my $coro; $coro = async { 2828 my $coro = &Coro::async ($cb);
1580 eval {
1581 $cb->();
1582 };
1583 warn $@ if $@;
1584 };
1585 2829
1586 $coro->on_destroy (sub { 2830 $coro->on_destroy (sub {
1587 delete $self->{_coro}{$coro+0}; 2831 delete $self->{_coro}{$coro+0};
1588 }); 2832 });
1589 2833
1616our $safe = new Safe "safe"; 2860our $safe = new Safe "safe";
1617our $safe_hole = new Safe::Hole; 2861our $safe_hole = new Safe::Hole;
1618 2862
1619$SIG{FPE} = 'IGNORE'; 2863$SIG{FPE} = 'IGNORE';
1620 2864
1621$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2865$safe->permit_only (Opcode::opset qw(
2866 :base_core :base_mem :base_orig :base_math
2867 grepstart grepwhile mapstart mapwhile
2868 sort time
2869));
1622 2870
1623# here we export the classes and methods available to script code 2871# here we export the classes and methods available to script code
1624 2872
1625=pod 2873=pod
1626 2874
1627The following fucntions and emthods are available within a safe environment: 2875The following functions and methods are available within a safe environment:
1628 2876
1629 cf::object contr pay_amount pay_player map 2877 cf::object
2878 contr pay_amount pay_player map x y force_find force_add
2879 insert remove name archname title slaying race decrease_ob_nr
2880
1630 cf::object::player player 2881 cf::object::player
1631 cf::player peaceful 2882 player
1632 cf::map trigger 2883
2884 cf::player
2885 peaceful
2886
2887 cf::map
2888 trigger
1633 2889
1634=cut 2890=cut
1635 2891
1636for ( 2892for (
1637 ["cf::object" => qw(contr pay_amount pay_player map)], 2893 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2894 insert remove inv name archname title slaying race
2895 decrease_ob_nr)],
1638 ["cf::object::player" => qw(player)], 2896 ["cf::object::player" => qw(player)],
1639 ["cf::player" => qw(peaceful)], 2897 ["cf::player" => qw(peaceful)],
1640 ["cf::map" => qw(trigger)], 2898 ["cf::map" => qw(trigger)],
1641) { 2899) {
1642 no strict 'refs'; 2900 no strict 'refs';
1713=back 2971=back
1714 2972
1715=cut 2973=cut
1716 2974
1717############################################################################# 2975#############################################################################
2976# the server's init and main functions
1718 2977
1719=head2 EXTENSION DATABASE SUPPORT 2978sub load_facedata($) {
2979 my ($path) = @_;
1720 2980
1721Crossfire maintains a very simple database for extension use. It can 2981 # HACK to clear player env face cache, we need some signal framework
1722currently store anything that can be serialised using Storable, which 2982 # for this (global event?)
1723excludes objects. 2983 %ext::player_env::MUSIC_FACE_CACHE = ();
1724 2984
1725The parameter C<$family> should best start with the name of the extension 2985 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1726using it, it should be unique.
1727 2986
1728=over 4 2987 warn "loading facedata from $path\n";
1729 2988
1730=item $hashref = cf::db_get $family 2989 my $facedata;
2990 0 < aio_load $path, $facedata
2991 or die "$path: $!";
1731 2992
1732Return a hashref for use by the extension C<$family>, which can be 2993 $facedata = Coro::Storable::thaw $facedata;
1733modified. After modifications, you have to call C<cf::db_dirty> or
1734C<cf::db_sync>.
1735 2994
1736=item $value = cf::db_get $family => $key 2995 $facedata->{version} == 2
2996 or cf::cleanup "$path: version mismatch, cannot proceed.";
1737 2997
1738Returns a single value from the database 2998 # patch in the exptable
1739 2999 $facedata->{resource}{"res/exp_table"} = {
1740=item cf::db_put $family => $hashref 3000 type => FT_RSRC,
1741 3001 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1742Stores the given family hashref into the database. Updates are delayed, if
1743you want the data to be synced to disk immediately, use C<cf::db_sync>.
1744
1745=item cf::db_put $family => $key => $value
1746
1747Stores the given C<$value> in the family hash. Updates are delayed, if you
1748want the data to be synced to disk immediately, use C<cf::db_sync>.
1749
1750=item cf::db_dirty
1751
1752Marks the database as dirty, to be updated at a later time.
1753
1754=item cf::db_sync
1755
1756Immediately write the database to disk I<if it is dirty>.
1757
1758=cut
1759
1760our $DB;
1761
1762{
1763 my $path = cf::localdir . "/database.pst";
1764
1765 sub db_load() {
1766 warn "loading database $path\n";#d# remove later
1767 $DB = stat $path ? Storable::retrieve $path : { };
1768 }
1769
1770 my $pid;
1771
1772 sub db_save() {
1773 warn "saving database $path\n";#d# remove later
1774 waitpid $pid, 0 if $pid;
1775 if (0 == ($pid = fork)) {
1776 $DB->{_meta}{version} = 1;
1777 Storable::nstore $DB, "$path~";
1778 rename "$path~", $path;
1779 cf::_exit 0 if defined $pid;
1780 }
1781 }
1782
1783 my $dirty;
1784
1785 sub db_sync() {
1786 db_save if $dirty;
1787 undef $dirty;
1788 }
1789
1790 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1791 db_sync;
1792 }); 3002 };
3003 cf::cede_to_tick;
1793 3004
1794 sub db_dirty() {
1795 $dirty = 1;
1796 $idle->start;
1797 } 3005 {
3006 my $faces = $facedata->{faceinfo};
1798 3007
1799 sub db_get($;$) { 3008 while (my ($face, $info) = each %$faces) {
1800 @_ >= 2 3009 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1801 ? $DB->{$_[0]}{$_[1]} 3010 cf::face::set_visibility $idx, $info->{visibility};
1802 : ($DB->{$_[0]} ||= { }) 3011 cf::face::set_magicmap $idx, $info->{magicmap};
1803 } 3012 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
3013 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1804 3014
1805 sub db_put($$;$) { 3015 cf::cede_to_tick;
1806 if (@_ >= 3) {
1807 $DB->{$_[0]}{$_[1]} = $_[2];
1808 } else {
1809 $DB->{$_[0]} = $_[1];
1810 }
1811 db_dirty;
1812 }
1813
1814 cf::global->attach (
1815 prio => 10000,
1816 on_cleanup => sub {
1817 db_sync;
1818 }, 3016 }
1819 );
1820}
1821 3017
1822############################################################################# 3018 while (my ($face, $info) = each %$faces) {
1823# the server's main() 3019 next unless $info->{smooth};
3020 my $idx = cf::face::find $face
3021 or next;
3022 if (my $smooth = cf::face::find $info->{smooth}) {
3023 cf::face::set_smooth $idx, $smooth;
3024 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3025 } else {
3026 warn "smooth face '$info->{smooth}' not found for face '$face'";
3027 }
1824 3028
1825sub cfg_load { 3029 cf::cede_to_tick;
3030 }
3031 }
3032
3033 {
3034 my $anims = $facedata->{animinfo};
3035
3036 while (my ($anim, $info) = each %$anims) {
3037 cf::anim::set $anim, $info->{frames}, $info->{facings};
3038 cf::cede_to_tick;
3039 }
3040
3041 cf::anim::invalidate_all; # d'oh
3042 }
3043
3044 {
3045 # TODO: for gcfclient pleasure, we should give resources
3046 # that gcfclient doesn't grok a >10000 face index.
3047 my $res = $facedata->{resource};
3048
3049 my $soundconf = delete $res->{"res/sound.conf"};
3050
3051 while (my ($name, $info) = each %$res) {
3052 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3053 my $data;
3054
3055 if ($info->{type} & 1) {
3056 # prepend meta info
3057
3058 my $meta = $enc->encode ({
3059 name => $name,
3060 %{ $info->{meta} || {} },
3061 });
3062
3063 $data = pack "(w/a*)*", $meta, $info->{data};
3064 } else {
3065 $data = $info->{data};
3066 }
3067
3068 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3069 cf::face::set_type $idx, $info->{type};
3070
3071 cf::cede_to_tick;
3072 }
3073
3074 if ($soundconf) {
3075 $soundconf = $enc->decode (delete $soundconf->{data});
3076
3077 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3078 my $sound = $soundconf->{compat}[$_]
3079 or next;
3080
3081 my $face = cf::face::find "sound/$sound->[1]";
3082 cf::sound::set $sound->[0] => $face;
3083 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3084 }
3085
3086 while (my ($k, $v) = each %{$soundconf->{event}}) {
3087 my $face = cf::face::find "sound/$v";
3088 cf::sound::set $k => $face;
3089 }
3090 }
3091 }
3092
3093 1
3094}
3095
3096register_exticmd fx_want => sub {
3097 my ($ns, $want) = @_;
3098
3099 while (my ($k, $v) = each %$want) {
3100 $ns->fx_want ($k, $v);
3101 }
3102};
3103
3104sub reload_regions {
3105 # HACK to clear player env face cache, we need some signal framework
3106 # for this (global event?)
3107 %ext::player_env::MUSIC_FACE_CACHE = ();
3108
3109 load_resource_file "$MAPDIR/regions"
3110 or die "unable to load regions file\n";
3111
3112 for (cf::region::list) {
3113 $_->{match} = qr/$_->{match}/
3114 if exists $_->{match};
3115 }
3116}
3117
3118sub reload_facedata {
3119 load_facedata "$DATADIR/facedata"
3120 or die "unable to load facedata\n";
3121}
3122
3123sub reload_archetypes {
3124 load_resource_file "$DATADIR/archetypes"
3125 or die "unable to load archetypes\n";
3126 #d# NEED to laod twice to resolve forward references
3127 # this really needs to be done in an extra post-pass
3128 # (which needs to be synchronous, so solve it differently)
3129 load_resource_file "$DATADIR/archetypes"
3130 or die "unable to load archetypes\n";
3131}
3132
3133sub reload_treasures {
3134 load_resource_file "$DATADIR/treasures"
3135 or die "unable to load treasurelists\n";
3136}
3137
3138sub reload_resources {
3139 warn "reloading resource files...\n";
3140
3141 reload_regions;
3142 reload_facedata;
3143 #reload_archetypes;#d#
3144 reload_archetypes;
3145 reload_treasures;
3146
3147 warn "finished reloading resource files\n";
3148}
3149
3150sub init {
3151 reload_resources;
3152}
3153
3154sub reload_config {
1826 open my $fh, "<:utf8", cf::confdir . "/config" 3155 open my $fh, "<:utf8", "$CONFDIR/config"
1827 or return; 3156 or return;
1828 3157
1829 local $/; 3158 local $/;
1830 *CFG = YAML::Syck::Load <$fh>; 3159 *CFG = YAML::Syck::Load <$fh>;
3160
3161 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3162
3163 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3164 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3165
3166 if (exists $CFG{mlockall}) {
3167 eval {
3168 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3169 and die "WARNING: m(un)lockall failed: $!\n";
3170 };
3171 warn $@ if $@;
3172 }
1831} 3173}
1832 3174
1833sub main { 3175sub main {
1834 # we must not ever block the main coroutine 3176 # we must not ever block the main coroutine
1835 local $Coro::idle = sub { 3177 local $Coro::idle = sub {
1836 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3178 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1837 (Coro::unblock_sub { 3179 (async {
1838 Event::one_event; 3180 Event::one_event;
1839 })->(); 3181 })->prio (Coro::PRIO_MAX);
1840 }; 3182 };
1841 3183
1842 cfg_load; 3184 reload_config;
1843 db_load; 3185 db_init;
1844 load_extensions; 3186 load_extensions;
3187
3188 $TICK_WATCHER->start;
1845 Event::loop; 3189 Event::loop;
1846} 3190}
1847 3191
1848############################################################################# 3192#############################################################################
1849# initialisation 3193# initialisation and cleanup
1850 3194
3195# install some emergency cleanup handlers
3196BEGIN {
3197 for my $signal (qw(INT HUP TERM)) {
3198 Event->signal (
3199 reentrant => 0,
3200 data => WF_AUTOCANCEL,
3201 signal => $signal,
3202 prio => 0,
3203 cb => sub {
3204 cf::cleanup "SIG$signal";
3205 },
3206 );
3207 }
3208}
3209
3210sub write_runtime {
3211 my $runtime = "$LOCALDIR/runtime";
3212
3213 # first touch the runtime file to show we are still running:
3214 # the fsync below can take a very very long time.
3215
3216 IO::AIO::aio_utime $runtime, undef, undef;
3217
3218 my $guard = cf::lock_acquire "write_runtime";
3219
3220 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3221 or return;
3222
3223 my $value = $cf::RUNTIME + 90 + 10;
3224 # 10 is the runtime save interval, for a monotonic clock
3225 # 60 allows for the watchdog to kill the server.
3226
3227 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3228 and return;
3229
3230 # always fsync - this file is important
3231 aio_fsync $fh
3232 and return;
3233
3234 # touch it again to show we are up-to-date
3235 aio_utime $fh, undef, undef;
3236
3237 close $fh
3238 or return;
3239
3240 aio_rename "$runtime~", $runtime
3241 and return;
3242
3243 warn "runtime file written.\n";
3244
3245 1
3246}
3247
3248sub emergency_save() {
3249 my $freeze_guard = cf::freeze_mainloop;
3250
3251 warn "enter emergency perl save\n";
3252
3253 cf::sync_job {
3254 # use a peculiar iteration method to avoid tripping on perl
3255 # refcount bugs in for. also avoids problems with players
3256 # and maps saved/destroyed asynchronously.
3257 warn "begin emergency player save\n";
3258 for my $login (keys %cf::PLAYER) {
3259 my $pl = $cf::PLAYER{$login} or next;
3260 $pl->valid or next;
3261 $pl->save;
3262 }
3263 warn "end emergency player save\n";
3264
3265 warn "begin emergency map save\n";
3266 for my $path (keys %cf::MAP) {
3267 my $map = $cf::MAP{$path} or next;
3268 $map->valid or next;
3269 $map->save;
3270 }
3271 warn "end emergency map save\n";
3272
3273 warn "begin emergency database checkpoint\n";
3274 BDB::db_env_txn_checkpoint $DB_ENV;
3275 warn "end emergency database checkpoint\n";
3276 };
3277
3278 warn "leave emergency perl save\n";
3279}
3280
3281sub post_cleanup {
3282 my ($make_core) = @_;
3283
3284 warn Carp::longmess "post_cleanup backtrace"
3285 if $make_core;
3286}
3287
1851sub reload() { 3288sub do_reload_perl() {
1852 # can/must only be called in main 3289 # can/must only be called in main
1853 if ($Coro::current != $Coro::main) { 3290 if ($Coro::current != $Coro::main) {
1854 warn "can only reload from main coroutine\n"; 3291 warn "can only reload from main coroutine";
1855 return; 3292 return;
1856 } 3293 }
1857 3294
1858 warn "reloading..."; 3295 warn "reloading...";
1859 3296
1860 local $FREEZE = 1; 3297 warn "entering sync_job";
3298
3299 cf::sync_job {
3300 cf::write_runtime; # external watchdog should not bark
1861 cf::emergency_save; 3301 cf::emergency_save;
3302 cf::write_runtime; # external watchdog should not bark
1862 3303
1863 eval { 3304 warn "syncing database to disk";
3305 BDB::db_env_txn_checkpoint $DB_ENV;
3306
1864 # if anything goes wrong in here, we should simply crash as we already saved 3307 # if anything goes wrong in here, we should simply crash as we already saved
1865 3308
1866 # cancel all watchers 3309 warn "cancelling all WF_AUTOCANCEL watchers";
1867 for (Event::all_watchers) { 3310 for (Event::all_watchers) {
1868 $_->cancel if $_->data & WF_AUTOCANCEL; 3311 $_->cancel if $_->data & WF_AUTOCANCEL;
1869 } 3312 }
1870 3313
3314 warn "flushing outstanding aio requests";
3315 for (;;) {
3316 BDB::flush;
3317 IO::AIO::flush;
3318 Coro::cede;
3319 last unless IO::AIO::nreqs || BDB::nreqs;
3320 warn "iterate...";
3321 }
3322
3323 ++$RELOAD;
3324
1871 # cancel all extension coros 3325 warn "cancelling all extension coros";
1872 $_->cancel for values %EXT_CORO; 3326 $_->cancel for values %EXT_CORO;
1873 %EXT_CORO = (); 3327 %EXT_CORO = ();
1874 3328
1875 # unload all extensions 3329 warn "removing commands";
1876 for (@exts) { 3330 %COMMAND = ();
3331
3332 warn "removing ext/exti commands";
3333 %EXTCMD = ();
3334 %EXTICMD = ();
3335
3336 warn "unloading/nuking all extensions";
3337 for my $pkg (@EXTS) {
1877 warn "unloading <$_>"; 3338 warn "... unloading $pkg";
1878 unload_extension $_; 3339
3340 if (my $cb = $pkg->can ("unload")) {
3341 eval {
3342 $cb->($pkg);
3343 1
3344 } or warn "$pkg unloaded, but with errors: $@";
1879 } 3345 }
1880 3346
3347 warn "... nuking $pkg";
3348 Symbol::delete_package $pkg;
3349 }
3350
1881 # unload all modules loaded from $LIBDIR 3351 warn "unloading all perl modules loaded from $LIBDIR";
1882 while (my ($k, $v) = each %INC) { 3352 while (my ($k, $v) = each %INC) {
1883 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3353 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1884 3354
1885 warn "removing <$k>"; 3355 warn "... unloading $k";
1886 delete $INC{$k}; 3356 delete $INC{$k};
1887 3357
1888 $k =~ s/\.pm$//; 3358 $k =~ s/\.pm$//;
1889 $k =~ s/\//::/g; 3359 $k =~ s/\//::/g;
1890 3360
1893 } 3363 }
1894 3364
1895 Symbol::delete_package $k; 3365 Symbol::delete_package $k;
1896 } 3366 }
1897 3367
1898 # sync database to disk
1899 cf::db_sync;
1900 IO::AIO::flush;
1901
1902 # get rid of safe::, as good as possible 3368 warn "getting rid of safe::, as good as possible";
1903 Symbol::delete_package "safe::$_" 3369 Symbol::delete_package "safe::$_"
1904 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3370 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1905 3371
1906 # remove register_script_function callbacks
1907 # TODO
1908
1909 # unload cf.pm "a bit" 3372 warn "unloading cf.pm \"a bit\"";
1910 delete $INC{"cf.pm"}; 3373 delete $INC{"cf.pm"};
3374 delete $INC{"cf/pod.pm"};
1911 3375
1912 # don't, removes xs symbols, too, 3376 # don't, removes xs symbols, too,
1913 # and global variables created in xs 3377 # and global variables created in xs
1914 #Symbol::delete_package __PACKAGE__; 3378 #Symbol::delete_package __PACKAGE__;
1915 3379
1916 # reload cf.pm 3380 warn "unload completed, starting to reload now";
3381
1917 warn "reloading cf.pm"; 3382 warn "reloading cf.pm";
1918 require cf; 3383 require cf;
1919 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3384 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1920 3385
1921 # load config and database again 3386 warn "loading config and database again";
1922 cf::cfg_load; 3387 cf::reload_config;
1923 cf::db_load;
1924 3388
1925 # load extensions
1926 warn "load extensions"; 3389 warn "loading extensions";
1927 cf::load_extensions; 3390 cf::load_extensions;
1928 3391
1929 # reattach attachments to objects 3392 warn "reattaching attachments to objects/players";
1930 warn "reattach"; 3393 _global_reattach; # objects, sockets
1931 _global_reattach; 3394 warn "reattaching attachments to maps";
1932 }; 3395 reattach $_ for values %MAP;
3396 warn "reattaching attachments to players";
3397 reattach $_ for values %PLAYER;
1933 3398
1934 if ($@) { 3399 warn "leaving sync_job";
3400
3401 1
3402 } or do {
1935 warn $@; 3403 warn $@;
1936 warn "error while reloading, exiting."; 3404 warn "error while reloading, exiting.";
1937 exit 1; 3405 exit 1;
1938 } 3406 };
1939 3407
1940 warn "reloaded successfully"; 3408 warn "reloaded";
1941}; 3409};
1942 3410
1943############################################################################# 3411our $RELOAD_WATCHER; # used only during reload
1944 3412
1945unless ($LINK_MAP) { 3413sub reload_perl() {
1946 $LINK_MAP = cf::map::new; 3414 # doing reload synchronously and two reloads happen back-to-back,
3415 # coro crashes during coro_state_free->destroy here.
1947 3416
1948 $LINK_MAP->width (41); 3417 $RELOAD_WATCHER ||= Event->timer (
1949 $LINK_MAP->height (41); 3418 reentrant => 0,
1950 $LINK_MAP->alloc;
1951 $LINK_MAP->path ("{link}");
1952 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1953 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1954
1955 # dirty hack because... archetypes are not yet loaded
1956 Event->timer (
1957 after => 2, 3419 after => 0,
3420 data => WF_AUTOCANCEL,
1958 cb => sub { 3421 cb => sub {
1959 $_[0]->w->cancel; 3422 do_reload_perl;
1960 3423 undef $RELOAD_WATCHER;
1961 # provide some exits "home"
1962 my $exit = cf::object::new "exit";
1963
1964 $exit->slaying ($EMERGENCY_POSITION->[0]);
1965 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1966 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
1967
1968 $LINK_MAP->insert ($exit->clone, 19, 19);
1969 $LINK_MAP->insert ($exit->clone, 19, 20);
1970 $LINK_MAP->insert ($exit->clone, 19, 21);
1971 $LINK_MAP->insert ($exit->clone, 20, 19);
1972 $LINK_MAP->insert ($exit->clone, 20, 21);
1973 $LINK_MAP->insert ($exit->clone, 21, 19);
1974 $LINK_MAP->insert ($exit->clone, 21, 20);
1975 $LINK_MAP->insert ($exit->clone, 21, 21);
1976
1977 $exit->destroy;
1978 }); 3424 },
1979 3425 );
1980 $LINK_MAP->{deny_save} = 1;
1981 $LINK_MAP->{deny_reset} = 1;
1982
1983 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1984} 3426}
1985
1986register "<global>", __PACKAGE__;
1987 3427
1988register_command "reload" => sub { 3428register_command "reload" => sub {
1989 my ($who, $arg) = @_; 3429 my ($who, $arg) = @_;
1990 3430
1991 if ($who->flag (FLAG_WIZ)) { 3431 if ($who->flag (FLAG_WIZ)) {
1992 $who->message ("start of reload.");
1993 reload;
1994 $who->message ("end of reload."); 3432 $who->message ("reloading server.");
3433 async { reload_perl };
1995 } 3434 }
1996}; 3435};
1997 3436
1998unshift @INC, $LIBDIR; 3437unshift @INC, $LIBDIR;
3438
3439my $bug_warning = 0;
3440
3441our @WAIT_FOR_TICK;
3442our @WAIT_FOR_TICK_BEGIN;
3443
3444sub wait_for_tick {
3445 return unless $TICK_WATCHER->is_active;
3446 return if $Coro::current == $Coro::main;
3447
3448 my $signal = new Coro::Signal;
3449 push @WAIT_FOR_TICK, $signal;
3450 $signal->wait;
3451}
3452
3453sub wait_for_tick_begin {
3454 return unless $TICK_WATCHER->is_active;
3455 return if $Coro::current == $Coro::main;
3456
3457 my $signal = new Coro::Signal;
3458 push @WAIT_FOR_TICK_BEGIN, $signal;
3459 $signal->wait;
3460}
3461
3462our $stat_fh;
3463sysopen $stat_fh, "/tmp/cfstats", Fcntl::O_APPEND | Fcntl::O_CREAT | Fcntl::O_WRONLY, 0600;#d#
1999 3464
2000$TICK_WATCHER = Event->timer ( 3465$TICK_WATCHER = Event->timer (
2001 reentrant => 0, 3466 reentrant => 0,
3467 parked => 1,
2002 prio => 0, 3468 prio => 0,
2003 at => $NEXT_TICK || $TICK, 3469 at => $NEXT_TICK || $TICK,
2004 data => WF_AUTOCANCEL, 3470 data => WF_AUTOCANCEL,
2005 cb => sub { 3471 cb => sub {
2006 unless ($FREEZE) { 3472 if ($Coro::current != $Coro::main) {
3473 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3474 unless ++$bug_warning > 10;
3475 return;
3476 }
3477
3478 my @pl = cf::player::list; my $stats = sprintf "%.2f %d %d %d", $RUNTIME, (scalar @pl), cf::object::actives_size, cf::object::objects_size; #d#
3479
3480 $NOW = $tick_start = Event::time;
3481
2007 cf::server_tick; # one server iteration 3482 cf::server_tick; # one server iteration
3483
2008 $RUNTIME += $TICK; 3484 $RUNTIME += $TICK;
2009 }
2010
2011 $NEXT_TICK += $TICK; 3485 $NEXT_TICK += $TICK;
2012 3486
3487 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3488 $NEXT_RUNTIME_WRITE = $NOW + 10;
3489 Coro::async_pool {
3490 write_runtime
3491 or warn "ERROR: unable to write runtime file: $!";
3492 };
3493 }
3494
3495# my $AFTER = Event::time;
3496# warn $AFTER - $NOW;#d#
3497
3498 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3499 $sig->send;
3500 }
3501 while (my $sig = shift @WAIT_FOR_TICK) {
3502 $sig->send;
3503 }
3504
3505 $NOW = Event::time;
3506
2013 # if we are delayed by four ticks or more, skip them all 3507 # if we are delayed by four ticks or more, skip them all
2014 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3508 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2015 3509
2016 $TICK_WATCHER->at ($NEXT_TICK); 3510 $TICK_WATCHER->at ($NEXT_TICK);
2017 $TICK_WATCHER->start; 3511 $TICK_WATCHER->start;
3512
3513 $LOAD = ($NOW - $tick_start) / $TICK;
3514 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3515
3516 _post_tick;
3517
3518 # gather some statistics#d#
3519 $stats .= sprintf " %d\n", 10000 * ($NOW - $tick_start);#d#
3520 IO::AIO::aio_write $stat_fh, undef, undef, $stats, 0;#d#
2018 }, 3521 },
2019); 3522);
2020 3523
3524{
3525 BDB::min_parallel 8;
2021IO::AIO::max_poll_time $TICK * 0.2; 3526 BDB::max_poll_time $TICK * 0.1;
2022 3527 $BDB_POLL_WATCHER = Event->io (
2023Event->io ( 3528 reentrant => 0,
2024 fd => IO::AIO::poll_fileno, 3529 fd => BDB::poll_fileno,
2025 poll => 'r', 3530 poll => 'r',
2026 prio => 5, 3531 prio => 0,
2027 data => WF_AUTOCANCEL,
2028 cb => \&IO::AIO::poll_cb,
2029);
2030
2031Event->timer (
2032 data => WF_AUTOCANCEL, 3532 data => WF_AUTOCANCEL,
3533 cb => \&BDB::poll_cb,
3534 );
3535
3536 BDB::set_sync_prepare {
3537 my $status;
3538 my $current = $Coro::current;
3539 (
3540 sub {
3541 $status = $!;
3542 $current->ready; undef $current;
3543 },
3544 sub {
3545 Coro::schedule while defined $current;
3546 $! = $status;
3547 },
3548 )
3549 };
3550
3551 unless ($DB_ENV) {
3552 $DB_ENV = BDB::db_env_create;
3553
3554 cf::sync_job {
3555 eval {
3556 BDB::db_env_open
3557 $DB_ENV,
3558 $BDBDIR,
3559 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3560 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3561 0666;
3562
3563 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3564
3565 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3566 | BDB::LOG_AUTOREMOVE, 1);
3567 $DB_ENV->set_lk_detect;
3568 };
3569
3570 cf::cleanup "db_env_open(db): $@" if $@;
3571 };
3572 }
3573
3574 $BDB_CHECKPOINT_WATCHER = Event->timer (
2033 after => 0, 3575 after => 11,
2034 interval => 10, 3576 interval => 60,
3577 hard => 1,
3578 prio => 0,
3579 data => WF_AUTOCANCEL,
2035 cb => sub { 3580 cb => sub {
2036 (Coro::unblock_sub { 3581 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2037 write_runtime 3582 },
2038 or warn "ERROR: unable to write runtime file: $!"; 3583 );
3584 $BDB_TRICKLE_WATCHER = Event->timer (
3585 after => 5,
3586 interval => 10,
3587 hard => 1,
3588 prio => 0,
3589 data => WF_AUTOCANCEL,
3590 cb => sub {
3591 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3592 },
3593 );
3594}
3595
3596{
3597 IO::AIO::min_parallel 8;
3598
3599 undef $Coro::AIO::WATCHER;
3600 IO::AIO::max_poll_time $TICK * 0.1;
3601 $AIO_POLL_WATCHER = Event->io (
3602 reentrant => 0,
3603 data => WF_AUTOCANCEL,
3604 fd => IO::AIO::poll_fileno,
3605 poll => 'r',
3606 prio => 6,
3607 cb => \&IO::AIO::poll_cb,
3608 );
3609}
3610
3611my $_log_backtrace;
3612
3613sub _log_backtrace {
3614 my ($msg, @addr) = @_;
3615
3616 $msg =~ s/\n//;
3617
3618 # limit the # of concurrent backtraces
3619 if ($_log_backtrace < 2) {
3620 ++$_log_backtrace;
3621 async {
3622 my @bt = fork_call {
3623 @addr = map { sprintf "%x", $_ } @addr;
3624 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3625 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3626 or die "addr2line: $!";
3627
3628 my @funcs;
3629 my @res = <$fh>;
3630 chomp for @res;
3631 while (@res) {
3632 my ($func, $line) = splice @res, 0, 2, ();
3633 push @funcs, "[$func] $line";
3634 }
3635
3636 @funcs
3637 };
3638
3639 LOG llevInfo, "[ABT] $msg\n";
3640 LOG llevInfo, "[ABT] $_\n" for @bt;
3641 --$_log_backtrace;
2039 })->(); 3642 };
3643 } else {
3644 LOG llevInfo, "[ABT] $msg\n";
3645 LOG llevInfo, "[ABT] [suppressed]\n";
2040 }, 3646 }
2041); 3647}
3648
3649# load additional modules
3650use cf::pod;
3651
3652END { cf::emergency_save }
2042 3653
20431 36541
2044 3655

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines