ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines