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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines