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.141 by root, Fri Jan 5 20:08:53 2007 UTC vs.
Revision 1.373 by root, Sat Sep 15 15:58:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines