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.126 by root, Tue Jan 2 23:12:47 2007 UTC vs.
Revision 1.344 by root, Mon Aug 27 02:43:38 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines