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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines