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.129 by root, Wed Jan 3 00:41:19 2007 UTC vs.
Revision 1.278 by root, Mon Jun 11 21:38:14 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
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;
19 24
25use BDB ();
26use Data::Dumper;
20use Digest::MD5; 27use Digest::MD5;
21use Fcntl; 28use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
24use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
25 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
27 41
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
30 44
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 46
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 48
35our %COMMAND = (); 49our %COMMAND = ();
36our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
38 56
57our $RELOAD; # number of reloads so far
39our @EVENT; 58our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 59
42our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 76our $NEXT_TICK;
45our $NOW; 77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
46 82
47our %CFG; 83our %CFG;
48 84
49our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 86our $RUNTIME;
51 87
88our %PLAYER; # all users
52our %MAP; # all maps 89our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 90our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE; 91
55our $RANDOM_MAPS = cf::localdir . "/random"; 92# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
57 98
58binmode STDOUT; 99binmode STDOUT;
59binmode STDERR; 100binmode STDERR;
60 101
61# read virtual server time, if available 102# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
66} 107}
67 108
68mkdir cf::localdir; 109mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 111
74# a special map that is always available 112our $EMERGENCY_POSITION;
75our $LINK_MAP;
76 113
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 114sub cf::map::normalise;
78 115
79############################################################################# 116#############################################################################
80 117
81=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
82 119
89=item $cf::RUNTIME 126=item $cf::RUNTIME
90 127
91The time this server has run, starts at 0 and is increased by $cf::TICK on 128The time this server has run, starts at 0 and is increased by $cf::TICK on
92every server tick. 129every server tick.
93 130
94=item $cf::LIBDIR 131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95 134
96The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
97be found. It will be added to C<@INC> automatically. 136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
98 139
99=item $cf::NOW 140=item $cf::NOW
100 141
101The time of the last (current) server tick. 142The time of the last (current) server tick.
102 143
103=item $cf::TICK 144=item $cf::TICK
104 145
105The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
106 157
107=item %cf::CFG 158=item %cf::CFG
108 159
109Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
110from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
111 168
112=back 169=back
113 170
114=cut 171=cut
115 172
116BEGIN { 173BEGIN {
117 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
118 my $msg = join "", @_; 175 my $msg = join "", @_;
119 utf8::encode $msg;
120 176
121 $msg .= "\n" 177 $msg .= "\n"
122 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
123 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
124 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
125 }; 184 };
126} 185}
127 186
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134 194
135# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
136# within the Safe compartment. 196# within the Safe compartment.
137for my $pkg (qw( 197for my $pkg (qw(
138 cf::global cf::attachable 198 cf::global cf::attachable
147 207
148$Event::DIED = sub { 208$Event::DIED = sub {
149 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
150}; 210};
151 211
152my %ext_pkg;
153my @exts;
154my @hook;
155
156=head2 UTILITY FUNCTIONS 212=head2 UTILITY FUNCTIONS
157 213
158=over 4 214=over 4
159 215
160=cut 216=item dumpval $ref
161 217
218=cut
219
220sub dumpval {
221 eval {
222 local $SIG{__DIE__};
223 my $d;
224 if (1) {
225 $d = new Data::Dumper([$_[0]], ["*var"]);
226 $d->Terse(1);
227 $d->Indent(2);
228 $d->Quotekeys(0);
229 $d->Useqq(1);
230 #$d->Bless(...);
231 $d->Seen($_[1]) if @_ > 1;
232 $d = $d->Dump();
233 }
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d
236 } || "[unable to dump $_[0]: '$@']";
237}
238
162use JSON::Syck (); # TODO# replace by JSON::PC once working 239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
163 240
164=item $ref = cf::from_json $json 241=item $ref = cf::from_json $json
165 242
166Converts a JSON string into the corresponding perl data structure. 243Converts a JSON string into the corresponding perl data structure.
167 244
168=cut
169
170sub from_json($) {
171 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172 JSON::Syck::Load $_[0]
173}
174
175=item $json = cf::to_json $ref 245=item $json = cf::to_json $ref
176 246
177Converts a perl data structure into its JSON representation. 247Converts a perl data structure into its JSON representation.
178 248
179=cut
180
181sub to_json($) {
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0]
184}
185
186=item my $guard = cf::guard { BLOCK }
187
188Run the given callback when the guard object gets destroyed (useful for
189coroutine cancellations).
190
191You can call C<< ->cancel >> on the guard object to stop the block from
192being executed.
193
194=cut
195
196sub guard(&) {
197 bless \(my $cb = $_[0]), cf::guard::;
198}
199
200sub cf::guard::cancel {
201 ${$_[0]} = sub { };
202}
203
204sub cf::guard::DESTROY {
205 ${$_[0]}->();
206}
207
208=item cf::lock_wait $string 249=item cf::lock_wait $string
209 250
210Wait until the given lock is available. See cf::lock_acquire. 251Wait until the given lock is available. See cf::lock_acquire.
211 252
212=item my $lock = cf::lock_acquire $string 253=item my $lock = cf::lock_acquire $string
213 254
214Wait until the given lock is available and then acquires it and returns 255Wait until the given lock is available and then acquires it and returns
215a guard object. If the guard object gets destroyed (goes out of scope, 256a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216for example when the coroutine gets canceled), the lock is automatically 257for example when the coroutine gets canceled), the lock is automatically
217returned. 258returned.
218 259
219Lock names should begin with a unique identifier (for example, find_map 260Lock names should begin with a unique identifier (for example, cf::map::find
220uses map_find and load_map uses map_load). 261uses map_find and cf::map::load uses map_load).
262
263=item $locked = cf::lock_active $string
264
265Return true if the lock is currently active, i.e. somebody has locked it.
221 266
222=cut 267=cut
223 268
224our %LOCK; 269our %LOCK;
225 270
239 # wait, to be sure we are not locked 284 # wait, to be sure we are not locked
240 lock_wait $key; 285 lock_wait $key;
241 286
242 $LOCK{$key} = []; 287 $LOCK{$key} = [];
243 288
244 cf::guard { 289 Coro::guard {
245 # wake up all waiters, to be on the safe side 290 # wake up all waiters, to be on the safe side
246 $_->ready for @{ delete $LOCK{$key} }; 291 $_->ready for @{ delete $LOCK{$key} };
247 } 292 }
248} 293}
249 294
295sub lock_active($) {
296 my ($key) = @_;
297
298 ! ! $LOCK{$key}
299}
300
301sub freeze_mainloop {
302 return unless $TICK_WATCHER->is_active;
303
304 my $guard = Coro::guard {
305 $TICK_WATCHER->start;
306 };
307 $TICK_WATCHER->stop;
308 $guard
309}
310
250=item cf::async { BLOCK } 311=item cf::async { BLOCK }
251 312
252Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the 313Currently the same as Coro::async_pool, meaning you cannot use
253error instead of exiting the server in case of a problem. 314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it.
254 316
255=cut 317=cut
256 318
257sub async(&) { 319BEGIN { *async = \&Coro::async_pool }
258 my ($cb) = @_;
259
260 Coro::async {
261 eval { $cb->() };
262 warn $@ if $@;
263 }
264}
265 320
266=item cf::sync_job { BLOCK } 321=item cf::sync_job { BLOCK }
267 322
268The design of crossfire+ requires that the main coro ($Coro::main) is 323The design of crossfire+ requires that the main coro ($Coro::main) is
269always able to handle events or runnable, as crossfire+ is only partly 324always able to handle events or runnable, as crossfire+ is only partly
278 333
279sub sync_job(&) { 334sub sync_job(&) {
280 my ($job) = @_; 335 my ($job) = @_;
281 336
282 if ($Coro::current == $Coro::main) { 337 if ($Coro::current == $Coro::main) {
338 my $time = Event::time;
339
283 # this is the main coro, too bad, we have to block 340 # this is the main coro, too bad, we have to block
284 # till the operation succeeds, freezing the server :/ 341 # till the operation succeeds, freezing the server :/
285 342
286 # TODO: use suspend/resume instead 343 # TODO: use suspend/resume instead
287 # (but this is cancel-safe) 344 # (but this is cancel-safe)
288 local $FREEZE = 1; 345 my $freeze_guard = freeze_mainloop;
289 346
290 my $busy = 1; 347 my $busy = 1;
291 my @res; 348 my @res;
292 349
293 (Coro::async { 350 (async {
294 @res = eval { $job->() }; 351 @res = eval { $job->() };
295 warn $@ if $@; 352 warn $@ if $@;
296 undef $busy; 353 undef $busy;
297 })->prio (Coro::PRIO_MAX); 354 })->prio (Coro::PRIO_MAX);
298 355
299 while ($busy) { 356 while ($busy) {
300 Coro::cede_notself; 357 Coro::cede or Event::one_event;
301 Event::one_event unless Coro::nready;
302 } 358 }
359
360 $time = Event::time - $time;
361
362 LOG llevError | logBacktrace, Carp::longmess "long sync job"
363 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
364
365 $tick_start += $time; # do not account sync jobs to server load
303 366
304 wantarray ? @res : $res[0] 367 wantarray ? @res : $res[0]
305 } else { 368 } else {
306 # we are in another coroutine, how wonderful, everything just works 369 # we are in another coroutine, how wonderful, everything just works
307 370
308 $job->() 371 $job->()
309 } 372 }
310} 373}
311 374
312=item $coro = cf::coro { BLOCK } 375=item $coro = cf::async_ext { BLOCK }
313 376
314Creates and returns a new coro. This coro is automcatially being canceled 377Like async, but this coro is automatically being canceled when the
315when the extension calling this is being unloaded. 378extension calling this is being unloaded.
316 379
317=cut 380=cut
318 381
319sub coro(&) { 382sub async_ext(&) {
320 my $cb = shift; 383 my $cb = shift;
321 384
322 my $coro = &cf::async ($cb); 385 my $coro = &Coro::async ($cb);
323 386
324 $coro->on_destroy (sub { 387 $coro->on_destroy (sub {
325 delete $EXT_CORO{$coro+0}; 388 delete $EXT_CORO{$coro+0};
326 }); 389 });
327 $EXT_CORO{$coro+0} = $coro; 390 $EXT_CORO{$coro+0} = $coro;
328 391
329 $coro 392 $coro
330} 393}
331 394
332sub write_runtime { 395sub write_runtime {
333 my $runtime = cf::localdir . "/runtime"; 396 my $runtime = "$LOCALDIR/runtime";
397
398 # first touch the runtime file to show we are still running:
399 # the fsync below can take a very very long time.
400
401 IO::AIO::aio_utime $runtime, undef, undef;
402
403 my $guard = cf::lock_acquire "write_runtime";
334 404
335 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
336 or return; 406 or return;
337 407
408 my $value = $cf::RUNTIME + 90 + 10;
338 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
339 (aio_write $fh, 0, (length $value), $value, 0) <= 0 412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
340 and return; 413 and return;
341 414
415 # always fsync - this file is important
342 aio_fsync $fh 416 aio_fsync $fh
343 and return; 417 and return;
344 418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
345 close $fh 422 close $fh
346 or return; 423 or return;
347 424
348 aio_rename "$runtime~", $runtime 425 aio_rename "$runtime~", $runtime
349 and return; 426 and return;
350 427
428 warn "runtime file written.\n";
429
351 1 430 1
352} 431}
353 432
433=item cf::datalog type => key => value, ...
434
435Log a datalog packet of the given type with the given key-value pairs.
436
437=cut
438
439sub datalog($@) {
440 my ($type, %kv) = @_;
441 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
442}
443
354=back 444=back
355 445
356=cut 446=cut
357
358#############################################################################
359
360package cf::path;
361
362sub new {
363 my ($class, $path, $base) = @_;
364
365 $path = $path->as_string if ref $path;
366
367 my $self = bless { }, $class;
368
369 # {... are special paths that are not touched
370 # ?xxx/... are special absolute paths
371 # ?random/... random maps
372 # /! non-realised random map exit
373 # /... normal maps
374 # ~/... per-player maps without a specific player (DO NOT USE)
375 # ~user/... per-player map of a specific user
376
377 if ($path =~ /^{/) {
378 # fine as it is
379 } elsif ($path =~ s{^\?random/}{}) {
380 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
381 $self->{random} = cf::from_json $data;
382 } else {
383 if ($path =~ s{^~([^/]+)?}{}) {
384 $self->{user_rel} = 1;
385
386 if (defined $1) {
387 $self->{user} = $1;
388 } elsif ($base =~ m{^~([^/]+)/}) {
389 $self->{user} = $1;
390 } else {
391 warn "cannot resolve user-relative path without user <$path,$base>\n";
392 }
393 } elsif ($path =~ /^\//) {
394 # already absolute
395 } else {
396 $base =~ s{[^/]+/?$}{};
397 return $class->new ("$base/$path");
398 }
399
400 for ($path) {
401 redo if s{/\.?/}{/};
402 redo if s{/[^/]+/\.\./}{/};
403 }
404 }
405
406 $self->{path} = $path;
407
408 $self
409}
410
411# the name / primary key / in-game path
412sub as_string {
413 my ($self) = @_;
414
415 $self->{user_rel} ? "~$self->{user}$self->{path}"
416 : $self->{random} ? "?random/$self->{path}"
417 : $self->{path}
418}
419
420# the displayed name, this is a one way mapping
421sub visible_name {
422 my ($self) = @_;
423
424# if (my $rmp = $self->{random}) {
425# # todo: be more intelligent about this
426# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
427# } else {
428 $self->as_string
429# }
430}
431
432# escape the /'s in the path
433sub _escaped_path {
434 # ∕ is U+2215
435 (my $path = $_[0]{path}) =~ s/\//∕/g;
436 $path
437}
438
439# the original (read-only) location
440sub load_path {
441 my ($self) = @_;
442
443 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
444}
445
446# the temporary/swap location
447sub save_path {
448 my ($self) = @_;
449
450 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
451 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
452 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
453}
454
455# the unique path, might be eq to save_path
456sub uniq_path {
457 my ($self) = @_;
458
459 $self->{user_rel} || $self->{random}
460 ? undef
461 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
462}
463
464# return random map parameters, or undef
465sub random_map_params {
466 my ($self) = @_;
467
468 $self->{random}
469}
470
471# this is somewhat ugly, but style maps do need special treatment
472sub is_style_map {
473 $_[0]{path} =~ m{^/styles/}
474}
475
476package cf;
477 447
478############################################################################# 448#############################################################################
479 449
480=head2 ATTACHABLE OBJECTS 450=head2 ATTACHABLE OBJECTS
481 451
607our @CB_TYPE = (); # registry for type (cf-object class) based events 577our @CB_TYPE = (); # registry for type (cf-object class) based events
608our @CB_MAP = (); 578our @CB_MAP = ();
609 579
610my %attachment; 580my %attachment;
611 581
582sub cf::attachable::thawer_merge {
583 # simply override everything except _meta
584 local $_[0]{_meta};
585 %{$_[0]} = %{$_[1]};
586}
587
612sub _attach_cb($$$$) { 588sub _attach_cb($$$$) {
613 my ($registry, $event, $prio, $cb) = @_; 589 my ($registry, $event, $prio, $cb) = @_;
614 590
615 use sort 'stable'; 591 use sort 'stable';
616 592
650 $registry = $CB_TYPE[$object_type] ||= []; 626 $registry = $CB_TYPE[$object_type] ||= [];
651 627
652 } elsif ($type eq "subtype") { 628 } elsif ($type eq "subtype") {
653 defined $object_type or Carp::croak "subtype specified without type"; 629 defined $object_type or Carp::croak "subtype specified without type";
654 my $object_subtype = shift @arg; 630 my $object_subtype = shift @arg;
655 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 631 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
656 632
657 } elsif ($type eq "package") { 633 } elsif ($type eq "package") {
658 my $pkg = shift @arg; 634 my $pkg = shift @arg;
659 635
660 while (my ($name, $id) = each %cb_id) { 636 while (my ($name, $id) = each %cb_id) {
701 if (ref $_[0]) { 677 if (ref $_[0]) {
702 _object_attach @_; 678 _object_attach @_;
703 } else { 679 } else {
704 _attach shift->_attach_registry, @_; 680 _attach shift->_attach_registry, @_;
705 } 681 }
682 _recalc_want;
706}; 683};
707 684
708# all those should be optimised 685# all those should be optimised
709sub cf::attachable::detach { 686sub cf::attachable::detach {
710 my ($obj, $name) = @_; 687 my ($obj, $name) = @_;
713 delete $obj->{_attachment}{$name}; 690 delete $obj->{_attachment}{$name};
714 reattach ($obj); 691 reattach ($obj);
715 } else { 692 } else {
716 Carp::croak "cannot, currently, detach class attachments"; 693 Carp::croak "cannot, currently, detach class attachments";
717 } 694 }
695 _recalc_want;
718}; 696};
719 697
720sub cf::attachable::attached { 698sub cf::attachable::attached {
721 my ($obj, $name) = @_; 699 my ($obj, $name) = @_;
722 700
787# object support 765# object support
788 766
789sub reattach { 767sub reattach {
790 # basically do the same as instantiate, without calling instantiate 768 # basically do the same as instantiate, without calling instantiate
791 my ($obj) = @_; 769 my ($obj) = @_;
770
771 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
792 772
793 my $registry = $obj->registry; 773 my $registry = $obj->registry;
794 774
795 @$registry = (); 775 @$registry = ();
796 776
843 $filename, length $$rdata, scalar @$objs; 823 $filename, length $$rdata, scalar @$objs;
844 824
845 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
846 chmod SAVE_MODE, $fh; 826 chmod SAVE_MODE, $fh;
847 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 827 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
848 aio_fsync $fh; 828 aio_fsync $fh if $cf::USE_FSYNC;
849 close $fh; 829 close $fh;
850 830
851 if (@$objs) { 831 if (@$objs) {
852 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 832 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
853 chmod SAVE_MODE, $fh; 833 chmod SAVE_MODE, $fh;
854 my $data = Storable::nfreeze { version => 1, objs => $objs }; 834 my $data = Storable::nfreeze { version => 1, objs => $objs };
855 aio_write $fh, 0, (length $data), $data, 0; 835 aio_write $fh, 0, (length $data), $data, 0;
856 aio_fsync $fh; 836 aio_fsync $fh if $cf::USE_FSYNC;
857 close $fh; 837 close $fh;
858 aio_rename "$filename.pst~", "$filename.pst"; 838 aio_rename "$filename.pst~", "$filename.pst";
859 } 839 }
860 } else { 840 } else {
861 aio_unlink "$filename.pst"; 841 aio_unlink "$filename.pst";
893 or return; 873 or return;
894 $av = eval { (Storable::thaw $av)->{objs} }; 874 $av = eval { (Storable::thaw $av)->{objs} };
895 } 875 }
896 876
897 warn sprintf "loading %s (%d)\n", 877 warn sprintf "loading %s (%d)\n",
898 $filename, length $data, scalar @{$av || []};#d# 878 $filename, length $data, scalar @{$av || []};
899 return ($data, $av); 879 return ($data, $av);
900} 880}
901 881
902############################################################################# 882#############################################################################
903# command handling &c 883# command handling &c
928=cut 908=cut
929 909
930sub register_extcmd { 910sub register_extcmd {
931 my ($name, $cb) = @_; 911 my ($name, $cb) = @_;
932 912
933 my $caller = caller;
934 #warn "registering extcmd '$name' to '$caller'";
935
936 $EXTCMD{$name} = [$cb, $caller]; 913 $EXTCMD{$name} = $cb;
937} 914}
938 915
939cf::player->attach ( 916cf::player->attach (
940 on_command => sub { 917 on_command => sub {
941 my ($pl, $name, $params) = @_; 918 my ($pl, $name, $params) = @_;
954 931
955 my $msg = eval { from_json $buf }; 932 my $msg = eval { from_json $buf };
956 933
957 if (ref $msg) { 934 if (ref $msg) {
958 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 935 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
959 if (my %reply = $cb->[0]->($pl, $msg)) { 936 if (my %reply = $cb->($pl, $msg)) {
960 $pl->ext_reply ($msg->{msgid}, %reply); 937 $pl->ext_reply ($msg->{msgid}, %reply);
961 } 938 }
962 } 939 }
963 } else { 940 } else {
964 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
966 943
967 cf::override; 944 cf::override;
968 }, 945 },
969); 946);
970 947
971sub register {
972 my ($base, $pkg) = @_;
973
974 #TODO
975}
976
977sub load_extension { 948sub load_extensions {
949 cf::sync_job {
950 my %todo;
951
952 for my $path (<$LIBDIR/*.ext>) {
953 next unless -r $path;
954
955 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
956 my $base = $1;
957 my $pkg = $1;
958 $pkg =~ s/[^[:word:]]/_/g;
959 $pkg = "ext::$pkg";
960
961 open my $fh, "<:utf8", $path
962 or die "$path: $!";
963
964 my $source = do { local $/; <$fh> };
965
966 my %ext = (
967 path => $path,
968 base => $base,
969 pkg => $pkg,
970 );
971
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/;
974
975 $ext{source} =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . $source
979 . "\n};\n1";
980
981 $todo{$base} = \%ext;
982 }
983
984 my %done;
985 while (%todo) {
986 my $progress;
987
988 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) {
990 goto skip
991 unless exists $done{$_};
992 }
993
994 warn "... loading '$k' into '$v->{pkg}'\n";
995
996 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n";
999
1000 if (exists $v->{meta}{mandatory}) {
1001 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1;
1004 }
1005
1006 die $msg;
1007 }
1008
1009 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg};
1011 }
1012
1013 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress;
1016 }
1017 };
1018}
1019
1020#############################################################################
1021
1022=head2 CORE EXTENSIONS
1023
1024Functions and methods that extend core crossfire objects.
1025
1026=cut
1027
1028package cf::player;
1029
1030use Coro::AIO;
1031
1032=head3 cf::player
1033
1034=over 4
1035
1036=item cf::player::find $login
1037
1038Returns the given player object, loading it if necessary (might block).
1039
1040=cut
1041
1042sub playerdir($) {
1043 "$PLAYERDIR/"
1044 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1045}
1046
1047sub path($) {
1048 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1049
1050 (playerdir $login) . "/playerdata"
1051}
1052
1053sub find_active($) {
1054 $cf::PLAYER{$_[0]}
1055 and $cf::PLAYER{$_[0]}->active
1056 and $cf::PLAYER{$_[0]}
1057}
1058
1059sub exists($) {
1060 my ($login) = @_;
1061
1062 $cf::PLAYER{$login}
1063 or cf::sync_job { !aio_stat path $login }
1064}
1065
1066sub find($) {
1067 return $cf::PLAYER{$_[0]} || do {
1068 my $login = $_[0];
1069
1070 my $guard = cf::lock_acquire "user_find:$login";
1071
1072 $cf::PLAYER{$_[0]} || do {
1073 # rename old playerfiles to new ones
1074 #TODO: remove when no longer required
1075 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1076 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1077 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1078 aio_unlink +(playerdir $login) . "/$login.pl";
1079
1080 my $pl = load_pl path $login
1081 or return;
1082 $cf::PLAYER{$login} = $pl
1083 }
1084 }
1085}
1086
1087sub save($) {
1088 my ($pl) = @_;
1089
1090 return if $pl->{deny_save};
1091
1092 my $path = path $pl;
1093 my $guard = cf::lock_acquire "user_save:$path";
1094
1095 return if $pl->{deny_save};
1096
1097 aio_mkdir playerdir $pl, 0770;
1098 $pl->{last_save} = $cf::RUNTIME;
1099
1100 $pl->save_pl ($path);
1101 Coro::cede;
1102}
1103
1104sub new($) {
1105 my ($login) = @_;
1106
1107 my $self = create;
1108
1109 $self->ob->name ($login);
1110 $self->{deny_save} = 1;
1111
1112 $cf::PLAYER{$login} = $self;
1113
1114 $self
1115}
1116
1117=item $pl->quit_character
1118
1119Nukes the player without looking back. If logged in, the connection will
1120be destroyed. May block for a long time.
1121
1122=cut
1123
1124sub quit_character {
1125 my ($pl) = @_;
1126
1127 my $name = $pl->ob->name;
1128
1129 $pl->{deny_save} = 1;
1130 $pl->password ("*"); # this should lock out the player until we nuked the dir
1131
1132 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1133 $pl->deactivate;
1134 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1135 $pl->ns->destroy if $pl->ns;
1136
1137 my $path = playerdir $pl;
1138 my $temp = "$path~$cf::RUNTIME~deleting~";
1139 aio_rename $path, $temp;
1140 delete $cf::PLAYER{$pl->ob->name};
1141 $pl->destroy;
1142
1143 my $prefix = qr<^~\Q$name\E/>;
1144
1145 # nuke player maps
1146 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1147
1148 IO::AIO::aio_rmtree $temp;
1149}
1150
1151=item $pl->kick
1152
1153Kicks a player out of the game. This destroys the connection.
1154
1155=cut
1156
1157sub kick {
1158 my ($pl, $kicker) = @_;
1159
1160 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1161 $pl->killer ("kicked");
1162 $pl->ns->destroy;
1163}
1164
1165=item cf::player::list_logins
1166
1167Returns am arrayref of all valid playernames in the system, can take a
1168while and may block, so not sync_job-capable, ever.
1169
1170=cut
1171
1172sub list_logins {
1173 my $dirs = aio_readdir $PLAYERDIR
1174 or return [];
1175
1176 my @logins;
1177
1178 for my $login (@$dirs) {
1179 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1180 aio_read $fh, 0, 512, my $buf, 0 or next;
1181 $buf !~ /^password -------------$/m or next; # official not-valid tag
1182
1183 utf8::decode $login;
1184 push @logins, $login;
1185 }
1186
1187 \@logins
1188}
1189
1190=item $player->maps
1191
1192Returns an arrayref of map paths that are private for this
1193player. May block.
1194
1195=cut
1196
1197sub maps($) {
1198 my ($pl) = @_;
1199
1200 $pl = ref $pl ? $pl->ob->name : $pl;
1201
1202 my $files = aio_readdir playerdir $pl
1203 or return;
1204
1205 my @paths;
1206
1207 for (@$files) {
1208 utf8::decode $_;
1209 next if /\.(?:pl|pst)$/;
1210 next unless /^$PATH_SEP/o;
1211
1212 push @paths, cf::map::normalise "~$pl/$_";
1213 }
1214
1215 \@paths
1216}
1217
1218=item $player->ext_reply ($msgid, %msg)
1219
1220Sends an ext reply to the player.
1221
1222=cut
1223
1224sub ext_reply($$%) {
1225 my ($self, $id, %msg) = @_;
1226
1227 $msg{msgid} = $id;
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230}
1231
1232=item $player->ext_event ($type, %msg)
1233
1234Sends an ext event to the client.
1235
1236=cut
1237
1238sub ext_event($$%) {
1239 my ($self, $type, %msg) = @_;
1240
1241 $self->ns->ext_event ($type, %msg);
1242}
1243
1244=head3 cf::region
1245
1246=over 4
1247
1248=cut
1249
1250package cf::region;
1251
1252=item cf::region::find_by_path $path
1253
1254Tries to decuce the probable region for a map knowing only its path.
1255
1256=cut
1257
1258sub find_by_path($) {
978 my ($path) = @_; 1259 my ($path) = @_;
979 1260
980 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1261 my ($match, $specificity);
981 my $base = $1;
982 my $pkg = $1;
983 $pkg =~ s/[^[:word:]]/_/g;
984 $pkg = "ext::$pkg";
985 1262
986 warn "loading '$path' into '$pkg'\n"; 1263 for my $region (list) {
987 1264 if ($region->match && $path =~ $region->match) {
988 open my $fh, "<:utf8", $path 1265 ($match, $specificity) = ($region, $region->specificity)
989 or die "$path: $!"; 1266 if $region->specificity > $specificity;
990 1267 }
991 my $source =
992 "package $pkg; use strict; use utf8;\n"
993 . "#line 1 \"$path\"\n{\n"
994 . (do { local $/; <$fh> })
995 . "\n};\n1";
996
997 eval $source
998 or die $@ ? "$path: $@\n"
999 : "extension disabled.\n";
1000
1001 push @exts, $pkg;
1002 $ext_pkg{$base} = $pkg;
1003
1004# no strict 'refs';
1005# @{"$pkg\::ISA"} = ext::;
1006
1007 register $base, $pkg;
1008}
1009
1010sub unload_extension {
1011 my ($pkg) = @_;
1012
1013 warn "removing extension $pkg\n";
1014
1015 # remove hooks
1016 #TODO
1017# for my $idx (0 .. $#PLUGIN_EVENT) {
1018# delete $hook[$idx]{$pkg};
1019# } 1268 }
1020 1269
1021 # remove commands 1270 $match
1022 for my $name (keys %COMMAND) {
1023 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1024
1025 if (@cb) {
1026 $COMMAND{$name} = \@cb;
1027 } else {
1028 delete $COMMAND{$name};
1029 }
1030 }
1031
1032 # remove extcmds
1033 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1034 delete $EXTCMD{$name};
1035 }
1036
1037 if (my $cb = $pkg->can ("unload")) {
1038 eval {
1039 $cb->($pkg);
1040 1
1041 } or warn "$pkg unloaded, but with errors: $@";
1042 }
1043
1044 Symbol::delete_package $pkg;
1045}
1046
1047sub load_extensions {
1048 for my $ext (<$LIBDIR/*.ext>) {
1049 next unless -r $ext;
1050 eval {
1051 load_extension $ext;
1052 1
1053 } or warn "$ext not loaded: $@";
1054 }
1055}
1056
1057#############################################################################
1058# load/save/clean perl data associated with a map
1059
1060*cf::mapsupport::on_clean = sub {
1061 my ($map) = @_;
1062
1063 my $path = $map->tmpname;
1064 defined $path or return;
1065
1066 unlink "$path.pst";
1067};
1068
1069cf::map->attach (prio => -10000, package => cf::mapsupport::);
1070
1071#############################################################################
1072# load/save perl data associated with player->ob objects
1073
1074sub all_objects(@) {
1075 @_, map all_objects ($_->inv), @_
1076}
1077
1078# TODO: compatibility cruft, remove when no longer needed
1079cf::player->attach (
1080 on_load => sub {
1081 my ($pl, $path) = @_;
1082
1083 for my $o (all_objects $pl->ob) {
1084 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1085 $o->set_ob_key_value ("_perl_data");
1086
1087 %$o = %{ Storable::thaw pack "H*", $value };
1088 }
1089 }
1090 },
1091);
1092
1093#############################################################################
1094
1095=head2 CORE EXTENSIONS
1096
1097Functions and methods that extend core crossfire objects.
1098
1099=head3 cf::player
1100
1101=over 4
1102
1103=item cf::player::exists $login
1104
1105Returns true when the given account exists.
1106
1107=cut
1108
1109sub cf::player::exists($) {
1110 cf::player::find $_[0]
1111 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1112}
1113
1114=item $player->ext_reply ($msgid, $msgtype, %msg)
1115
1116Sends an ext reply to the player.
1117
1118=cut
1119
1120sub cf::player::ext_reply($$$%) {
1121 my ($self, $id, %msg) = @_;
1122
1123 $msg{msgid} = $id;
1124
1125 $self->send ("ext " . to_json \%msg);
1126} 1271}
1127 1272
1128=back 1273=back
1129
1130 1274
1131=head3 cf::map 1275=head3 cf::map
1132 1276
1133=over 4 1277=over 4
1134 1278
1137package cf::map; 1281package cf::map;
1138 1282
1139use Fcntl; 1283use Fcntl;
1140use Coro::AIO; 1284use Coro::AIO;
1141 1285
1286use overload
1287 '""' => \&as_string,
1288 fallback => 1;
1289
1142our $MAX_RESET = 7200; 1290our $MAX_RESET = 3600;
1143our $DEFAULT_RESET = 3600; 1291our $DEFAULT_RESET = 3000;
1144 1292
1145sub generate_random_map { 1293sub generate_random_map {
1146 my ($path, $rmp) = @_; 1294 my ($self, $rmp) = @_;
1147
1148 # mit "rum" bekleckern, nicht 1295 # mit "rum" bekleckern, nicht
1149 cf::map::_create_random_map 1296 $self->_create_random_map (
1150 $path,
1151 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1297 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1298 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1299 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154 $rmp->{exit_on_final_map}, 1300 $rmp->{exit_on_final_map},
1155 $rmp->{xsize}, $rmp->{ysize}, 1301 $rmp->{xsize}, $rmp->{ysize},
1156 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1302 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1303 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1304 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1305 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1160 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1306 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161 (cf::region::find $rmp->{region}) 1307 (cf::region::find $rmp->{region}), $rmp->{custom}
1308 )
1309}
1310
1311=item cf::map->register ($regex, $prio)
1312
1313Register a handler for the map path matching the given regex at the
1314givne priority (higher is better, built-in handlers have priority 0, the
1315default).
1316
1317=cut
1318
1319sub register {
1320 my (undef, $regex, $prio) = @_;
1321 my $pkg = caller;
1322
1323 no strict;
1324 push @{"$pkg\::ISA"}, __PACKAGE__;
1325
1326 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1327}
1328
1329# also paths starting with '/'
1330$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1331
1332sub thawer_merge {
1333 my ($self, $merge) = @_;
1334
1335 # we have to keep some variables in memory intact
1336 local $self->{path};
1337 local $self->{load_path};
1338
1339 $self->SUPER::thawer_merge ($merge);
1340}
1341
1342sub normalise {
1343 my ($path, $base) = @_;
1344
1345 $path = "$path"; # make sure its a string
1346
1347 $path =~ s/\.map$//;
1348
1349 # map plan:
1350 #
1351 # /! non-realised random map exit (special hack!)
1352 # {... are special paths that are not being touched
1353 # ?xxx/... are special absolute paths
1354 # ?random/... random maps
1355 # /... normal maps
1356 # ~user/... per-player map of a specific user
1357
1358 $path =~ s/$PATH_SEP/\//go;
1359
1360 # treat it as relative path if it starts with
1361 # something that looks reasonable
1362 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1363 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1364
1365 $base =~ s{[^/]+/?$}{};
1366 $path = "$base/$path";
1367 }
1368
1369 for ($path) {
1370 redo if s{//}{/};
1371 redo if s{/\.?/}{/};
1372 redo if s{/[^/]+/\.\./}{/};
1373 }
1374
1375 $path
1376}
1377
1378sub new_from_path {
1379 my (undef, $path, $base) = @_;
1380
1381 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1382
1383 $path = normalise $path, $base;
1384
1385 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1386 if ($path =~ $EXT_MAP{$pkg}[1]) {
1387 my $self = bless cf::map::new, $pkg;
1388 $self->{path} = $path; $self->path ($path);
1389 $self->init; # pass $1 etc.
1390 return $self;
1391 }
1392 }
1393
1394 Carp::carp "unable to resolve path '$path' (base '$base').";
1395 ()
1396}
1397
1398sub init {
1399 my ($self) = @_;
1400
1401 $self
1402}
1403
1404sub as_string {
1405 my ($self) = @_;
1406
1407 "$self->{path}"
1408}
1409
1410# the displayed name, this is a one way mapping
1411sub visible_name {
1412 &as_string
1413}
1414
1415# the original (read-only) location
1416sub load_path {
1417 my ($self) = @_;
1418
1419 "$MAPDIR/$self->{path}.map"
1420}
1421
1422# the temporary/swap location
1423sub save_path {
1424 my ($self) = @_;
1425
1426 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1427 "$TMPDIR/$path.map"
1428}
1429
1430# the unique path, undef == no special unique path
1431sub uniq_path {
1432 my ($self) = @_;
1433
1434 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1435 "$UNIQUEDIR/$path"
1162} 1436}
1163 1437
1164# and all this just because we cannot iterate over 1438# and all this just because we cannot iterate over
1165# all maps in C++... 1439# all maps in C++...
1166sub change_all_map_light { 1440sub change_all_map_light {
1168 1442
1169 $_->change_map_light ($change) 1443 $_->change_map_light ($change)
1170 for grep $_->outdoor, values %cf::MAP; 1444 for grep $_->outdoor, values %cf::MAP;
1171} 1445}
1172 1446
1447sub decay_objects {
1448 my ($self) = @_;
1449
1450 return if $self->{deny_reset};
1451
1452 $self->do_decay_objects;
1453}
1454
1455sub unlink_save {
1456 my ($self) = @_;
1457
1458 utf8::encode (my $save = $self->save_path);
1459 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1460 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1461}
1462
1173sub try_load_header($) { 1463sub load_header_from($) {
1174 my ($path) = @_; 1464 my ($self, $path) = @_;
1175 1465
1176 utf8::encode $path; 1466 utf8::encode $path;
1177 aio_open $path, O_RDONLY, 0 1467 #aio_open $path, O_RDONLY, 0
1468 # or return;
1469
1470 $self->_load_header ($path)
1178 or return; 1471 or return;
1179 1472
1180 my $map = cf::map::new 1473 $self->{load_path} = $path;
1474
1475 1
1476}
1477
1478sub load_header_orig {
1479 my ($self) = @_;
1480
1481 $self->load_header_from ($self->load_path)
1482}
1483
1484sub load_header_temp {
1485 my ($self) = @_;
1486
1487 $self->load_header_from ($self->save_path)
1488}
1489
1490sub prepare_temp {
1491 my ($self) = @_;
1492
1493 $self->last_access ((delete $self->{last_access})
1494 || $cf::RUNTIME); #d#
1495 # safety
1496 $self->{instantiate_time} = $cf::RUNTIME
1497 if $self->{instantiate_time} > $cf::RUNTIME;
1498}
1499
1500sub prepare_orig {
1501 my ($self) = @_;
1502
1503 $self->{load_original} = 1;
1504 $self->{instantiate_time} = $cf::RUNTIME;
1505 $self->last_access ($cf::RUNTIME);
1506 $self->instantiate;
1507}
1508
1509sub load_header {
1510 my ($self) = @_;
1511
1512 if ($self->load_header_temp) {
1513 $self->prepare_temp;
1514 } else {
1515 $self->load_header_orig
1181 or return; 1516 or return;
1517 $self->prepare_orig;
1518 }
1182 1519
1183 $map->load_header ($path) 1520 $self->{deny_reset} = 1
1184 or return; 1521 if $self->no_reset;
1185 1522
1186 $map->{load_path} = $path; 1523 $self->default_region (cf::region::find_by_path $self->{path})
1524 unless $self->default_region;
1187 1525
1188 $map 1526 1
1189} 1527}
1190 1528
1191sub find_map; 1529sub find;
1192sub find_map { 1530sub find {
1193 my ($path, $origin) = @_; 1531 my ($path, $origin) = @_;
1194 1532
1195 #warn "find_map<$path,$origin>\n";#d#
1196
1197 $path = new cf::path $path, $origin && $origin->path; 1533 $path = normalise $path, $origin && $origin->path;
1198 my $key = $path->as_string;
1199 1534
1200 cf::lock_wait "map_find:$key"; 1535 cf::lock_wait "map_find:$path";
1201 1536
1202 $cf::MAP{$key} || do { 1537 $cf::MAP{$path} || do {
1203 my $guard = cf::lock_acquire "map_find:$key"; 1538 my $guard = cf::lock_acquire "map_find:$path";
1204 1539 my $map = new_from_path cf::map $path
1205 # do it the slow way
1206 my $map = try_load_header $path->save_path;
1207
1208 if ($map) {
1209 # safety
1210 $map->{instantiate_time} = $cf::RUNTIME
1211 if $map->{instantiate_time} > $cf::RUNTIME;
1212 } else {
1213 if (my $rmp = $path->random_map_params) {
1214 $map = generate_random_map $key, $rmp;
1215 } else {
1216 $map = try_load_header $path->load_path;
1217 }
1218
1219 $map or return; 1540 or return;
1220 1541
1221 $map->{load_original} = 1;
1222 $map->{instantiate_time} = $cf::RUNTIME;
1223 $map->instantiate;
1224
1225 # per-player maps become, after loading, normal maps
1226 $map->per_player (0) if $path->{user_rel};
1227 }
1228
1229 $map->path ($key);
1230 $map->{path} = $path;
1231 $map->{last_save} = $cf::RUNTIME; 1542 $map->{last_save} = $cf::RUNTIME;
1232 $map->last_access ($cf::RUNTIME);
1233 1543
1234 if ($map->should_reset) { 1544 $map->load_header
1545 or return;
1546
1547 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1548 # doing this can freeze the server in a sync job, obviously
1549 #$cf::WAIT_FOR_TICK->wait;
1235 $map->reset; 1550 $map->reset;
1236 undef $guard; 1551 undef $guard;
1237 $map = find_map $path 1552 return find $path;
1238 or return;
1239 } 1553 }
1240 1554
1241 $cf::MAP{$key} = $map 1555 $cf::MAP{$path} = $map
1242 } 1556 }
1243} 1557}
1558
1559sub pre_load { }
1560sub post_load { }
1244 1561
1245sub load { 1562sub load {
1246 my ($self) = @_; 1563 my ($self) = @_;
1247 1564
1565 local $self->{deny_reset} = 1; # loading can take a long time
1566
1248 my $path = $self->{path}; 1567 my $path = $self->{path};
1568
1569 {
1249 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1570 my $guard = cf::lock_acquire "map_load:$path";
1250 1571
1251 return if $self->in_memory != cf::MAP_SWAPPED; 1572 return if $self->in_memory != cf::MAP_SWAPPED;
1252 1573
1253 $self->in_memory (cf::MAP_LOADING); 1574 $self->in_memory (cf::MAP_LOADING);
1254 1575
1255 $self->alloc; 1576 $self->alloc;
1577
1578 $self->pre_load;
1579 Coro::cede;
1580
1256 $self->load_objects ($self->{load_path}, 1) 1581 $self->_load_objects ($self->{load_path}, 1)
1257 or return; 1582 or return;
1258 1583
1259 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1584 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1260 if delete $self->{load_original}; 1585 if delete $self->{load_original};
1261 1586
1262 if (my $uniq = $path->uniq_path) { 1587 if (my $uniq = $self->uniq_path) {
1263 utf8::encode $uniq; 1588 utf8::encode $uniq;
1264 if (aio_open $uniq, O_RDONLY, 0) { 1589 if (aio_open $uniq, O_RDONLY, 0) {
1265 $self->clear_unique_items; 1590 $self->clear_unique_items;
1266 $self->load_objects ($uniq, 0); 1591 $self->_load_objects ($uniq, 0);
1267 } 1592 }
1268 } 1593 }
1269 1594
1595 Coro::cede;
1270 # now do the right thing for maps 1596 # now do the right thing for maps
1271 $self->link_multipart_objects; 1597 $self->link_multipart_objects;
1272
1273 if ($self->{path}->is_style_map) {
1274 $self->{deny_save} = 1;
1275 $self->{deny_reset} = 1;
1276 } else {
1277 $self->fix_auto_apply;
1278 $self->decay_objects;
1279 $self->update_buttons;
1280 $self->set_darkness_map;
1281 $self->difficulty ($self->estimate_difficulty) 1598 $self->difficulty ($self->estimate_difficulty)
1282 unless $self->difficulty; 1599 unless $self->difficulty;
1600 Coro::cede;
1601
1602 unless ($self->{deny_activate}) {
1603 $self->decay_objects;
1604 $self->fix_auto_apply;
1605 $self->update_buttons;
1606 Coro::cede;
1607 $self->set_darkness_map;
1608 Coro::cede;
1283 $self->activate; 1609 $self->activate;
1284 } 1610 }
1285 1611
1286 $self->in_memory (cf::MAP_IN_MEMORY); 1612 $self->in_memory (cf::MAP_IN_MEMORY);
1287} 1613 }
1288 1614
1289sub load_map_sync { 1615 $self->post_load;
1616}
1617
1618sub customise_for {
1619 my ($self, $ob) = @_;
1620
1621 return find "~" . $ob->name . "/" . $self->{path}
1622 if $self->per_player;
1623
1624# return find "?party/" . $ob->name . "/" . $self->{path}
1625# if $self->per_party;
1626
1627 $self
1628}
1629
1630# find and load all maps in the 3x3 area around a map
1631sub load_diag {
1632 my ($map) = @_;
1633
1634 my @diag; # diagonal neighbours
1635
1636 for (0 .. 3) {
1637 my $neigh = $map->tile_path ($_)
1638 or next;
1639 $neigh = find $neigh, $map
1640 or next;
1641 $neigh->load;
1642
1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 }
1646
1647 for (@diag) {
1648 my $neigh = find @$_
1649 or next;
1650 $neigh->load;
1651 }
1652}
1653
1654sub find_sync {
1290 my ($path, $origin) = @_; 1655 my ($path, $origin) = @_;
1291 1656
1292 #warn "load_map_sync<$path, $origin>\n";#d# 1657 cf::sync_job { find $path, $origin }
1658}
1293 1659
1294 cf::sync_job { 1660sub do_load_sync {
1295 my $map = cf::map::find_map $path, $origin 1661 my ($map) = @_;
1296 or return; 1662
1663 cf::sync_job { $map->load };
1664}
1665
1666our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef;
1668
1669sub find_async {
1670 my ($path, $origin) = @_;
1671
1672 $path = normalise $path, $origin && $origin->{path};
1673
1674 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1676 }
1677
1678 undef $MAP_PREFETCH{$path};
1679 $MAP_PREFETCHER ||= cf::async {
1680 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) {
1682 my $map = find $path
1683 or next;
1297 $map->load; 1684 $map->load;
1298 $map 1685
1686 delete $MAP_PREFETCH{$path};
1687 }
1688 }
1689 undef $MAP_PREFETCHER;
1299 } 1690 };
1691 $MAP_PREFETCHER->prio (6);
1692
1693 ()
1300} 1694}
1301 1695
1302sub save { 1696sub save {
1303 my ($self) = @_; 1697 my ($self) = @_;
1304 1698
1699 my $lock = cf::lock_acquire "map_data:" . $self->path;
1700
1305 $self->{last_save} = $cf::RUNTIME; 1701 $self->{last_save} = $cf::RUNTIME;
1306 1702
1307 return unless $self->dirty; 1703 return unless $self->dirty;
1308 1704
1309 my $save = $self->{path}->save_path; utf8::encode $save; 1705 my $save = $self->save_path; utf8::encode $save;
1310 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1706 my $uniq = $self->uniq_path; utf8::encode $uniq;
1311 1707
1312 $self->{load_path} = $save; 1708 $self->{load_path} = $save;
1313 1709
1314 return if $self->{deny_save}; 1710 return if $self->{deny_save};
1315 1711
1712 local $self->{last_access} = $self->last_access;#d#
1713
1714 cf::async {
1715 $_->contr->save for $self->players;
1716 };
1717
1316 if ($uniq) { 1718 if ($uniq) {
1317 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1719 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318 $self->save_objects ($uniq, cf::IO_UNIQUES); 1720 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1319 } else { 1721 } else {
1320 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1722 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1321 } 1723 }
1322} 1724}
1323 1725
1324sub swap_out { 1726sub swap_out {
1325 my ($self) = @_; 1727 my ($self) = @_;
1728
1729 # save first because save cedes
1730 $self->save;
1731
1732 my $lock = cf::lock_acquire "map_data:" . $self->path;
1326 1733
1327 return if $self->players; 1734 return if $self->players;
1328 return if $self->in_memory != cf::MAP_IN_MEMORY; 1735 return if $self->in_memory != cf::MAP_IN_MEMORY;
1329 return if $self->{deny_save}; 1736 return if $self->{deny_save};
1330 1737
1331 $self->save;
1332 $self->clear; 1738 $self->clear;
1333 $self->in_memory (cf::MAP_SWAPPED); 1739 $self->in_memory (cf::MAP_SWAPPED);
1334} 1740}
1335 1741
1336sub reset_at { 1742sub reset_at {
1337 my ($self) = @_; 1743 my ($self) = @_;
1338 1744
1339 # TODO: safety, remove and allow resettable per-player maps 1745 # TODO: safety, remove and allow resettable per-player maps
1340 return 1e99 if $self->{path}{user_rel};
1341 return 1e99 if $self->{deny_reset}; 1746 return 1e99 if $self->{deny_reset};
1342 1747
1343 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1748 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1749 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345 1750
1350 my ($self) = @_; 1755 my ($self) = @_;
1351 1756
1352 $self->reset_at <= $cf::RUNTIME 1757 $self->reset_at <= $cf::RUNTIME
1353} 1758}
1354 1759
1355sub unlink_save {
1356 my ($self) = @_;
1357
1358 utf8::encode (my $save = $self->{path}->save_path);
1359 aioreq_pri 3; IO::AIO::aio_unlink $save;
1360 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361}
1362
1363sub rename {
1364 my ($self, $new_path) = @_;
1365
1366 $self->unlink_save;
1367
1368 delete $cf::MAP{$self->path};
1369 $self->{path} = new cf::path $new_path;
1370 $self->path ($self->{path}->as_string);
1371 $cf::MAP{$self->path} = $self;
1372
1373 $self->save;
1374}
1375
1376sub reset { 1760sub reset {
1377 my ($self) = @_; 1761 my ($self) = @_;
1378 1762
1763 my $lock = cf::lock_acquire "map_data:$self->{path}";
1764
1379 return if $self->players; 1765 return if $self->players;
1380 return if $self->{path}{user_rel};#d#
1381 1766
1382 warn "resetting map ", $self->path;#d# 1767 warn "resetting map ", $self->path;
1768
1769 $self->in_memory (cf::MAP_SWAPPED);
1770
1771 # need to save uniques path
1772 unless ($self->{deny_save}) {
1773 my $uniq = $self->uniq_path; utf8::encode $uniq;
1774
1775 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1776 if $uniq;
1777 }
1383 1778
1384 delete $cf::MAP{$self->path}; 1779 delete $cf::MAP{$self->path};
1780
1781 $self->clear;
1385 1782
1386 $_->clear_links_to ($self) for values %cf::MAP; 1783 $_->clear_links_to ($self) for values %cf::MAP;
1387 1784
1388 $self->unlink_save; 1785 $self->unlink_save;
1389 $self->destroy; 1786 $self->destroy;
1392my $nuke_counter = "aaaa"; 1789my $nuke_counter = "aaaa";
1393 1790
1394sub nuke { 1791sub nuke {
1395 my ($self) = @_; 1792 my ($self) = @_;
1396 1793
1794 delete $cf::MAP{$self->path};
1795
1796 $self->unlink_save;
1797
1798 bless $self, "cf::map";
1799 delete $self->{deny_reset};
1397 $self->{deny_save} = 1; 1800 $self->{deny_save} = 1;
1398 $self->reset_timeout (1); 1801 $self->reset_timeout (1);
1399 $self->rename ("{nuke}/" . ($nuke_counter++)); 1802 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803
1804 $cf::MAP{$self->path} = $self;
1805
1400 $self->reset; # polite request, might not happen 1806 $self->reset; # polite request, might not happen
1401} 1807}
1402 1808
1403sub customise_for { 1809=item $maps = cf::map::tmp_maps
1404 my ($map, $ob) = @_;
1405 1810
1406 if ($map->per_player) { 1811Returns an arrayref with all map paths of currently instantiated and saved
1407 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1812maps. May block.
1813
1814=cut
1815
1816sub tmp_maps() {
1408 } 1817 [
1409 1818 map {
1410 $map 1819 utf8::decode $_;
1820 /\.map$/
1821 ? normalise $_
1822 : ()
1823 } @{ aio_readdir $TMPDIR or [] }
1824 ]
1411} 1825}
1412 1826
1413sub emergency_save { 1827=item $maps = cf::map::random_maps
1414 local $cf::FREEZE = 1;
1415 1828
1416 warn "enter emergency map save\n"; 1829Returns an arrayref with all map paths of currently instantiated and saved
1830random maps. May block.
1417 1831
1418 cf::sync_job { 1832=cut
1419 warn "begin emergency map save\n";
1420 $_->save for values %cf::MAP;
1421 };
1422 1833
1423 warn "end emergency map save\n"; 1834sub random_maps() {
1835 [
1836 map {
1837 utf8::decode $_;
1838 /\.map$/
1839 ? normalise "?random/$_"
1840 : ()
1841 } @{ aio_readdir $RANDOMDIR or [] }
1842 ]
1843}
1844
1845=item cf::map::unique_maps
1846
1847Returns an arrayref of paths of all shared maps that have
1848instantiated unique items. May block.
1849
1850=cut
1851
1852sub unique_maps() {
1853 [
1854 map {
1855 utf8::decode $_;
1856 /\.map$/
1857 ? normalise $_
1858 : ()
1859 } @{ aio_readdir $UNIQUEDIR or [] }
1860 ]
1424} 1861}
1425 1862
1426package cf; 1863package cf;
1427 1864
1428=back 1865=back
1429 1866
1867=head3 cf::object
1868
1869=cut
1870
1871package cf::object;
1872
1873=over 4
1874
1875=item $ob->inv_recursive
1876
1877Returns the inventory of the object _and_ their inventories, recursively.
1878
1879=cut
1880
1881sub inv_recursive_;
1882sub inv_recursive_ {
1883 map { $_, inv_recursive_ $_->inv } @_
1884}
1885
1886sub inv_recursive {
1887 inv_recursive_ inv $_[0]
1888}
1889
1890package cf;
1891
1892=back
1430 1893
1431=head3 cf::object::player 1894=head3 cf::object::player
1432 1895
1433=over 4 1896=over 4
1434 1897
1474 1937
1475=item $player_object->enter_link 1938=item $player_object->enter_link
1476 1939
1477Freezes the player and moves him/her to a special map (C<{link}>). 1940Freezes the player and moves him/her to a special map (C<{link}>).
1478 1941
1479The player should be reaosnably safe there for short amounts of time. You 1942The player should be reasonably safe there for short amounts of time. You
1480I<MUST> call C<leave_link> as soon as possible, though. 1943I<MUST> call C<leave_link> as soon as possible, though.
1481 1944
1945Will never block.
1946
1482=item $player_object->leave_link ($map, $x, $y) 1947=item $player_object->leave_link ($map, $x, $y)
1483 1948
1484Moves the player out of the specila link map onto the given map. If the 1949Moves the player out of the special C<{link}> map onto the specified
1485map is not valid (or omitted), the player will be moved back to the 1950map. If the map is not valid (or omitted), the player will be moved back
1486location he/she was before the call to C<enter_link>, or, if that fails, 1951to the location he/she was before the call to C<enter_link>, or, if that
1487to the emergency map position. 1952fails, to the emergency map position.
1488 1953
1489Might block. 1954Might block.
1490 1955
1491=cut 1956=cut
1957
1958sub link_map {
1959 unless ($LINK_MAP) {
1960 $LINK_MAP = cf::map::find "{link}"
1961 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1962 $LINK_MAP->load;
1963 }
1964
1965 $LINK_MAP
1966}
1492 1967
1493sub cf::object::player::enter_link { 1968sub cf::object::player::enter_link {
1494 my ($self) = @_; 1969 my ($self) = @_;
1495 1970
1496 $self->deactivate_recursive; 1971 $self->deactivate_recursive;
1497 1972
1498 return if $self->map == $LINK_MAP; 1973 return if UNIVERSAL::isa $self->map, "ext::map_link";
1499 1974
1500 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1975 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501 if $self->map; 1976 if $self->map && $self->map->{path} ne "{link}";
1502 1977
1503 $self->enter_map ($LINK_MAP, 20, 20); 1978 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1504} 1979}
1505 1980
1506sub cf::object::player::leave_link { 1981sub cf::object::player::leave_link {
1507 my ($self, $map, $x, $y) = @_; 1982 my ($self, $map, $x, $y) = @_;
1983
1984 return unless $self->contr->active;
1508 1985
1509 my $link_pos = delete $self->{_link_pos}; 1986 my $link_pos = delete $self->{_link_pos};
1510 1987
1511 unless ($map) { 1988 unless ($map) {
1512 # restore original map position 1989 # restore original map position
1513 ($map, $x, $y) = @{ $link_pos || [] }; 1990 ($map, $x, $y) = @{ $link_pos || [] };
1514 $map = cf::map::find_map $map; 1991 $map = cf::map::find $map;
1515 1992
1516 unless ($map) { 1993 unless ($map) {
1517 ($map, $x, $y) = @$EMERGENCY_POSITION; 1994 ($map, $x, $y) = @$EMERGENCY_POSITION;
1518 $map = cf::map::find_map $map 1995 $map = cf::map::find $map
1519 or die "FATAL: cannot load emergency map\n"; 1996 or die "FATAL: cannot load emergency map\n";
1520 } 1997 }
1521 } 1998 }
1522 1999
1523 ($x, $y) = (-1, -1) 2000 ($x, $y) = (-1, -1)
1526 # use -1 or undef as default coordinates, not 0, 0 2003 # use -1 or undef as default coordinates, not 0, 0
1527 ($x, $y) = ($map->enter_x, $map->enter_y) 2004 ($x, $y) = ($map->enter_x, $map->enter_y)
1528 if $x <=0 && $y <= 0; 2005 if $x <=0 && $y <= 0;
1529 2006
1530 $map->load; 2007 $map->load;
2008 $map->load_diag;
1531 2009
2010 return unless $self->contr->active;
1532 $self->activate_recursive; 2011 $self->activate_recursive;
2012
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1533 $self->enter_map ($map, $x, $y); 2014 $self->enter_map ($map, $x, $y);
1534} 2015}
1535 2016
1536cf::player->attach (
1537 on_logout => sub {
1538 my ($pl) = @_;
1539
1540 # abort map switching before logout
1541 if ($pl->ob->{_link_pos}) {
1542 cf::sync_job {
1543 $pl->ob->leave_link
1544 };
1545 }
1546 },
1547 on_login => sub {
1548 my ($pl) = @_;
1549
1550 # try to abort aborted map switching on player login :)
1551 # should happen only on crashes
1552 if ($pl->ob->{_link_pos}) {
1553 $pl->ob->enter_link;
1554 cf::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 Coro::Timer::sleep 1;
1558 $pl->ob->leave_link;
1559 };
1560 }
1561 },
1562);
1563
1564=item $player_object->goto_map ($path, $x, $y) 2017=item $player_object->goto ($path, $x, $y[, $check->($map)])
1565 2018
1566=cut 2019Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position.
1567 2023
2024=cut
2025
2026our $GOTOGEN;
2027
1568sub cf::object::player::goto_map { 2028sub cf::object::player::goto {
1569 my ($self, $path, $x, $y) = @_; 2029 my ($self, $path, $x, $y, $check) = @_;
2030
2031 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1570 2033
1571 $self->enter_link; 2034 $self->enter_link;
1572 2035
1573 (cf::async { 2036 (async {
1574 $path = new cf::path $path; 2037 my $map = eval {
1575
1576 my $map = cf::map::find_map $path->as_string; 2038 my $map = cf::map::find $path;
2039
2040 if ($map) {
1577 $map = $map->customise_for ($self) if $map; 2041 $map = $map->customise_for ($self);
1578 2042 $map = $check->($map) if $check && $map;
1579# warn "entering ", $map->path, " at ($x, $y)\n" 2043 } else {
1580# if $map;
1581
1582 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2044 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2045 }
1583 2046
2047 $map
2048 };
2049
2050 if ($@) {
2051 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2052 LOG llevError | logBacktrace, Carp::longmess $@;
2053 }
2054
2055 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation};
1584 $self->leave_link ($map, $x, $y); 2057 $self->leave_link ($map, $x, $y);
2058 }
1585 })->prio (1); 2059 })->prio (1);
1586} 2060}
1587 2061
1588=item $player_object->enter_exit ($exit_object) 2062=item $player_object->enter_exit ($exit_object)
1589 2063
1591 2065
1592sub parse_random_map_params { 2066sub parse_random_map_params {
1593 my ($spec) = @_; 2067 my ($spec) = @_;
1594 2068
1595 my $rmp = { # defaults 2069 my $rmp = { # defaults
1596 xsize => 10, 2070 xsize => (cf::rndm 15, 40),
1597 ysize => 10, 2071 ysize => (cf::rndm 15, 40),
2072 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2073 #layout => string,
1598 }; 2074 };
1599 2075
1600 for (split /\n/, $spec) { 2076 for (split /\n/, $spec) {
1601 my ($k, $v) = split /\s+/, $_, 2; 2077 my ($k, $v) = split /\s+/, $_, 2;
1602 2078
1606 $rmp 2082 $rmp
1607} 2083}
1608 2084
1609sub prepare_random_map { 2085sub prepare_random_map {
1610 my ($exit) = @_; 2086 my ($exit) = @_;
2087
2088 my $guard = cf::lock_acquire "exit_prepare:$exit";
1611 2089
1612 # all this does is basically replace the /! path by 2090 # all this does is basically replace the /! path by
1613 # a new random map path (?random/...) with a seed 2091 # a new random map path (?random/...) with a seed
1614 # that depends on the exit object 2092 # that depends on the exit object
1615 2093
1616 my $rmp = parse_random_map_params $exit->msg; 2094 my $rmp = parse_random_map_params $exit->msg;
1617 2095
1618 if ($exit->map) { 2096 if ($exit->map) {
1619 $rmp->{region} = $exit->map->region_name; 2097 $rmp->{region} = $exit->region->name;
1620 $rmp->{origin_map} = $exit->map->path; 2098 $rmp->{origin_map} = $exit->map->path;
1621 $rmp->{origin_x} = $exit->x; 2099 $rmp->{origin_x} = $exit->x;
1622 $rmp->{origin_y} = $exit->y; 2100 $rmp->{origin_y} = $exit->y;
1623 } 2101 }
1624 2102
1625 $rmp->{random_seed} ||= $exit->random_seed; 2103 $rmp->{random_seed} ||= $exit->random_seed;
1626 2104
1627 my $data = cf::to_json $rmp; 2105 my $data = cf::to_json $rmp;
1628 my $md5 = Digest::MD5::md5_hex $data; 2106 my $md5 = Digest::MD5::md5_hex $data;
2107 my $meta = "$RANDOMDIR/$md5.meta";
1629 2108
1630 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2109 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1631 aio_write $fh, 0, (length $data), $data, 0; 2110 aio_write $fh, 0, (length $data), $data, 0;
2111 undef $fh;
2112 aio_rename "$meta~", $meta;
1632 2113
1633 $exit->slaying ("?random/$md5"); 2114 $exit->slaying ("?random/$md5");
1634 $exit->msg (undef); 2115 $exit->msg (undef);
1635 } 2116 }
1636} 2117}
1638sub cf::object::player::enter_exit { 2119sub cf::object::player::enter_exit {
1639 my ($self, $exit) = @_; 2120 my ($self, $exit) = @_;
1640 2121
1641 return unless $self->type == cf::PLAYER; 2122 return unless $self->type == cf::PLAYER;
1642 2123
2124 if ($exit->slaying eq "/!") {
2125 #TODO: this should de-fi-ni-te-ly not be a sync-job
2126 # the problem is that $exit might not survive long enough
2127 # so it needs to be done right now, right here
2128 cf::sync_job { prepare_random_map $exit };
2129 }
2130
2131 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2132 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp;
2134
1643 $self->enter_link; 2135 $self->enter_link;
1644 2136
1645 (cf::async { 2137 (async {
2138 $self->deactivate_recursive; # just to be sure
1646 unless (eval { 2139 unless (eval {
1647 prepare_random_map $exit 2140 $self->goto ($slaying, $hp, $sp);
1648 if $exit->slaying eq "/!";
1649
1650 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1651 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1652 2141
1653 1; 2142 1;
1654 }) { 2143 }) {
1655 $self->message ("Something went wrong deep within the crossfire server. " 2144 $self->message ("Something went wrong deep within the crossfire server. "
1656 . "I'll try to bring you back to the map you were before. " 2145 . "I'll try to bring you back to the map you were before. "
1657 . "Please report this to the dungeon master", 2146 . "Please report this to the dungeon master!",
1658 cf::NDI_UNIQUE | cf::NDI_RED); 2147 cf::NDI_UNIQUE | cf::NDI_RED);
1659 2148
1660 warn "ERROR in enter_exit: $@"; 2149 warn "ERROR in enter_exit: $@";
1661 $self->leave_link; 2150 $self->leave_link;
1662 } 2151 }
1663 })->prio (1); 2152 })->prio (1);
1676 2165
1677sub cf::client::send_drawinfo { 2166sub cf::client::send_drawinfo {
1678 my ($self, $text, $flags) = @_; 2167 my ($self, $text, $flags) = @_;
1679 2168
1680 utf8::encode $text; 2169 utf8::encode $text;
1681 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1682} 2171}
1683 2172
2173=item $client->ext_event ($type, %msg)
2174
2175Sends an exti event to the client.
2176
2177=cut
2178
2179sub cf::client::ext_event($$%) {
2180 my ($self, $type, %msg) = @_;
2181
2182 $msg{msgtype} = "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg);
2184}
1684 2185
1685=item $success = $client->query ($flags, "text", \&cb) 2186=item $success = $client->query ($flags, "text", \&cb)
1686 2187
1687Queues a query to the client, calling the given callback with 2188Queues a query to the client, calling the given callback with
1688the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1717 # get handled first 2218 # get handled first
1718 my $queue = delete $ns->{query_queue} 2219 my $queue = delete $ns->{query_queue}
1719 or return; # be conservative, not sure how that can happen, but we saw a crash here 2220 or return; # be conservative, not sure how that can happen, but we saw a crash here
1720 2221
1721 (shift @$queue)->[1]->($msg); 2222 (shift @$queue)->[1]->($msg);
2223 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1722 2224
1723 push @{ $ns->{query_queue} }, @$queue; 2225 push @{ $ns->{query_queue} }, @$queue;
1724 2226
1725 if (@{ $ns->{query_queue} } == @$queue) { 2227 if (@{ $ns->{query_queue} } == @$queue) {
1726 if (@$queue) { 2228 if (@$queue) {
1730 } 2232 }
1731 } 2233 }
1732 }, 2234 },
1733); 2235);
1734 2236
1735=item $client->coro (\&cb) 2237=item $client->async (\&cb)
1736 2238
1737Create a new coroutine, running the specified callback. The coroutine will 2239Create a new coroutine, running the specified callback. The coroutine will
1738be automatically cancelled when the client gets destroyed (e.g. on logout, 2240be automatically cancelled when the client gets destroyed (e.g. on logout,
1739or loss of connection). 2241or loss of connection).
1740 2242
1741=cut 2243=cut
1742 2244
1743sub cf::client::coro { 2245sub cf::client::async {
1744 my ($self, $cb) = @_; 2246 my ($self, $cb) = @_;
1745 2247
1746 my $coro = &cf::async ($cb); 2248 my $coro = &Coro::async ($cb);
1747 2249
1748 $coro->on_destroy (sub { 2250 $coro->on_destroy (sub {
1749 delete $self->{_coro}{$coro+0}; 2251 delete $self->{_coro}{$coro+0};
1750 }); 2252 });
1751 2253
1784 2286
1785# here we export the classes and methods available to script code 2287# here we export the classes and methods available to script code
1786 2288
1787=pod 2289=pod
1788 2290
1789The following fucntions and emthods are available within a safe environment: 2291The following functions and methods are available within a safe environment:
1790 2292
1791 cf::object contr pay_amount pay_player map 2293 cf::object contr pay_amount pay_player map
1792 cf::object::player player 2294 cf::object::player player
1793 cf::player peaceful 2295 cf::player peaceful
1794 cf::map trigger 2296 cf::map trigger
1879############################################################################# 2381#############################################################################
1880 2382
1881=head2 EXTENSION DATABASE SUPPORT 2383=head2 EXTENSION DATABASE SUPPORT
1882 2384
1883Crossfire maintains a very simple database for extension use. It can 2385Crossfire maintains a very simple database for extension use. It can
1884currently store anything that can be serialised using Storable, which 2386currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1885excludes objects. 2387convert to/from binary).
1886 2388
1887The parameter C<$family> should best start with the name of the extension 2389The parameter C<$family> should best start with the name of the extension
1888using it, it should be unique. 2390using it, it should be unique.
1889 2391
1890=over 4 2392=over 4
1891 2393
1892=item $hashref = cf::db_get $family
1893
1894Return a hashref for use by the extension C<$family>, which can be
1895modified. After modifications, you have to call C<cf::db_dirty> or
1896C<cf::db_sync>.
1897
1898=item $value = cf::db_get $family => $key 2394=item $value = cf::db_get $family => $key
1899 2395
1900Returns a single value from the database 2396Returns a single value from the database.
1901
1902=item cf::db_put $family => $hashref
1903
1904Stores the given family hashref into the database. Updates are delayed, if
1905you want the data to be synced to disk immediately, use C<cf::db_sync>.
1906 2397
1907=item cf::db_put $family => $key => $value 2398=item cf::db_put $family => $key => $value
1908 2399
1909Stores the given C<$value> in the family hash. Updates are delayed, if you 2400Stores the given C<$value> in the family.
1910want the data to be synced to disk immediately, use C<cf::db_sync>.
1911
1912=item cf::db_dirty
1913
1914Marks the database as dirty, to be updated at a later time.
1915
1916=item cf::db_sync
1917
1918Immediately write the database to disk I<if it is dirty>.
1919 2401
1920=cut 2402=cut
1921 2403
1922our $DB; 2404our $DB;
1923 2405
1924{ 2406sub db_init {
1925 my $path = cf::localdir . "/database.pst"; 2407 unless ($DB) {
2408 $DB = BDB::db_create $DB_ENV;
1926 2409
1927 sub db_load() { 2410 cf::sync_job {
1928 $DB = stat $path ? Storable::retrieve $path : { }; 2411 eval {
1929 } 2412 $DB->set_flags (BDB::CHKSUM);
1930 2413
1931 my $pid; 2414 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1932 2415 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1933 sub db_save() { 2416 cf::cleanup "db_open(db): $!" if $!;
1934 waitpid $pid, 0 if $pid; 2417 };
1935 if (0 == ($pid = fork)) { 2418 cf::cleanup "db_open(db): $@" if $@;
1936 $DB->{_meta}{version} = 1;
1937 Storable::nstore $DB, "$path~";
1938 rename "$path~", $path;
1939 cf::_exit 0 if defined $pid;
1940 } 2419 };
1941 }
1942
1943 my $dirty;
1944
1945 sub db_sync() {
1946 db_save if $dirty;
1947 undef $dirty;
1948 }
1949
1950 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1951 db_sync;
1952 }); 2420 }
2421}
1953 2422
1954 sub db_dirty() {
1955 $dirty = 1;
1956 $idle->start;
1957 }
1958
1959 sub db_get($;$) { 2423sub db_get($$) {
1960 @_ >= 2 2424 my $key = "$_[0]/$_[1]";
1961 ? $DB->{$_[0]}{$_[1]}
1962 : ($DB->{$_[0]} ||= { })
1963 }
1964 2425
2426 cf::sync_job {
2427 BDB::db_get $DB, undef, $key, my $data;
2428
2429 $! ? ()
2430 : $data
2431 }
2432}
2433
1965 sub db_put($$;$) { 2434sub db_put($$$) {
1966 if (@_ >= 3) { 2435 BDB::dbreq_pri 4;
1967 $DB->{$_[0]}{$_[1]} = $_[2]; 2436 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1968 } else { 2437}
1969 $DB->{$_[0]} = $_[1];
1970 }
1971 db_dirty;
1972 }
1973 2438
1974 cf::global->attach ( 2439=item cf::cache $id => [$paths...], $processversion => $process
1975 prio => 10000, 2440
1976 on_cleanup => sub { 2441Generic caching function that returns the value of the resource $id,
1977 db_sync; 2442caching and regenerating as required.
2443
2444This function can block.
2445
2446=cut
2447
2448sub cache {
2449 my ($id, $src, $processversion, $process) = @_;
2450
2451 my $meta =
2452 join "\x00",
2453 $processversion,
2454 map {
2455 aio_stat $_
2456 and Carp::croak "$_: $!";
2457
2458 ($_, (stat _)[7,9])
2459 } @$src;
2460
2461 my $dbmeta = db_get cache => "$id/meta";
2462 if ($dbmeta ne $meta) {
2463 # changed, we may need to process
2464
2465 my @data;
2466 my $md5;
2467
2468 for (0 .. $#$src) {
2469 0 <= aio_load $src->[$_], $data[$_]
2470 or Carp::croak "$src->[$_]: $!";
1978 }, 2471 }
1979 ); 2472
2473 # if processing is expensive, check
2474 # checksum first
2475 if (1) {
2476 $md5 =
2477 join "\x00",
2478 $processversion,
2479 map {
2480 Coro::cede;
2481 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2482 } 0.. $#$src;
2483
2484
2485 my $dbmd5 = db_get cache => "$id/md5";
2486 if ($dbmd5 eq $md5) {
2487 db_put cache => "$id/meta", $meta;
2488
2489 return db_get cache => "$id/data";
2490 }
2491 }
2492
2493 my $t1 = Time::HiRes::time;
2494 my $data = $process->(\@data);
2495 my $t2 = Time::HiRes::time;
2496
2497 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499 db_put cache => "$id/data", $data;
2500 db_put cache => "$id/md5" , $md5;
2501 db_put cache => "$id/meta", $meta;
2502
2503 return $data;
2504 }
2505
2506 db_get cache => "$id/data"
2507}
2508
2509=item fork_call { }, $args
2510
2511Executes the given code block with the given arguments in a seperate
2512process, returning the results. Everything must be serialisable with
2513Coro::Storable. May, of course, block. Note that the executed sub may
2514never block itself or use any form of Event handling.
2515
2516=cut
2517
2518sub fork_call(&@) {
2519 my ($cb, @args) = @_;
2520
2521# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522# or die "socketpair: $!";
2523 pipe my $fh1, my $fh2
2524 or die "pipe: $!";
2525
2526 if (my $pid = fork) {
2527 close $fh2;
2528
2529 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530 $res = Coro::Storable::thaw $res;
2531
2532 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534 die $$res unless "ARRAY" eq ref $res;
2535
2536 return wantarray ? @$res : $res->[-1];
2537 } else {
2538 reset_signals;
2539 local $SIG{__WARN__};
2540 local $SIG{__DIE__};
2541 eval {
2542 close $fh1;
2543
2544 my @res = eval { $cb->(@args) };
2545 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546 };
2547
2548 warn $@ if $@;
2549 _exit 0;
2550 }
1980} 2551}
1981 2552
1982############################################################################# 2553#############################################################################
1983# the server's main() 2554# the server's init and main functions
2555
2556sub load_facedata($) {
2557 my ($path) = @_;
2558
2559 warn "loading facedata from $path\n";
2560
2561 my $facedata;
2562 0 < aio_load $path, $facedata
2563 or die "$path: $!";
2564
2565 $facedata = Coro::Storable::thaw $facedata;
2566
2567 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569
2570 {
2571 my $faces = $facedata->{faceinfo};
2572
2573 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2578 Coro::cede;
2579 }
2580
2581 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth};
2583 my $idx = cf::face::find $face
2584 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) {
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2587 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 }
2590 Coro::cede;
2591 }
2592 }
2593
2594 {
2595 my $anims = $facedata->{animinfo};
2596
2597 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede;
2600 }
2601
2602 cf::anim::invalidate_all; # d'oh
2603 }
2604
2605 1
2606}
2607
2608sub reload_regions {
2609 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n";
2611}
2612
2613sub reload_facedata {
2614 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n";
2616}
2617
2618sub reload_archetypes {
2619 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n";
2621}
2622
2623sub reload_treasures {
2624 load_resource_file "$DATADIR/treasures"
2625 or die "unable to load treasurelists\n";
2626}
2627
2628sub reload_resources {
2629 warn "reloading resource files...\n";
2630
2631 reload_regions;
2632 reload_facedata;
2633 #reload_archetypes;#d#
2634 reload_archetypes;
2635 reload_treasures;
2636
2637 warn "finished reloading resource files\n";
2638}
2639
2640sub init {
2641 reload_resources;
2642}
1984 2643
1985sub cfg_load { 2644sub cfg_load {
1986 open my $fh, "<:utf8", cf::confdir . "/config" 2645 open my $fh, "<:utf8", "$CONFDIR/config"
1987 or return; 2646 or return;
1988 2647
1989 local $/; 2648 local $/;
1990 *CFG = YAML::Syck::Load <$fh>; 2649 *CFG = YAML::Syck::Load <$fh>;
2650
2651 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2652
2653 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2654 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2655
2656 if (exists $CFG{mlockall}) {
2657 eval {
2658 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2659 and die "WARNING: m(un)lockall failed: $!\n";
2660 };
2661 warn $@ if $@;
2662 }
1991} 2663}
1992 2664
1993sub main { 2665sub main {
1994 # we must not ever block the main coroutine 2666 # we must not ever block the main coroutine
1995 local $Coro::idle = sub { 2667 local $Coro::idle = sub {
1996 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2668 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1997 (Coro::unblock_sub { 2669 (async {
1998 Event::one_event; 2670 Event::one_event;
1999 })->(); 2671 })->prio (Coro::PRIO_MAX);
2000 }; 2672 };
2001 2673
2002 cfg_load; 2674 cfg_load;
2003 db_load; 2675 db_init;
2004 load_extensions; 2676 load_extensions;
2677
2678 $TICK_WATCHER->start;
2005 Event::loop; 2679 Event::loop;
2006} 2680}
2007 2681
2008############################################################################# 2682#############################################################################
2009# initialisation 2683# initialisation and cleanup
2010 2684
2685# install some emergency cleanup handlers
2686BEGIN {
2687 for my $signal (qw(INT HUP TERM)) {
2688 Event->signal (
2689 reentrant => 0,
2690 data => WF_AUTOCANCEL,
2691 signal => $signal,
2692 prio => 0,
2693 cb => sub {
2694 cf::cleanup "SIG$signal";
2695 },
2696 );
2697 }
2698}
2699
2700sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop;
2702
2703 warn "enter emergency perl save\n";
2704
2705 cf::sync_job {
2706 # use a peculiar iteration method to avoid tripping on perl
2707 # refcount bugs in for. also avoids problems with players
2708 # and maps saved/destroyed asynchronously.
2709 warn "begin emergency player save\n";
2710 for my $login (keys %cf::PLAYER) {
2711 my $pl = $cf::PLAYER{$login} or next;
2712 $pl->valid or next;
2713 $pl->save;
2714 }
2715 warn "end emergency player save\n";
2716
2717 warn "begin emergency map save\n";
2718 for my $path (keys %cf::MAP) {
2719 my $map = $cf::MAP{$path} or next;
2720 $map->valid or next;
2721 $map->save;
2722 }
2723 warn "end emergency map save\n";
2724
2725 warn "begin emergency database checkpoint\n";
2726 BDB::db_env_txn_checkpoint $DB_ENV;
2727 warn "end emergency database checkpoint\n";
2728 };
2729
2730 warn "leave emergency perl save\n";
2731}
2732
2733sub post_cleanup {
2734 my ($make_core) = @_;
2735
2736 warn Carp::longmess "post_cleanup backtrace"
2737 if $make_core;
2738}
2739
2011sub reload() { 2740sub do_reload_perl() {
2012 # can/must only be called in main 2741 # can/must only be called in main
2013 if ($Coro::current != $Coro::main) { 2742 if ($Coro::current != $Coro::main) {
2014 warn "can only reload from main coroutine\n"; 2743 warn "can only reload from main coroutine";
2015 return; 2744 return;
2016 } 2745 }
2017 2746
2018 warn "reloading..."; 2747 warn "reloading...";
2019 2748
2020 local $FREEZE = 1; 2749 warn "entering sync_job";
2750
2751 cf::sync_job {
2752 cf::write_runtime; # external watchdog should not bark
2021 cf::emergency_save; 2753 cf::emergency_save;
2754 cf::write_runtime; # external watchdog should not bark
2022 2755
2023 eval { 2756 warn "syncing database to disk";
2757 BDB::db_env_txn_checkpoint $DB_ENV;
2758
2024 # if anything goes wrong in here, we should simply crash as we already saved 2759 # if anything goes wrong in here, we should simply crash as we already saved
2025 2760
2026 # cancel all watchers 2761 warn "cancelling all WF_AUTOCANCEL watchers";
2027 for (Event::all_watchers) { 2762 for (Event::all_watchers) {
2028 $_->cancel if $_->data & WF_AUTOCANCEL; 2763 $_->cancel if $_->data & WF_AUTOCANCEL;
2029 } 2764 }
2030 2765
2766 warn "flushing outstanding aio requests";
2767 for (;;) {
2768 BDB::flush;
2769 IO::AIO::flush;
2770 Coro::cede;
2771 last unless IO::AIO::nreqs || BDB::nreqs;
2772 warn "iterate...";
2773 }
2774
2775 ++$RELOAD;
2776
2031 # cancel all extension coros 2777 warn "cancelling all extension coros";
2032 $_->cancel for values %EXT_CORO; 2778 $_->cancel for values %EXT_CORO;
2033 %EXT_CORO = (); 2779 %EXT_CORO = ();
2034 2780
2035 # unload all extensions 2781 warn "removing commands";
2036 for (@exts) { 2782 %COMMAND = ();
2783
2784 warn "removing ext commands";
2785 %EXTCMD = ();
2786
2787 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) {
2037 warn "unloading <$_>"; 2789 warn "... unloading $pkg";
2038 unload_extension $_; 2790
2791 if (my $cb = $pkg->can ("unload")) {
2792 eval {
2793 $cb->($pkg);
2794 1
2795 } or warn "$pkg unloaded, but with errors: $@";
2039 } 2796 }
2040 2797
2798 warn "... nuking $pkg";
2799 Symbol::delete_package $pkg;
2800 }
2801
2041 # unload all modules loaded from $LIBDIR 2802 warn "unloading all perl modules loaded from $LIBDIR";
2042 while (my ($k, $v) = each %INC) { 2803 while (my ($k, $v) = each %INC) {
2043 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2804 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2044 2805
2045 warn "removing <$k>"; 2806 warn "... unloading $k";
2046 delete $INC{$k}; 2807 delete $INC{$k};
2047 2808
2048 $k =~ s/\.pm$//; 2809 $k =~ s/\.pm$//;
2049 $k =~ s/\//::/g; 2810 $k =~ s/\//::/g;
2050 2811
2053 } 2814 }
2054 2815
2055 Symbol::delete_package $k; 2816 Symbol::delete_package $k;
2056 } 2817 }
2057 2818
2058 # sync database to disk
2059 cf::db_sync;
2060 IO::AIO::flush;
2061
2062 # get rid of safe::, as good as possible 2819 warn "getting rid of safe::, as good as possible";
2063 Symbol::delete_package "safe::$_" 2820 Symbol::delete_package "safe::$_"
2064 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2821 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2065 2822
2066 # remove register_script_function callbacks
2067 # TODO
2068
2069 # unload cf.pm "a bit" 2823 warn "unloading cf.pm \"a bit\"";
2070 delete $INC{"cf.pm"}; 2824 delete $INC{"cf.pm"};
2825 delete $INC{"cf/pod.pm"};
2071 2826
2072 # don't, removes xs symbols, too, 2827 # don't, removes xs symbols, too,
2073 # and global variables created in xs 2828 # and global variables created in xs
2074 #Symbol::delete_package __PACKAGE__; 2829 #Symbol::delete_package __PACKAGE__;
2075 2830
2076 # reload cf.pm 2831 warn "unload completed, starting to reload now";
2832
2077 warn "reloading cf.pm"; 2833 warn "reloading cf.pm";
2078 require cf; 2834 require cf;
2079 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2080 2836
2081 # load config and database again 2837 warn "loading config and database again";
2082 cf::cfg_load; 2838 cf::cfg_load;
2083 cf::db_load;
2084 2839
2085 # load extensions
2086 warn "load extensions"; 2840 warn "loading extensions";
2087 cf::load_extensions; 2841 cf::load_extensions;
2088 2842
2089 # reattach attachments to objects 2843 warn "reattaching attachments to objects/players";
2090 warn "reattach"; 2844 _global_reattach; # objects, sockets
2091 _global_reattach; 2845 warn "reattaching attachments to maps";
2092 }; 2846 reattach $_ for values %MAP;
2847 warn "reattaching attachments to players";
2848 reattach $_ for values %PLAYER;
2093 2849
2094 if ($@) { 2850 warn "leaving sync_job";
2851
2852 1
2853 } or do {
2095 warn $@; 2854 warn $@;
2096 warn "error while reloading, exiting."; 2855 warn "error while reloading, exiting.";
2097 exit 1; 2856 exit 1;
2098 } 2857 };
2099 2858
2100 warn "reloaded successfully"; 2859 warn "reloaded";
2101}; 2860};
2102 2861
2103############################################################################# 2862our $RELOAD_WATCHER; # used only during reload
2104 2863
2105unless ($LINK_MAP) { 2864sub reload_perl() {
2106 $LINK_MAP = cf::map::new; 2865 # doing reload synchronously and two reloads happen back-to-back,
2866 # coro crashes during coro_state_free->destroy here.
2107 2867
2108 $LINK_MAP->width (41); 2868 $RELOAD_WATCHER ||= Event->timer (
2109 $LINK_MAP->height (41); 2869 reentrant => 0,
2110 $LINK_MAP->alloc;
2111 $LINK_MAP->path ("{link}");
2112 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2113 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2114
2115 # dirty hack because... archetypes are not yet loaded
2116 Event->timer (
2117 after => 2, 2870 after => 0,
2871 data => WF_AUTOCANCEL,
2118 cb => sub { 2872 cb => sub {
2119 $_[0]->w->cancel; 2873 do_reload_perl;
2120 2874 undef $RELOAD_WATCHER;
2121 # provide some exits "home"
2122 my $exit = cf::object::new "exit";
2123
2124 $exit->slaying ($EMERGENCY_POSITION->[0]);
2125 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2126 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2127
2128 $LINK_MAP->insert ($exit->clone, 19, 19);
2129 $LINK_MAP->insert ($exit->clone, 19, 20);
2130 $LINK_MAP->insert ($exit->clone, 19, 21);
2131 $LINK_MAP->insert ($exit->clone, 20, 19);
2132 $LINK_MAP->insert ($exit->clone, 20, 21);
2133 $LINK_MAP->insert ($exit->clone, 21, 19);
2134 $LINK_MAP->insert ($exit->clone, 21, 20);
2135 $LINK_MAP->insert ($exit->clone, 21, 21);
2136
2137 $exit->destroy;
2138 }); 2875 },
2139 2876 );
2140 $LINK_MAP->{deny_save} = 1;
2141 $LINK_MAP->{deny_reset} = 1;
2142
2143 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2144} 2877}
2145
2146register "<global>", __PACKAGE__;
2147 2878
2148register_command "reload" => sub { 2879register_command "reload" => sub {
2149 my ($who, $arg) = @_; 2880 my ($who, $arg) = @_;
2150 2881
2151 if ($who->flag (FLAG_WIZ)) { 2882 if ($who->flag (FLAG_WIZ)) {
2152 $who->message ("start of reload.");
2153 reload;
2154 $who->message ("end of reload."); 2883 $who->message ("reloading server.");
2884 async { reload_perl };
2155 } 2885 }
2156}; 2886};
2157 2887
2158unshift @INC, $LIBDIR; 2888unshift @INC, $LIBDIR;
2159 2889
2890my $bug_warning = 0;
2891
2892our @WAIT_FOR_TICK;
2893our @WAIT_FOR_TICK_BEGIN;
2894
2895sub wait_for_tick {
2896 return unless $TICK_WATCHER->is_active;
2897 return if $Coro::current == $Coro::main;
2898
2899 my $signal = new Coro::Signal;
2900 push @WAIT_FOR_TICK, $signal;
2901 $signal->wait;
2902}
2903
2904sub wait_for_tick_begin {
2905 return unless $TICK_WATCHER->is_active;
2906 return if $Coro::current == $Coro::main;
2907
2908 my $signal = new Coro::Signal;
2909 push @WAIT_FOR_TICK_BEGIN, $signal;
2910 $signal->wait;
2911}
2912
2913 my $min = 1e6;#d#
2914 my $avg = 10;
2160$TICK_WATCHER = Event->timer ( 2915$TICK_WATCHER = Event->timer (
2161 reentrant => 0, 2916 reentrant => 0,
2917 parked => 1,
2162 prio => 0, 2918 prio => 0,
2163 at => $NEXT_TICK || $TICK, 2919 at => $NEXT_TICK || $TICK,
2164 data => WF_AUTOCANCEL, 2920 data => WF_AUTOCANCEL,
2165 cb => sub { 2921 cb => sub {
2166 unless ($FREEZE) { 2922 if ($Coro::current != $Coro::main) {
2923 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924 unless ++$bug_warning > 10;
2925 return;
2926 }
2927
2928 $NOW = $tick_start = Event::time;
2929
2167 cf::server_tick; # one server iteration 2930 cf::server_tick; # one server iteration
2168 $RUNTIME += $TICK; 2931
2932 0 && sync_job {#d#
2933 for(1..10) {
2934 my $t = Event::time;
2935 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936 or die;
2937
2938 $map->width (50);
2939 $map->height (50);
2940 $map->alloc;
2941 $map->_load_objects ("/tmp/x.map", 1);
2942 my $t = Event::time - $t;
2943
2944 #next unless $t < 0.0013;#d#
2945 if ($t < $min) {
2946 $min = $t;
2947 }
2948 $avg = $avg * 0.99 + $t * 0.01;
2949 }
2950 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951 exit 0;
2952 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2169 } 2953 };
2170 2954
2955 $RUNTIME += $TICK;
2171 $NEXT_TICK += $TICK; 2956 $NEXT_TICK += $TICK;
2172 2957
2958 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2959 $NEXT_RUNTIME_WRITE = $NOW + 10;
2960 Coro::async_pool {
2961 write_runtime
2962 or warn "ERROR: unable to write runtime file: $!";
2963 };
2964 }
2965
2966# my $AFTER = Event::time;
2967# warn $AFTER - $NOW;#d#
2968
2969 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2970 $sig->send;
2971 }
2972 while (my $sig = shift @WAIT_FOR_TICK) {
2973 $sig->send;
2974 }
2975
2976 $NOW = Event::time;
2977
2173 # if we are delayed by four ticks or more, skip them all 2978 # if we are delayed by four ticks or more, skip them all
2174 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2979 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2175 2980
2176 $TICK_WATCHER->at ($NEXT_TICK); 2981 $TICK_WATCHER->at ($NEXT_TICK);
2177 $TICK_WATCHER->start; 2982 $TICK_WATCHER->start;
2983
2984 $LOAD = ($NOW - $tick_start) / $TICK;
2985 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986
2987 _post_tick;
2988
2989
2178 }, 2990 },
2179); 2991);
2180 2992
2993{
2181IO::AIO::max_poll_time $TICK * 0.2; 2994 BDB::max_poll_time $TICK * 0.1;
2182 2995 $BDB_POLL_WATCHER = Event->io (
2183Event->io ( 2996 reentrant => 0,
2184 fd => IO::AIO::poll_fileno, 2997 fd => BDB::poll_fileno,
2185 poll => 'r', 2998 poll => 'r',
2186 prio => 5, 2999 prio => 0,
2187 data => WF_AUTOCANCEL,
2188 cb => \&IO::AIO::poll_cb,
2189);
2190
2191Event->timer (
2192 data => WF_AUTOCANCEL, 3000 data => WF_AUTOCANCEL,
2193 after => 0, 3001 cb => \&BDB::poll_cb,
2194 interval => 10, 3002 );
2195 cb => sub { 3003 BDB::min_parallel 8;
2196 (Coro::unblock_sub { 3004
2197 write_runtime 3005 BDB::set_sync_prepare {
2198 or warn "ERROR: unable to write runtime file: $!"; 3006 my $status;
3007 my $current = $Coro::current;
3008 (
3009 sub {
3010 $status = $!;
3011 $current->ready; undef $current;
3012 },
3013 sub {
3014 Coro::schedule while defined $current;
3015 $! = $status;
3016 },
3017 )
3018 };
3019
3020 unless ($DB_ENV) {
3021 $DB_ENV = BDB::db_env_create;
3022
3023 cf::sync_job {
3024 eval {
3025 BDB::db_env_open
3026 $DB_ENV,
3027 $BDBDIR,
3028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030 0666;
3031
3032 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033
3034 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3035 $DB_ENV->set_lk_detect;
3036 };
3037
3038 cf::cleanup "db_env_open(db): $@" if $@;
2199 })->(); 3039 };
2200 }, 3040 }
2201); 3041}
3042
3043{
3044 IO::AIO::min_parallel 8;
3045
3046 undef $Coro::AIO::WATCHER;
3047 IO::AIO::max_poll_time $TICK * 0.1;
3048 $AIO_POLL_WATCHER = Event->io (
3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 fd => IO::AIO::poll_fileno,
3052 poll => 'r',
3053 prio => 6,
3054 cb => \&IO::AIO::poll_cb,
3055 );
3056}
3057
3058my $_log_backtrace;
3059
3060sub _log_backtrace {
3061 my ($msg, @addr) = @_;
3062
3063 $msg =~ s/\n//;
3064
3065 # limit the # of concurrent backtraces
3066 if ($_log_backtrace < 2) {
3067 ++$_log_backtrace;
3068 async {
3069 my @bt = fork_call {
3070 @addr = map { sprintf "%x", $_ } @addr;
3071 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3072 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3073 or die "addr2line: $!";
3074
3075 my @funcs;
3076 my @res = <$fh>;
3077 chomp for @res;
3078 while (@res) {
3079 my ($func, $line) = splice @res, 0, 2, ();
3080 push @funcs, "[$func] $line";
3081 }
3082
3083 @funcs
3084 };
3085
3086 LOG llevInfo, "[ABT] $msg\n";
3087 LOG llevInfo, "[ABT] $_\n" for @bt;
3088 --$_log_backtrace;
3089 };
3090 } else {
3091 LOG llevInfo, "[ABT] $msg\n";
3092 LOG llevInfo, "[ABT] [suppressed]\n";
3093 }
3094}
3095
3096# load additional modules
3097use cf::pod;
2202 3098
2203END { cf::emergency_save } 3099END { cf::emergency_save }
2204 3100
22051 31011
2206 3102

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines