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.119 by root, Tue Jan 2 08:26:42 2007 UTC vs.
Revision 1.385 by root, Fri Oct 12 19:13:26 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines