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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines