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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines