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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines