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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.391 by root, Fri Oct 26 04:22:05 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines