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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines