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.142 by root, Fri Jan 5 21:51:42 2007 UTC vs.
Revision 1.374 by root, Wed Sep 19 22:07:16 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines