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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines