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.198 by root, Sun Jan 28 01:58:37 2007 UTC

8use Storable; 8use Storable;
9use Opcode; 9use Opcode;
10use Safe; 10use Safe;
11use Safe::Hole; 11use Safe::Hole;
12 12
13use Coro 3.3; 13use Coro 3.5 ();
14use Coro::Event; 14use Coro::Event;
15use Coro::Timer; 15use Coro::Timer;
16use Coro::Signal; 16use Coro::Signal;
17use Coro::Semaphore; 17use Coro::Semaphore;
18use Coro::AIO; 18use Coro::AIO;
19 19
20use Data::Dumper;
20use Digest::MD5; 21use Digest::MD5;
21use Fcntl; 22use Fcntl;
22use IO::AIO 2.31 (); 23use IO::AIO 2.32 ();
23use YAML::Syck (); 24use YAML::Syck ();
24use Time::HiRes; 25use Time::HiRes;
25 26
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
27 28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
30 33
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 35
35our %COMMAND = (); 36our %COMMAND = ();
36our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 40our %EXTCMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps
38 43
39our @EVENT; 44our @EVENT;
40our $LIBDIR = datadir . "/ext"; 45our $LIBDIR = datadir . "/ext";
41 46
42our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
43our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
44our $NEXT_TICK; 51our $NEXT_TICK;
45our $NOW; 52our $NOW;
46 53
47our %CFG; 54our %CFG;
48 55
49our $UPTIME; $UPTIME ||= time; 56our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 57our $RUNTIME;
51 58
59our %PLAYER; # all users
52our %MAP; # all maps 60our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 61our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random"; 62our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO; 63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66
67# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57 69
58binmode STDOUT; 70binmode STDOUT;
59binmode STDERR; 71binmode STDERR;
60 72
61# read virtual server time, if available 73# read virtual server time, if available
69mkdir cf::localdir . "/" . cf::playerdir; 81mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir; 82mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir; 83mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS; 84mkdir $RANDOM_MAPS;
73 85
74# a special map that is always available 86our $EMERGENCY_POSITION;
75our $LINK_MAP;
76 87
77############################################################################# 88#############################################################################
78 89
79=head2 GLOBAL VARIABLES 90=head2 GLOBAL VARIABLES
80 91
104 115
105=item %cf::CFG 116=item %cf::CFG
106 117
107Configuration for the server, loaded from C</etc/crossfire/config>, or 118Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 119from wherever your confdir points to.
120
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
122
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
125processing has been done. Call C<< ->wait >> on them to maximise the
126window of cpu time available, or simply to synchronise to the server tick.
109 127
110=back 128=back
111 129
112=cut 130=cut
113 131
117 utf8::encode $msg; 135 utf8::encode $msg;
118 136
119 $msg .= "\n" 137 $msg .= "\n"
120 unless $msg =~ /\n$/; 138 unless $msg =~ /\n$/;
121 139
122 LOG llevError, "cfperl: $msg"; 140 LOG llevError, $msg;
123 }; 141 };
124} 142}
125 143
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
145 163
146$Event::DIED = sub { 164$Event::DIED = sub {
147 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
148}; 166};
149 167
150my %ext_pkg;
151my @exts;
152my @hook;
153
154=head2 UTILITY FUNCTIONS 168=head2 UTILITY FUNCTIONS
155 169
156=over 4 170=over 4
157 171
172=item dumpval $ref
173
158=cut 174=cut
175
176sub dumpval {
177 eval {
178 local $SIG{__DIE__};
179 my $d;
180 if (1) {
181 $d = new Data::Dumper([$_[0]], ["*var"]);
182 $d->Terse(1);
183 $d->Indent(2);
184 $d->Quotekeys(0);
185 $d->Useqq(1);
186 #$d->Bless(...);
187 $d->Seen($_[1]) if @_ > 1;
188 $d = $d->Dump();
189 }
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d
192 } || "[unable to dump $_[0]: '$@']";
193}
159 194
160use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
161 196
162=item $ref = cf::from_json $json 197=item $ref = cf::from_json $json
163 198
178 213
179sub to_json($) { 214sub to_json($) {
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181 JSON::Syck::Dump $_[0] 216 JSON::Syck::Dump $_[0]
182} 217}
218
219=item cf::lock_wait $string
220
221Wait until the given lock is available. See cf::lock_acquire.
222
223=item my $lock = cf::lock_acquire $string
224
225Wait until the given lock is available and then acquires it and returns
226a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227for example when the coroutine gets canceled), the lock is automatically
228returned.
229
230Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load).
232
233=cut
234
235our %LOCK;
236
237sub lock_wait($) {
238 my ($key) = @_;
239
240 # wait for lock, if any
241 while ($LOCK{$key}) {
242 push @{ $LOCK{$key} }, $Coro::current;
243 Coro::schedule;
244 }
245}
246
247sub lock_acquire($) {
248 my ($key) = @_;
249
250 # wait, to be sure we are not locked
251 lock_wait $key;
252
253 $LOCK{$key} = [];
254
255 Coro::guard {
256 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} };
258 }
259}
260
261sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active;
263
264 my $guard = Coro::guard {
265 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop;
270 $guard
271}
272
273=item cf::async { BLOCK }
274
275Currently the same as Coro::async_pool, meaning you cannot use
276C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
277thing you are allowed to do is call C<prio> on it.
278
279=cut
280
281BEGIN { *async = \&Coro::async_pool }
183 282
184=item cf::sync_job { BLOCK } 283=item cf::sync_job { BLOCK }
185 284
186The design of crossfire+ requires that the main coro ($Coro::main) is 285The design of crossfire+ requires that the main coro ($Coro::main) is
187always able to handle events or runnable, as crossfire+ is only partly 286always able to handle events or runnable, as crossfire+ is only partly
195=cut 294=cut
196 295
197sub sync_job(&) { 296sub sync_job(&) {
198 my ($job) = @_; 297 my ($job) = @_;
199 298
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) { 299 if ($Coro::current == $Coro::main) {
300 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/
302
303 # TODO: use suspend/resume instead
304 # (but this is cancel-safe)
305 my $freeze_guard = freeze_mainloop;
306
307 my $busy = 1;
308 my @res;
309
310 (async {
311 @res = eval { $job->() };
312 warn $@ if $@;
313 undef $busy;
213 $coro->prio (Coro::PRIO_MAX); 314 })->prio (Coro::PRIO_MAX);
315
214 while ($busy) { 316 while ($busy) {
215 Coro::cede_notself; 317 Coro::cede or Event::one_event;
216 Event::one_event unless Coro::nready;
217 } 318 }
319
320 wantarray ? @res : $res[0]
218 } else { 321 } else {
219 $coro->join; 322 # we are in another coroutine, how wonderful, everything just works
323
324 $job->()
220 } 325 }
221
222 wantarray ? @res : $res[0]
223} 326}
224 327
225=item $coro = cf::coro { BLOCK } 328=item $coro = cf::async_ext { BLOCK }
226 329
227Creates and returns a new coro. This coro is automcatially being canceled 330Like async, but this coro is automatically being canceled when the
228when the extension calling this is being unloaded. 331extension calling this is being unloaded.
229 332
230=cut 333=cut
231 334
232sub coro(&) { 335sub async_ext(&) {
233 my $cb = shift; 336 my $cb = shift;
234 337
235 my $coro; $coro = async { 338 my $coro = &Coro::async ($cb);
236 eval {
237 $cb->();
238 };
239 warn $@ if $@;
240 };
241 339
242 $coro->on_destroy (sub { 340 $coro->on_destroy (sub {
243 delete $EXT_CORO{$coro+0}; 341 delete $EXT_CORO{$coro+0};
244 }); 342 });
245 $EXT_CORO{$coro+0} = $coro; 343 $EXT_CORO{$coro+0} = $coro;
251 my $runtime = cf::localdir . "/runtime"; 349 my $runtime = cf::localdir . "/runtime";
252 350
253 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
254 or return; 352 or return;
255 353
256 my $value = $cf::RUNTIME; 354 my $value = $cf::RUNTIME + 90 + 10;
355 # 10 is the runtime save interval, for a monotonic clock
356 # 60 allows for the watchdog to kill the server.
357
257 (aio_write $fh, 0, (length $value), $value, 0) <= 0 358 (aio_write $fh, 0, (length $value), $value, 0) <= 0
258 and return; 359 and return;
259 360
260 aio_fsync $fh 361 aio_fsync $fh
261 and return; 362 and return;
270} 371}
271 372
272=back 373=back
273 374
274=cut 375=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 376
384############################################################################# 377#############################################################################
385 378
386=head2 ATTACHABLE OBJECTS 379=head2 ATTACHABLE OBJECTS
387 380
513our @CB_TYPE = (); # registry for type (cf-object class) based events 506our @CB_TYPE = (); # registry for type (cf-object class) based events
514our @CB_MAP = (); 507our @CB_MAP = ();
515 508
516my %attachment; 509my %attachment;
517 510
511sub cf::attachable::thawer_merge {
512 # simply override everything except _meta
513 local $_[0]{_meta};
514 %{$_[0]} = %{$_[1]};
515}
516
518sub _attach_cb($$$$) { 517sub _attach_cb($$$$) {
519 my ($registry, $event, $prio, $cb) = @_; 518 my ($registry, $event, $prio, $cb) = @_;
520 519
521 use sort 'stable'; 520 use sort 'stable';
522 521
693# object support 692# object support
694 693
695sub reattach { 694sub reattach {
696 # basically do the same as instantiate, without calling instantiate 695 # basically do the same as instantiate, without calling instantiate
697 my ($obj) = @_; 696 my ($obj) = @_;
697
698 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
698 699
699 my $registry = $obj->registry; 700 my $registry = $obj->registry;
700 701
701 @$registry = (); 702 @$registry = ();
702 703
795 or return; 796 or return;
796 797
797 unless (aio_stat "$filename.pst") { 798 unless (aio_stat "$filename.pst") {
798 (aio_load "$filename.pst", $av) >= 0 799 (aio_load "$filename.pst", $av) >= 0
799 or return; 800 or return;
800 $av = eval { (Storable::thaw <$av>)->{objs} }; 801 $av = eval { (Storable::thaw $av)->{objs} };
801 } 802 }
802 803
804 warn sprintf "loading %s (%d)\n",
805 $filename, length $data, scalar @{$av || []};#d#
803 return ($data, $av); 806 return ($data, $av);
804} 807}
805 808
806############################################################################# 809#############################################################################
807# command handling &c 810# command handling &c
832=cut 835=cut
833 836
834sub register_extcmd { 837sub register_extcmd {
835 my ($name, $cb) = @_; 838 my ($name, $cb) = @_;
836 839
837 my $caller = caller;
838 #warn "registering extcmd '$name' to '$caller'";
839
840 $EXTCMD{$name} = [$cb, $caller]; 840 $EXTCMD{$name} = $cb;
841} 841}
842 842
843cf::player->attach ( 843cf::player->attach (
844 on_command => sub { 844 on_command => sub {
845 my ($pl, $name, $params) = @_; 845 my ($pl, $name, $params) = @_;
858 858
859 my $msg = eval { from_json $buf }; 859 my $msg = eval { from_json $buf };
860 860
861 if (ref $msg) { 861 if (ref $msg) {
862 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 862 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
863 if (my %reply = $cb->[0]->($pl, $msg)) { 863 if (my %reply = $cb->($pl, $msg)) {
864 $pl->ext_reply ($msg->{msgid}, %reply); 864 $pl->ext_reply ($msg->{msgid}, %reply);
865 } 865 }
866 } 866 }
867 } else { 867 } else {
868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
870 870
871 cf::override; 871 cf::override;
872 }, 872 },
873); 873);
874 874
875sub register {
876 my ($base, $pkg) = @_;
877
878 #TODO
879}
880
881sub load_extension { 875sub load_extension {
882 my ($path) = @_; 876 my ($path) = @_;
883 877
884 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
885 my $base = $1; 879 my $base = $1;
886 my $pkg = $1; 880 my $pkg = $1;
887 $pkg =~ s/[^[:word:]]/_/g; 881 $pkg =~ s/[^[:word:]]/_/g;
888 $pkg = "ext::$pkg"; 882 $pkg = "ext::$pkg";
889 883
890 warn "loading '$path' into '$pkg'\n"; 884 warn "... loading '$path' into '$pkg'\n";
891 885
892 open my $fh, "<:utf8", $path 886 open my $fh, "<:utf8", $path
893 or die "$path: $!"; 887 or die "$path: $!";
894 888
895 my $source = 889 my $source =
896 "package $pkg; use strict; use utf8;\n" 890 "package $pkg; use strict; use utf8;\n"
897 . "#line 1 \"$path\"\n{\n" 891 . "#line 1 \"$path\"\n{\n"
898 . (do { local $/; <$fh> }) 892 . (do { local $/; <$fh> })
899 . "\n};\n1"; 893 . "\n};\n1";
900 894
901 eval $source 895 unless (eval $source) {
902 or die $@ ? "$path: $@\n" 896 my $msg = $@ ? "$path: $@\n"
903 : "extension disabled.\n"; 897 : "extension disabled.\n";
904 898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
905 push @exts, $pkg; 899 warn $@;
906 $ext_pkg{$base} = $pkg; 900 warn "mandatory extension failed to load, exiting.\n";
907 901 exit 1;
908# no strict 'refs'; 902 }
909# @{"$pkg\::ISA"} = ext::; 903 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# } 904 }
924 905
925 # remove commands 906 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} 907}
950 908
951sub load_extensions { 909sub load_extensions {
952 for my $ext (<$LIBDIR/*.ext>) { 910 for my $ext (<$LIBDIR/*.ext>) {
953 next unless -r $ext; 911 next unless -r $ext;
957 } or warn "$ext not loaded: $@"; 915 } or warn "$ext not loaded: $@";
958 } 916 }
959} 917}
960 918
961############################################################################# 919#############################################################################
962# load/save/clean perl data associated with a map
963 920
964*cf::mapsupport::on_clean = sub { 921=head2 CORE EXTENSIONS
922
923Functions and methods that extend core crossfire objects.
924
925=cut
926
927package cf::player;
928
929use Coro::AIO;
930
931=head3 cf::player
932
933=over 4
934
935=item cf::player::find $login
936
937Returns the given player object, loading it if necessary (might block).
938
939=cut
940
941sub playerdir($) {
942 cf::localdir
943 . "/"
944 . cf::playerdir
945 . "/"
946 . (ref $_[0] ? $_[0]->ob->name : $_[0])
947}
948
949sub path($) {
950 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951
952 (playerdir $login) . "/$login.pl"
953}
954
955sub find_active($) {
956 $cf::PLAYER{$_[0]}
957 and $cf::PLAYER{$_[0]}->active
958 and $cf::PLAYER{$_[0]}
959}
960
961sub exists($) {
962 my ($login) = @_;
963
964 $cf::PLAYER{$login}
965 or cf::sync_job { !aio_stat path $login }
966}
967
968sub find($) {
969 return $cf::PLAYER{$_[0]} || do {
970 my $login = $_[0];
971
972 my $guard = cf::lock_acquire "user_find:$login";
973
974 $cf::PLAYER{$_[0]} || do {
975 my $pl = load_pl path $login
976 or return;
977 $cf::PLAYER{$login} = $pl
978 }
979 }
980}
981
982sub save($) {
983 my ($pl) = @_;
984
985 return if $pl->{deny_save};
986
987 my $path = path $pl;
988 my $guard = cf::lock_acquire "user_save:$path";
989
990 return if $pl->{deny_save};
991
992 aio_mkdir playerdir $pl, 0770;
993 $pl->{last_save} = $cf::RUNTIME;
994
995 $pl->save_pl ($path);
996 Coro::cede;
997}
998
999sub new($) {
1000 my ($login) = @_;
1001
1002 my $self = create;
1003
1004 $self->ob->name ($login);
1005 $self->{deny_save} = 1;
1006
1007 $cf::PLAYER{$login} = $self;
1008
1009 $self
1010}
1011
1012=item $pl->quit_character
1013
1014Nukes the player without looking back. If logged in, the connection will
1015be destroyed. May block for a long time.
1016
1017=cut
1018
1019sub quit_character {
1020 my ($pl) = @_;
1021
1022 $pl->{deny_save} = 1;
1023 $pl->password ("*"); # this should lock out the player until we nuked the dir
1024
1025 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1026 $pl->deactivate;
1027 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1028 $pl->ns->destroy if $pl->ns;
1029
1030 my $path = playerdir $pl;
1031 my $temp = "$path~$cf::RUNTIME~deleting~";
1032 aio_rename $path, $temp;
1033 delete $cf::PLAYER{$pl->ob->name};
1034 $pl->destroy;
1035 IO::AIO::aio_rmtree $temp;
1036}
1037
1038=item cf::player::list_logins
1039
1040Returns am arrayref of all valid playernames in the system, can take a
1041while and may block, so not sync_job-capable, ever.
1042
1043=cut
1044
1045sub list_logins {
1046 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1047 or return [];
1048
1049 my @logins;
1050
1051 for my $login (@$dirs) {
1052 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1053 aio_read $fh, 0, 512, my $buf, 0 or next;
1054 $buf !~ /^password -------------$/m or next; # official not-valid tag
1055
1056 utf8::decode $login;
1057 push @logins, $login;
1058 }
1059
1060 \@logins
1061}
1062
1063=item $player->maps
1064
1065Returns an arrayref of map paths that are private for this
1066player. May block.
1067
1068=cut
1069
1070sub maps($) {
1071 my ($pl) = @_;
1072
1073 my $files = aio_readdir playerdir $pl
1074 or return;
1075
1076 my @paths;
1077
1078 for (@$files) {
1079 utf8::decode $_;
1080 next if /\.(?:pl|pst)$/;
1081 next unless /^$PATH_SEP/o;
1082
1083 s/\.map$//;
1084 push @paths, "~" . $pl->ob->name . "/" . $_;
1085 }
1086
1087 \@paths
1088}
1089
1090=item $player->ext_reply ($msgid, $msgtype, %msg)
1091
1092Sends an ext reply to the player.
1093
1094=cut
1095
1096sub ext_reply($$$%) {
1097 my ($self, $id, %msg) = @_;
1098
1099 $msg{msgid} = $id;
1100
1101 $self->send ("ext " . cf::to_json \%msg);
1102}
1103
1104package cf;
1105
1106=back
1107
1108
1109=head3 cf::map
1110
1111=over 4
1112
1113=cut
1114
1115package cf::map;
1116
1117use Fcntl;
1118use Coro::AIO;
1119
1120use overload
1121 '""' => \&as_string,
1122 fallback => 1;
1123
1124our $MAX_RESET = 3600;
1125our $DEFAULT_RESET = 3000;
1126
1127sub generate_random_map {
1128 my ($self, $rmp) = @_;
1129 # mit "rum" bekleckern, nicht
1130 $self->_create_random_map (
1131 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1132 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1133 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1134 $rmp->{exit_on_final_map},
1135 $rmp->{xsize}, $rmp->{ysize},
1136 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1137 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1138 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1139 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1140 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1141 (cf::region::find $rmp->{region}), $rmp->{custom}
1142 )
1143}
1144
1145=item cf::map->register ($regex, $prio)
1146
1147Register a handler for the map path matching the given regex at the
1148givne priority (higher is better, built-in handlers have priority 0, the
1149default).
1150
1151=cut
1152
1153sub register {
1154 my (undef, $regex, $prio) = @_;
1155 my $pkg = caller;
1156
1157 no strict;
1158 push @{"$pkg\::ISA"}, __PACKAGE__;
1159
1160 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1161}
1162
1163# also paths starting with '/'
1164$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1165
1166sub thawer_merge {
1167 my ($self, $merge) = @_;
1168
1169 # we have to keep some variables in memory intact
1170 local $self->{path};
1171 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174
1175 $self->SUPER::thawer_merge ($merge);
1176}
1177
1178sub normalise {
1179 my ($path, $base) = @_;
1180
1181 $path = "$path"; # make sure its a string
1182
1183 # map plan:
1184 #
1185 # /! non-realised random map exit (special hack!)
1186 # {... are special paths that are not being touched
1187 # ?xxx/... are special absolute paths
1188 # ?random/... random maps
1189 # /... normal maps
1190 # ~user/... per-player map of a specific user
1191
1192 $path =~ s/$PATH_SEP/\//go;
1193
1194 # treat it as relative path if it starts with
1195 # something that looks reasonable
1196 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1197 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1198
1199 $base =~ s{[^/]+/?$}{};
1200 $path = "$base/$path";
1201 }
1202
1203 for ($path) {
1204 redo if s{//}{/};
1205 redo if s{/\.?/}{/};
1206 redo if s{/[^/]+/\.\./}{/};
1207 }
1208
1209 $path
1210}
1211
1212sub new_from_path {
1213 my (undef, $path, $base) = @_;
1214
1215 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1216
1217 $path = normalise $path, $base;
1218
1219 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1220 if ($path =~ $EXT_MAP{$pkg}[1]) {
1221 my $self = bless cf::map::new, $pkg;
1222 $self->{path} = $path; $self->path ($path);
1223 $self->init; # pass $1 etc.
1224 return $self;
1225 }
1226 }
1227
1228 Carp::carp "unable to resolve path '$path' (base '$base').";
1229 ()
1230}
1231
1232sub init {
1233 my ($self) = @_;
1234
1235 $self
1236}
1237
1238sub as_string {
1239 my ($self) = @_;
1240
1241 "$self->{path}"
1242}
1243
1244# the displayed name, this is a one way mapping
1245sub visible_name {
1246 &as_string
1247}
1248
1249# the original (read-only) location
1250sub load_path {
1251 my ($self) = @_;
1252
1253 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1254}
1255
1256# the temporary/swap location
1257sub save_path {
1258 my ($self) = @_;
1259
1260 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1262}
1263
1264# the unique path, undef == no special unique path
1265sub uniq_path {
1266 my ($self) = @_;
1267
1268 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1270}
1271
1272# and all this just because we cannot iterate over
1273# all maps in C++...
1274sub change_all_map_light {
1275 my ($change) = @_;
1276
1277 $_->change_map_light ($change)
1278 for grep $_->outdoor, values %cf::MAP;
1279}
1280
1281sub unlink_save {
1282 my ($self) = @_;
1283
1284 utf8::encode (my $save = $self->save_path);
1285 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1286 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1287}
1288
1289sub load_header_from($) {
1290 my ($self, $path) = @_;
1291
1292 utf8::encode $path;
1293 aio_open $path, O_RDONLY, 0
1294 or return;
1295
1296 $self->_load_header ($path)
1297 or return;
1298
1299 $self->{load_path} = $path;
1300
1301 1
1302}
1303
1304sub load_header_orig {
1305 my ($self) = @_;
1306
1307 $self->load_header_from ($self->load_path)
1308}
1309
1310sub load_header_temp {
1311 my ($self) = @_;
1312
1313 $self->load_header_from ($self->save_path)
1314}
1315
1316sub prepare_temp {
1317 my ($self) = @_;
1318
1319 $self->last_access ((delete $self->{last_access})
1320 || $cf::RUNTIME); #d#
1321 # safety
1322 $self->{instantiate_time} = $cf::RUNTIME
1323 if $self->{instantiate_time} > $cf::RUNTIME;
1324}
1325
1326sub prepare_orig {
1327 my ($self) = @_;
1328
1329 $self->{load_original} = 1;
1330 $self->{instantiate_time} = $cf::RUNTIME;
1331 $self->last_access ($cf::RUNTIME);
1332 $self->instantiate;
1333}
1334
1335sub load_header {
1336 my ($self) = @_;
1337
1338 if ($self->load_header_temp) {
1339 $self->prepare_temp;
1340 } else {
1341 $self->load_header_orig
1342 or return;
1343 $self->prepare_orig;
1344 }
1345
1346 1
1347}
1348
1349sub find;
1350sub find {
1351 my ($path, $origin) = @_;
1352
1353 $path = normalise $path, $origin && $origin->path;
1354
1355 cf::lock_wait "map_find:$path";
1356
1357 $cf::MAP{$path} || do {
1358 my $guard = cf::lock_acquire "map_find:$path";
1359 my $map = new_from_path cf::map $path
1360 or return;
1361
1362 $map->{last_save} = $cf::RUNTIME;
1363
1364 $map->load_header
1365 or return;
1366
1367 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1368 # doing this can freeze the server in a sync job, obviously
1369 #$cf::WAIT_FOR_TICK->wait;
1370 $map->reset;
1371 undef $guard;
1372 return find $path;
1373 }
1374
1375 $cf::MAP{$path} = $map
1376 }
1377}
1378
1379sub pre_load { }
1380sub post_load { }
1381
1382sub load {
1383 my ($self) = @_;
1384
1385 local $self->{deny_reset} = 1; # loading can take a long time
1386
1387 my $path = $self->{path};
1388 my $guard = cf::lock_acquire "map_load:$path";
1389
1390 return if $self->in_memory != cf::MAP_SWAPPED;
1391
1392 $self->in_memory (cf::MAP_LOADING);
1393
1394 $self->alloc;
1395
1396 $self->pre_load;
1397
1398 $self->_load_objects ($self->{load_path}, 1)
1399 or return;
1400
1401 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1402 if delete $self->{load_original};
1403
1404 if (my $uniq = $self->uniq_path) {
1405 utf8::encode $uniq;
1406 if (aio_open $uniq, O_RDONLY, 0) {
1407 $self->clear_unique_items;
1408 $self->_load_objects ($uniq, 0);
1409 }
1410 }
1411
1412 Coro::cede;
1413
1414 # now do the right thing for maps
1415 $self->link_multipart_objects;
1416
1417 unless ($self->{deny_activate}) {
1418 $self->decay_objects;
1419 $self->fix_auto_apply;
1420 $self->update_buttons;
1421 Coro::cede;
1422 $self->set_darkness_map;
1423 $self->difficulty ($self->estimate_difficulty)
1424 unless $self->difficulty;
1425 Coro::cede;
1426 $self->activate;
1427 }
1428
1429 $self->post_load;
1430
1431 $self->in_memory (cf::MAP_IN_MEMORY);
1432}
1433
1434sub customise_for {
1435 my ($self, $ob) = @_;
1436
1437 return find "~" . $ob->name . "/" . $self->{path}
1438 if $self->per_player;
1439
1440 $self
1441}
1442
1443# find and load all maps in the 3x3 area around a map
1444sub load_diag {
965 my ($map) = @_; 1445 my ($map) = @_;
966 1446
967 my $path = $map->tmpname; 1447 my @diag; # diagonal neighbours
968 defined $path or return;
969 1448
970 unlink "$path.pst"; 1449 for (0 .. 3) {
971}; 1450 my $neigh = $map->tile_path ($_)
1451 or next;
1452 $neigh = find $neigh, $map
1453 or next;
1454 $neigh->load;
972 1455
973cf::map->attach (prio => -10000, package => cf::mapsupport::); 1456 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1457 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1458 }
974 1459
975############################################################################# 1460 for (@diag) {
976# load/save perl data associated with player->ob objects 1461 my $neigh = find @$_
977 1462 or next;
978sub all_objects(@) { 1463 $neigh->load;
979 @_, map all_objects ($_->inv), @_ 1464 }
980} 1465}
981 1466
982# TODO: compatibility cruft, remove when no longer needed 1467sub find_sync {
983cf::player->attach ( 1468 my ($path, $origin) = @_;
984 on_load => sub {
985 my ($pl, $path) = @_;
986 1469
987 for my $o (all_objects $pl->ob) { 1470 cf::sync_job { find $path, $origin }
988 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1471}
989 $o->set_ob_key_value ("_perl_data");
990 1472
991 %$o = %{ Storable::thaw pack "H*", $value }; 1473sub do_load_sync {
1474 my ($map) = @_;
1475
1476 cf::sync_job { $map->load };
1477}
1478
1479our %MAP_PREFETCH;
1480our $MAP_PREFETCHER = undef;
1481
1482sub find_async {
1483 my ($path, $origin) = @_;
1484
1485 $path = normalise $path, $origin && $origin->{path};
1486
1487 if (my $map = $cf::MAP{$path}) {
1488 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1489 }
1490
1491 undef $MAP_PREFETCH{$path};
1492 $MAP_PREFETCHER ||= cf::async {
1493 while (%MAP_PREFETCH) {
1494 for my $path (keys %MAP_PREFETCH) {
1495 my $map = find $path
1496 or next;
1497 $map->load;
1498
1499 delete $MAP_PREFETCH{$path};
992 } 1500 }
993 } 1501 }
1502 undef $MAP_PREFETCHER;
1503 };
1504 $MAP_PREFETCHER->prio (6);
1505
1506 ()
1507}
1508
1509sub save {
1510 my ($self) = @_;
1511
1512 my $lock = cf::lock_acquire "map_data:" . $self->path;
1513
1514 $self->{last_save} = $cf::RUNTIME;
1515
1516 return unless $self->dirty;
1517
1518 my $save = $self->save_path; utf8::encode $save;
1519 my $uniq = $self->uniq_path; utf8::encode $uniq;
1520
1521 $self->{load_path} = $save;
1522
1523 return if $self->{deny_save};
1524
1525 local $self->{last_access} = $self->last_access;#d#
1526
1527 cf::async {
1528 $_->contr->save for $self->players;
1529 };
1530
1531 if ($uniq) {
1532 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1533 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1534 } else {
1535 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
994 }, 1536 }
995); 1537}
996 1538
997############################################################################# 1539sub swap_out {
1540 my ($self) = @_;
998 1541
999=head2 CORE EXTENSIONS 1542 # save first because save cedes
1543 $self->save;
1000 1544
1001Functions and methods that extend core crossfire objects. 1545 my $lock = cf::lock_acquire "map_data:" . $self->path;
1002 1546
1003=head3 cf::player 1547 return if $self->players;
1548 return if $self->in_memory != cf::MAP_IN_MEMORY;
1549 return if $self->{deny_save};
1550
1551 $self->clear;
1552 $self->in_memory (cf::MAP_SWAPPED);
1553}
1554
1555sub reset_at {
1556 my ($self) = @_;
1557
1558 # TODO: safety, remove and allow resettable per-player maps
1559 return 1e99 if $self->isa ("ext::map_per_player");#d#
1560 return 1e99 if $self->{deny_reset};
1561
1562 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1563 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1564
1565 $time + $to
1566}
1567
1568sub should_reset {
1569 my ($self) = @_;
1570
1571 $self->reset_at <= $cf::RUNTIME
1572}
1573
1574sub reset {
1575 my ($self) = @_;
1576
1577 my $lock = cf::lock_acquire "map_data:$self->{path}";
1578
1579 return if $self->players;
1580 return if $self->isa ("ext::map_per_player");#d#
1581
1582 warn "resetting map ", $self->path;#d#
1583
1584 delete $cf::MAP{$self->path};
1585
1586 $self->in_memory (cf::MAP_SWAPPED);
1587 $self->clear;
1588
1589 $_->clear_links_to ($self) for values %cf::MAP;
1590
1591 $self->unlink_save;
1592 $self->destroy;
1593}
1594
1595my $nuke_counter = "aaaa";
1596
1597sub nuke {
1598 my ($self) = @_;
1599
1600 delete $cf::MAP{$self->path};
1601
1602 $self->unlink_save;
1603
1604 bless $self, "cf::map";
1605 delete $self->{deny_reset};
1606 $self->{deny_save} = 1;
1607 $self->reset_timeout (1);
1608 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1609
1610 $cf::MAP{$self->path} = $self;
1611
1612 $self->reset; # polite request, might not happen
1613}
1614
1615=item cf::map::unique_maps
1616
1617Returns an arrayref of paths of all shared maps that have
1618instantiated unique items. May block.
1619
1620=cut
1621
1622sub unique_maps() {
1623 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1624 or return;
1625
1626 my @paths;
1627
1628 for (@$files) {
1629 utf8::decode $_;
1630 next if /\.pst$/;
1631 next unless /^$PATH_SEP/o;
1632
1633 s/\.map$//;
1634 push @paths, $_;
1635 }
1636
1637 \@paths
1638}
1639
1640package cf;
1641
1642=back
1643
1644=head3 cf::object
1645
1646=cut
1647
1648package cf::object;
1004 1649
1005=over 4 1650=over 4
1006 1651
1007=item cf::player::exists $login 1652=item $ob->inv_recursive
1008 1653
1009Returns true when the given account exists. 1654Returns the inventory of the object _and_ their inventories, recursively.
1010 1655
1011=cut 1656=cut
1012 1657
1013sub cf::player::exists($) { 1658sub inv_recursive_;
1014 cf::player::find $_[0] 1659sub inv_recursive_ {
1015 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1660 map { $_, inv_recursive_ $_->inv } @_
1016} 1661}
1017 1662
1018=item $player->ext_reply ($msgid, $msgtype, %msg) 1663sub inv_recursive {
1019 1664 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} 1665}
1666
1667package cf;
1031 1668
1032=back 1669=back
1033 1670
1034=head3 cf::object::player 1671=head3 cf::object::player
1035 1672
1073 (ref $cf::CFG{"may_$access"} 1710 (ref $cf::CFG{"may_$access"}
1074 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1711 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1075 : $cf::CFG{"may_$access"}) 1712 : $cf::CFG{"may_$access"})
1076} 1713}
1077 1714
1715=item $player_object->enter_link
1716
1717Freezes the player and moves him/her to a special map (C<{link}>).
1718
1719The player should be reasonably safe there for short amounts of time. You
1720I<MUST> call C<leave_link> as soon as possible, though.
1721
1722Will never block.
1723
1724=item $player_object->leave_link ($map, $x, $y)
1725
1726Moves the player out of the special C<{link}> map onto the specified
1727map. If the map is not valid (or omitted), the player will be moved back
1728to the location he/she was before the call to C<enter_link>, or, if that
1729fails, to the emergency map position.
1730
1731Might block.
1732
1733=cut
1734
1735sub link_map {
1736 unless ($LINK_MAP) {
1737 $LINK_MAP = cf::map::find "{link}"
1738 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1739 $LINK_MAP->load;
1740 }
1741
1742 $LINK_MAP
1743}
1744
1745sub cf::object::player::enter_link {
1746 my ($self) = @_;
1747
1748 $self->deactivate_recursive;
1749
1750 return if UNIVERSAL::isa $self->map, "ext::map_link";
1751
1752 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1753 if $self->map;
1754
1755 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1756}
1757
1758sub cf::object::player::leave_link {
1759 my ($self, $map, $x, $y) = @_;
1760
1761 my $link_pos = delete $self->{_link_pos};
1762
1763 unless ($map) {
1764 # restore original map position
1765 ($map, $x, $y) = @{ $link_pos || [] };
1766 $map = cf::map::find $map;
1767
1768 unless ($map) {
1769 ($map, $x, $y) = @$EMERGENCY_POSITION;
1770 $map = cf::map::find $map
1771 or die "FATAL: cannot load emergency map\n";
1772 }
1773 }
1774
1775 ($x, $y) = (-1, -1)
1776 unless (defined $x) && (defined $y);
1777
1778 # use -1 or undef as default coordinates, not 0, 0
1779 ($x, $y) = ($map->enter_x, $map->enter_y)
1780 if $x <=0 && $y <= 0;
1781
1782 $map->load;
1783 $map->load_diag;
1784
1785 return unless $self->contr->active;
1786 $self->activate_recursive;
1787 $self->enter_map ($map, $x, $y);
1788}
1789
1790cf::player->attach (
1791 on_logout => sub {
1792 my ($pl) = @_;
1793
1794 # abort map switching before logout
1795 if ($pl->ob->{_link_pos}) {
1796 cf::sync_job {
1797 $pl->ob->leave_link
1798 };
1799 }
1800 },
1801 on_login => sub {
1802 my ($pl) = @_;
1803
1804 # try to abort aborted map switching on player login :)
1805 # should happen only on crashes
1806 if ($pl->ob->{_link_pos}) {
1807 $pl->ob->enter_link;
1808 (async {
1809 # we need this sleep as the login has a concurrent enter_exit running
1810 # and this sleep increases chances of the player not ending up in scorn
1811 $pl->ob->reply (undef,
1812 "There was an internal problem at your last logout, "
1813 . "the server will try to bring you to your intended destination in a second.",
1814 cf::NDI_RED);
1815 Coro::Timer::sleep 1;
1816 $pl->ob->leave_link;
1817 })->prio (2);
1818 }
1819 },
1820);
1821
1822=item $player_object->goto ($path, $x, $y)
1823
1824=cut
1825
1826sub cf::object::player::goto {
1827 my ($self, $path, $x, $y) = @_;
1828
1829 $self->enter_link;
1830
1831 (async {
1832 my $map = eval {
1833 my $map = cf::map::find $path;
1834 $map = $map->customise_for ($self) if $map;
1835 $map
1836 } or
1837 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1838
1839 $self->leave_link ($map, $x, $y);
1840 })->prio (1);
1841}
1842
1843=item $player_object->enter_exit ($exit_object)
1844
1845=cut
1846
1847sub parse_random_map_params {
1848 my ($spec) = @_;
1849
1850 my $rmp = { # defaults
1851 xsize => (cf::rndm 15, 40),
1852 ysize => (cf::rndm 15, 40),
1853 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1854 #layout => string,
1855 };
1856
1857 for (split /\n/, $spec) {
1858 my ($k, $v) = split /\s+/, $_, 2;
1859
1860 $rmp->{lc $k} = $v if (length $k) && (length $v);
1861 }
1862
1863 $rmp
1864}
1865
1866sub prepare_random_map {
1867 my ($exit) = @_;
1868
1869 my $guard = cf::lock_acquire "exit_prepare:$exit";
1870
1871 # all this does is basically replace the /! path by
1872 # a new random map path (?random/...) with a seed
1873 # that depends on the exit object
1874
1875 my $rmp = parse_random_map_params $exit->msg;
1876
1877 if ($exit->map) {
1878 $rmp->{region} = $exit->region->name;
1879 $rmp->{origin_map} = $exit->map->path;
1880 $rmp->{origin_x} = $exit->x;
1881 $rmp->{origin_y} = $exit->y;
1882 }
1883
1884 $rmp->{random_seed} ||= $exit->random_seed;
1885
1886 my $data = cf::to_json $rmp;
1887 my $md5 = Digest::MD5::md5_hex $data;
1888 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1889
1890 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1891 aio_write $fh, 0, (length $data), $data, 0;
1892 undef $fh;
1893 aio_rename "$meta~", $meta;
1894
1895 $exit->slaying ("?random/$md5");
1896 $exit->msg (undef);
1897 }
1898}
1899
1900sub cf::object::player::enter_exit {
1901 my ($self, $exit) = @_;
1902
1903 return unless $self->type == cf::PLAYER;
1904
1905 if ($exit->slaying eq "/!") {
1906 #TODO: this should de-fi-ni-te-ly not be a sync-job
1907 cf::sync_job { prepare_random_map $exit };
1908 }
1909
1910 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1911 my $hp = $exit->stats->hp;
1912 my $sp = $exit->stats->sp;
1913
1914 $self->enter_link;
1915
1916 (async {
1917 $self->deactivate_recursive; # just to be sure
1918 unless (eval {
1919 $self->goto ($slaying, $hp, $sp);
1920
1921 1;
1922 }) {
1923 $self->message ("Something went wrong deep within the crossfire server. "
1924 . "I'll try to bring you back to the map you were before. "
1925 . "Please report this to the dungeon master!",
1926 cf::NDI_UNIQUE | cf::NDI_RED);
1927
1928 warn "ERROR in enter_exit: $@";
1929 $self->leave_link;
1930 }
1931 })->prio (1);
1932}
1933
1078=head3 cf::client 1934=head3 cf::client
1079 1935
1080=over 4 1936=over 4
1081 1937
1082=item $client->send_drawinfo ($text, $flags) 1938=item $client->send_drawinfo ($text, $flags)
1125 on_reply => sub { 1981 on_reply => sub {
1126 my ($ns, $msg) = @_; 1982 my ($ns, $msg) = @_;
1127 1983
1128 # this weird shuffling is so that direct followup queries 1984 # this weird shuffling is so that direct followup queries
1129 # get handled first 1985 # get handled first
1130 my $queue = delete $ns->{query_queue}; 1986 my $queue = delete $ns->{query_queue}
1987 or return; # be conservative, not sure how that can happen, but we saw a crash here
1131 1988
1132 (shift @$queue)->[1]->($msg); 1989 (shift @$queue)->[1]->($msg);
1133 1990
1134 push @{ $ns->{query_queue} }, @$queue; 1991 push @{ $ns->{query_queue} }, @$queue;
1135 1992
1141 } 1998 }
1142 } 1999 }
1143 }, 2000 },
1144); 2001);
1145 2002
1146=item $client->coro (\&cb) 2003=item $client->async (\&cb)
1147 2004
1148Create a new coroutine, running the specified callback. The coroutine will 2005Create a new coroutine, running the specified callback. The coroutine will
1149be automatically cancelled when the client gets destroyed (e.g. on logout, 2006be automatically cancelled when the client gets destroyed (e.g. on logout,
1150or loss of connection). 2007or loss of connection).
1151 2008
1152=cut 2009=cut
1153 2010
1154sub cf::client::coro { 2011sub cf::client::async {
1155 my ($self, $cb) = @_; 2012 my ($self, $cb) = @_;
1156 2013
1157 my $coro; $coro = async { 2014 my $coro = &Coro::async ($cb);
1158 eval {
1159 $cb->();
1160 };
1161 warn $@ if $@;
1162 };
1163 2015
1164 $coro->on_destroy (sub { 2016 $coro->on_destroy (sub {
1165 delete $self->{_coro}{$coro+0}; 2017 delete $self->{_coro}{$coro+0};
1166 }); 2018 });
1167 2019
1339 2191
1340{ 2192{
1341 my $path = cf::localdir . "/database.pst"; 2193 my $path = cf::localdir . "/database.pst";
1342 2194
1343 sub db_load() { 2195 sub db_load() {
1344 warn "loading database $path\n";#d# remove later
1345 $DB = stat $path ? Storable::retrieve $path : { }; 2196 $DB = stat $path ? Storable::retrieve $path : { };
1346 } 2197 }
1347 2198
1348 my $pid; 2199 my $pid;
1349 2200
1350 sub db_save() { 2201 sub db_save() {
1351 warn "saving database $path\n";#d# remove later
1352 waitpid $pid, 0 if $pid; 2202 waitpid $pid, 0 if $pid;
1353 if (0 == ($pid = fork)) { 2203 if (0 == ($pid = fork)) {
1354 $DB->{_meta}{version} = 1; 2204 $DB->{_meta}{version} = 1;
1355 Storable::nstore $DB, "$path~"; 2205 Storable::nstore $DB, "$path~";
1356 rename "$path~", $path; 2206 rename "$path~", $path;
1363 sub db_sync() { 2213 sub db_sync() {
1364 db_save if $dirty; 2214 db_save if $dirty;
1365 undef $dirty; 2215 undef $dirty;
1366 } 2216 }
1367 2217
1368 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2218 my $idle = Event->idle (
1369 db_sync; 2219 reentrant => 0,
2220 min => 10,
2221 max => 20,
2222 repeat => 0,
2223 data => WF_AUTOCANCEL,
2224 cb => \&db_sync,
1370 }); 2225 );
1371 2226
1372 sub db_dirty() { 2227 sub db_dirty() {
1373 $dirty = 1; 2228 $dirty = 1;
1374 $idle->start; 2229 $idle->start;
1375 } 2230 }
1404 open my $fh, "<:utf8", cf::confdir . "/config" 2259 open my $fh, "<:utf8", cf::confdir . "/config"
1405 or return; 2260 or return;
1406 2261
1407 local $/; 2262 local $/;
1408 *CFG = YAML::Syck::Load <$fh>; 2263 *CFG = YAML::Syck::Load <$fh>;
2264
2265 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2266
2267 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2268 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2269
2270 if (exists $CFG{mlockall}) {
2271 eval {
2272 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2273 and die "WARNING: m(un)lockall failed: $!\n";
2274 };
2275 warn $@ if $@;
2276 }
1409} 2277}
1410 2278
1411sub main { 2279sub main {
1412 # we must not ever block the main coroutine 2280 # we must not ever block the main coroutine
1413 local $Coro::idle = sub { 2281 local $Coro::idle = sub {
1414 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2282 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1415 (Coro::unblock_sub { 2283 (async {
1416 Event::one_event; 2284 Event::one_event;
1417 })->(); 2285 })->prio (Coro::PRIO_MAX);
1418 }; 2286 };
1419 2287
1420 cfg_load; 2288 cfg_load;
1421 db_load; 2289 db_load;
1422 load_extensions; 2290 load_extensions;
2291
2292 $TICK_WATCHER->start;
1423 Event::loop; 2293 Event::loop;
1424} 2294}
1425 2295
1426############################################################################# 2296#############################################################################
1427# initialisation 2297# initialisation and cleanup
1428 2298
2299# install some emergency cleanup handlers
2300BEGIN {
2301 for my $signal (qw(INT HUP TERM)) {
2302 Event->signal (
2303 reentrant => 0,
2304 data => WF_AUTOCANCEL,
2305 signal => $signal,
2306 prio => 0,
2307 cb => sub {
2308 cf::cleanup "SIG$signal";
2309 },
2310 );
2311 }
2312}
2313
2314sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop;
2316
2317 warn "enter emergency perl save\n";
2318
2319 cf::sync_job {
2320 # use a peculiar iteration method to avoid tripping on perl
2321 # refcount bugs in for. also avoids problems with players
2322 # and maps saved/destroyed asynchronously.
2323 warn "begin emergency player save\n";
2324 for my $login (keys %cf::PLAYER) {
2325 my $pl = $cf::PLAYER{$login} or next;
2326 $pl->valid or next;
2327 $pl->save;
2328 }
2329 warn "end emergency player save\n";
2330
2331 warn "begin emergency map save\n";
2332 for my $path (keys %cf::MAP) {
2333 my $map = $cf::MAP{$path} or next;
2334 $map->valid or next;
2335 $map->save;
2336 }
2337 warn "end emergency map save\n";
2338 };
2339
2340 warn "leave emergency perl save\n";
2341}
2342
1429sub perl_reload() { 2343sub reload() {
1430 # can/must only be called in main 2344 # can/must only be called in main
1431 if ($Coro::current != $Coro::main) { 2345 if ($Coro::current != $Coro::main) {
1432 warn "can only reload from main coroutine\n"; 2346 warn "can only reload from main coroutine";
1433 return; 2347 return;
1434 } 2348 }
1435 2349
1436 warn "reloading..."; 2350 warn "reloading...";
1437 2351
1438 local $FREEZE = 1; 2352 warn "cancelling server ticker";
2353 $TICK_WATCHER->cancel;
2354
1439 cf::emergency_save; 2355 cf::emergency_save;
1440 2356
1441 eval { 2357 eval {
1442 # if anything goes wrong in here, we should simply crash as we already saved 2358 # if anything goes wrong in here, we should simply crash as we already saved
1443 2359
1444 # cancel all watchers 2360 warn "syncing database to disk";
2361 cf::db_sync;
2362
2363 warn "cancelling all WF_AUTOCANCEL watchers";
1445 for (Event::all_watchers) { 2364 for (Event::all_watchers) {
1446 $_->cancel if $_->data & WF_AUTOCANCEL; 2365 $_->cancel if $_->data & WF_AUTOCANCEL;
1447 } 2366 }
1448 2367
2368 warn "flushing outstanding aio requests";
2369 for (;;) {
2370 IO::AIO::flush;
2371 Coro::cede;
2372 last unless IO::AIO::nreqs;
2373 warn "iterate...";
2374 }
2375
1449 # cancel all extension coros 2376 warn "cancelling all extension coros";
1450 $_->cancel for values %EXT_CORO; 2377 $_->cancel for values %EXT_CORO;
1451 %EXT_CORO = (); 2378 %EXT_CORO = ();
1452 2379
1453 # unload all extensions 2380 warn "removing commands";
1454 for (@exts) { 2381 %COMMAND = ();
2382
2383 warn "removing ext commands";
2384 %EXTCMD = ();
2385
2386 warn "unloading/nuking all extensions";
2387 for my $pkg (@EXTS) {
1455 warn "unloading <$_>"; 2388 warn "... unloading $pkg";
1456 unload_extension $_; 2389
2390 if (my $cb = $pkg->can ("unload")) {
2391 eval {
2392 $cb->($pkg);
2393 1
2394 } or warn "$pkg unloaded, but with errors: $@";
1457 } 2395 }
1458 2396
2397 warn "... nuking $pkg";
2398 Symbol::delete_package $pkg;
2399 }
2400
1459 # unload all modules loaded from $LIBDIR 2401 warn "unloading all perl modules loaded from $LIBDIR";
1460 while (my ($k, $v) = each %INC) { 2402 while (my ($k, $v) = each %INC) {
1461 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2403 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1462 2404
1463 warn "removing <$k>"; 2405 warn "... unloading $k";
1464 delete $INC{$k}; 2406 delete $INC{$k};
1465 2407
1466 $k =~ s/\.pm$//; 2408 $k =~ s/\.pm$//;
1467 $k =~ s/\//::/g; 2409 $k =~ s/\//::/g;
1468 2410
1471 } 2413 }
1472 2414
1473 Symbol::delete_package $k; 2415 Symbol::delete_package $k;
1474 } 2416 }
1475 2417
1476 # sync database to disk
1477 cf::db_sync;
1478 IO::AIO::flush;
1479
1480 # get rid of safe::, as good as possible 2418 warn "getting rid of safe::, as good as possible";
1481 Symbol::delete_package "safe::$_" 2419 Symbol::delete_package "safe::$_"
1482 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2420 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1483 2421
1484 # remove register_script_function callbacks
1485 # TODO
1486
1487 # unload cf.pm "a bit" 2422 warn "unloading cf.pm \"a bit\"";
1488 delete $INC{"cf.pm"}; 2423 delete $INC{"cf.pm"};
1489 2424
1490 # don't, removes xs symbols, too, 2425 # don't, removes xs symbols, too,
1491 # and global variables created in xs 2426 # and global variables created in xs
1492 #Symbol::delete_package __PACKAGE__; 2427 #Symbol::delete_package __PACKAGE__;
1493 2428
1494 # reload cf.pm 2429 warn "unload completed, starting to reload now";
2430
1495 warn "reloading cf.pm"; 2431 warn "reloading cf.pm";
1496 require cf; 2432 require cf;
1497 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2433 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1498 2434
1499 # load config and database again 2435 warn "loading config and database again";
1500 cf::cfg_load; 2436 cf::cfg_load;
1501 cf::db_load; 2437 cf::db_load;
1502 2438
1503 # load extensions
1504 warn "load extensions"; 2439 warn "loading extensions";
1505 cf::load_extensions; 2440 cf::load_extensions;
1506 2441
1507 # reattach attachments to objects 2442 warn "reattaching attachments to objects/players";
1508 warn "reattach";
1509 _global_reattach; 2443 _global_reattach;
2444 warn "reattaching attachments to maps";
2445 reattach $_ for values %MAP;
2446
2447 warn "restarting server ticker";
2448
2449 $TICK_WATCHER->start;
1510 }; 2450 };
1511 2451
1512 if ($@) { 2452 if ($@) {
1513 warn $@; 2453 warn $@;
1514 warn "error while reloading, exiting."; 2454 warn "error while reloading, exiting.";
1515 exit 1; 2455 exit 1;
1516 } 2456 }
1517 2457
1518 warn "reloaded successfully"; 2458 warn "reloaded";
1519}; 2459};
1520 2460
1521############################################################################# 2461our $RELOAD_WATCHER; # used only during reload
1522 2462
1523unless ($LINK_MAP) {
1524 $LINK_MAP = cf::map::new;
1525
1526 $LINK_MAP->width (41);
1527 $LINK_MAP->height (41);
1528 $LINK_MAP->alloc;
1529 $LINK_MAP->path ("{link}");
1530 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1531 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1532}
1533
1534register "<global>", __PACKAGE__;
1535
1536register_command "perl-reload" => sub { 2463register_command "reload" => sub {
1537 my ($who, $arg) = @_; 2464 my ($who, $arg) = @_;
1538 2465
1539 if ($who->flag (FLAG_WIZ)) { 2466 if ($who->flag (FLAG_WIZ)) {
1540 $who->message ("start of reload.");
1541 perl_reload;
1542 $who->message ("end of reload."); 2467 $who->message ("reloading server.");
2468
2469 # doing reload synchronously and two reloads happen back-to-back,
2470 # coro crashes during coro_state_free->destroy here.
2471
2472 $RELOAD_WATCHER ||= Event->timer (
2473 reentrant => 0,
2474 after => 0,
2475 data => WF_AUTOCANCEL,
2476 cb => sub {
2477 reload;
2478 undef $RELOAD_WATCHER;
2479 },
2480 );
1543 } 2481 }
1544}; 2482};
1545 2483
1546unshift @INC, $LIBDIR; 2484unshift @INC, $LIBDIR;
2485
2486my $bug_warning = 0;
1547 2487
1548$TICK_WATCHER = Event->timer ( 2488$TICK_WATCHER = Event->timer (
1549 reentrant => 0, 2489 reentrant => 0,
2490 parked => 1,
1550 prio => 0, 2491 prio => 0,
1551 at => $NEXT_TICK || $TICK, 2492 at => $NEXT_TICK || $TICK,
1552 data => WF_AUTOCANCEL, 2493 data => WF_AUTOCANCEL,
1553 cb => sub { 2494 cb => sub {
1554 unless ($FREEZE) { 2495 if ($Coro::current != $Coro::main) {
2496 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2497 unless ++$bug_warning > 10;
2498 return;
2499 }
2500
2501 $NOW = Event::time;
2502
1555 cf::server_tick; # one server iteration 2503 cf::server_tick; # one server iteration
1556 $RUNTIME += $TICK; 2504 $RUNTIME += $TICK;
1557 }
1558
1559 $NEXT_TICK += $TICK; 2505 $NEXT_TICK += $TICK;
2506
2507 $WAIT_FOR_TICK->broadcast;
2508 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2509
2510 Event::sweep;
2511 Coro::cede_notself;
2512
2513# my $AFTER = Event::time;
2514# warn $AFTER - $NOW;#d#
1560 2515
1561 # if we are delayed by four ticks or more, skip them all 2516 # if we are delayed by four ticks or more, skip them all
1562 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2517 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1563 2518
1564 $TICK_WATCHER->at ($NEXT_TICK); 2519 $TICK_WATCHER->at ($NEXT_TICK);
1565 $TICK_WATCHER->start; 2520 $TICK_WATCHER->start;
1566 }, 2521 },
1567); 2522);
1568 2523
1569IO::AIO::max_poll_time $TICK * 0.2; 2524IO::AIO::max_poll_time $TICK * 0.1;
1570 2525
1571Event->io ( 2526undef $Coro::AIO::WATCHER;
2527$AIO_POLL_WATCHER = Event->io (
2528 reentrant => 0,
1572 fd => IO::AIO::poll_fileno, 2529 fd => IO::AIO::poll_fileno,
1573 poll => 'r', 2530 poll => 'r',
1574 prio => 5, 2531 prio => 6,
1575 data => WF_AUTOCANCEL, 2532 data => WF_AUTOCANCEL,
1576 cb => \&IO::AIO::poll_cb, 2533 cb => \&IO::AIO::poll_cb,
1577); 2534);
1578 2535
1579Event->timer ( 2536$WRITE_RUNTIME_WATCHER = Event->timer (
2537 reentrant => 0,
1580 data => WF_AUTOCANCEL, 2538 data => WF_AUTOCANCEL,
1581 after => 0, 2539 after => 1,
1582 interval => 10, 2540 interval => 10,
1583 cb => sub { 2541 prio => 6, # keep it lowest so it acts like a watchdog
1584 (Coro::unblock_sub { 2542 cb => Coro::unblock_sub {
1585 write_runtime 2543 write_runtime
1586 or warn "ERROR: unable to write runtime file: $!"; 2544 or warn "ERROR: unable to write runtime file: $!";
1587 })->();
1588 }, 2545 },
1589); 2546);
1590 2547
2548END { cf::emergency_save }
2549
15911 25501
1592 2551

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines