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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.390 by root, Thu Oct 25 09:01:24 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines