ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/server/lib/cf.pm
(Generate patch)

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.375 by root, Sun Sep 30 20:22:21 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines