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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines