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.388 by root, Thu Oct 18 02:56:13 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines