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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines