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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.181 by root, Fri Jan 19 15:29:52 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.4 ();
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 + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
257 (aio_write $fh, 0, (length $value), $value, 0) <= 0 355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
258 and return; 356 and return;
259 357
260 aio_fsync $fh 358 aio_fsync $fh
261 and return; 359 and return;
270} 368}
271 369
272=back 370=back
273 371
274=cut 372=cut
275
276#############################################################################
277
278package cf::path;
279
280sub new {
281 my ($class, $path, $base) = @_;
282
283 my $self = bless { }, $class;
284
285 if ($path =~ s{^\?random/}{}) {
286 $self->{random} = cf::from_json $path;
287 } else {
288 if ($path =~ s{^~([^/]+)?}{}) {
289 $self->{user_rel} = 1;
290
291 if (defined $1) {
292 $self->{user} = $1;
293 } elsif ($base =~ m{^~([^/]+)/}) {
294 $self->{user} = $1;
295 } else {
296 warn "cannot resolve user-relative path without user <$path,$base>\n";
297 }
298 } elsif ($path =~ /^\//) {
299 # already absolute
300 } else {
301 $base =~ s{[^/]+/?$}{};
302 return $class->new ("$base/$path");
303 }
304
305 for ($path) {
306 redo if s{/\.?/}{/};
307 redo if s{/[^/]+/\.\./}{/};
308 }
309 }
310
311 $self->{path} = $path;
312
313 $self
314}
315
316# the name / primary key / in-game path
317sub as_string {
318 my ($self) = @_;
319
320 $self->{user_rel} ? "~$self->{user}$self->{path}"
321 : $self->{random} ? "?random/$self->{path}"
322 : $self->{path}
323}
324
325# the displayed name, this is a one way mapping
326sub visible_name {
327 my ($self) = @_;
328
329 $self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
330 : $self->as_string
331}
332
333# escape the /'s in the path
334sub _escaped_path {
335 # ∕ is U+2215
336 (my $path = $_[0]{path}) =~ s/\//∕/g;
337 $path
338}
339
340# the original (read-only) location
341sub load_path {
342 my ($self) = @_;
343
344 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
345}
346
347# the temporary/swap location
348sub save_path {
349 my ($self) = @_;
350
351 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
352 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
353 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
354}
355
356# the unique path, might be eq to save_path
357sub uniq_path {
358 my ($self) = @_;
359
360 $self->{user_rel} || $self->{random}
361 ? undef
362 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
363}
364
365# return random map parameters, or undef
366sub random_map_params {
367 my ($self) = @_;
368
369 $self->{random}
370}
371
372# this is somewhat ugly, but style maps do need special treatment
373sub is_style_map {
374 $_[0]{path} =~ m{^/styles/}
375}
376
377package cf;
378 373
379############################################################################# 374#############################################################################
380 375
381=head2 ATTACHABLE OBJECTS 376=head2 ATTACHABLE OBJECTS
382 377
508our @CB_TYPE = (); # registry for type (cf-object class) based events 503our @CB_TYPE = (); # registry for type (cf-object class) based events
509our @CB_MAP = (); 504our @CB_MAP = ();
510 505
511my %attachment; 506my %attachment;
512 507
508sub cf::attachable::thawer_merge {
509 # simply override everything except _meta
510 local $_[0]{_meta};
511 %{$_[0]} = %{$_[1]};
512}
513
513sub _attach_cb($$$$) { 514sub _attach_cb($$$$) {
514 my ($registry, $event, $prio, $cb) = @_; 515 my ($registry, $event, $prio, $cb) = @_;
515 516
516 use sort 'stable'; 517 use sort 'stable';
517 518
688# object support 689# object support
689 690
690sub reattach { 691sub reattach {
691 # basically do the same as instantiate, without calling instantiate 692 # basically do the same as instantiate, without calling instantiate
692 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
693 696
694 my $registry = $obj->registry; 697 my $registry = $obj->registry;
695 698
696 @$registry = (); 699 @$registry = ();
697 700
790 or return; 793 or return;
791 794
792 unless (aio_stat "$filename.pst") { 795 unless (aio_stat "$filename.pst") {
793 (aio_load "$filename.pst", $av) >= 0 796 (aio_load "$filename.pst", $av) >= 0
794 or return; 797 or return;
795 $av = eval { (Storable::thaw <$av>)->{objs} }; 798 $av = eval { (Storable::thaw $av)->{objs} };
796 } 799 }
797 800
801 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d#
798 return ($data, $av); 803 return ($data, $av);
799} 804}
800 805
801############################################################################# 806#############################################################################
802# command handling &c 807# command handling &c
827=cut 832=cut
828 833
829sub register_extcmd { 834sub register_extcmd {
830 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
831 836
832 my $caller = caller;
833 #warn "registering extcmd '$name' to '$caller'";
834
835 $EXTCMD{$name} = [$cb, $caller]; 837 $EXTCMD{$name} = $cb;
836} 838}
837 839
838cf::player->attach ( 840cf::player->attach (
839 on_command => sub { 841 on_command => sub {
840 my ($pl, $name, $params) = @_; 842 my ($pl, $name, $params) = @_;
853 855
854 my $msg = eval { from_json $buf }; 856 my $msg = eval { from_json $buf };
855 857
856 if (ref $msg) { 858 if (ref $msg) {
857 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 859 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
858 if (my %reply = $cb->[0]->($pl, $msg)) { 860 if (my %reply = $cb->($pl, $msg)) {
859 $pl->ext_reply ($msg->{msgid}, %reply); 861 $pl->ext_reply ($msg->{msgid}, %reply);
860 } 862 }
861 } 863 }
862 } else { 864 } else {
863 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
865 867
866 cf::override; 868 cf::override;
867 }, 869 },
868); 870);
869 871
870sub register {
871 my ($base, $pkg) = @_;
872
873 #TODO
874}
875
876sub load_extension { 872sub load_extension {
877 my ($path) = @_; 873 my ($path) = @_;
878 874
879 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
880 my $base = $1; 876 my $base = $1;
881 my $pkg = $1; 877 my $pkg = $1;
882 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
883 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
884 880
885 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
886 882
887 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
888 or die "$path: $!"; 884 or die "$path: $!";
889 885
890 my $source = 886 my $source =
891 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
892 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
893 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
894 . "\n};\n1"; 890 . "\n};\n1";
895 891
896 eval $source 892 unless (eval $source) {
897 or die $@ ? "$path: $@\n" 893 my $msg = $@ ? "$path: $@\n"
898 : "extension disabled.\n"; 894 : "extension disabled.\n";
899 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
900 push @exts, $pkg; 896 warn $@;
901 $ext_pkg{$base} = $pkg; 897 warn "mandatory extension failed to load, exiting.\n";
902 898 exit 1;
903# no strict 'refs'; 899 }
904# @{"$pkg\::ISA"} = ext::; 900 die $@;
905
906 register $base, $pkg;
907}
908
909sub unload_extension {
910 my ($pkg) = @_;
911
912 warn "removing extension $pkg\n";
913
914 # remove hooks
915 #TODO
916# for my $idx (0 .. $#PLUGIN_EVENT) {
917# delete $hook[$idx]{$pkg};
918# } 901 }
919 902
920 # remove commands 903 push @EXTS, $pkg;
921 for my $name (keys %COMMAND) {
922 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
923
924 if (@cb) {
925 $COMMAND{$name} = \@cb;
926 } else {
927 delete $COMMAND{$name};
928 }
929 }
930
931 # remove extcmds
932 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
933 delete $EXTCMD{$name};
934 }
935
936 if (my $cb = $pkg->can ("unload")) {
937 eval {
938 $cb->($pkg);
939 1
940 } or warn "$pkg unloaded, but with errors: $@";
941 }
942
943 Symbol::delete_package $pkg;
944} 904}
945 905
946sub load_extensions { 906sub load_extensions {
947 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
948 next unless -r $ext; 908 next unless -r $ext;
952 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
953 } 913 }
954} 914}
955 915
956############################################################################# 916#############################################################################
957# load/save/clean perl data associated with a map
958 917
959*cf::mapsupport::on_clean = sub { 918=head2 CORE EXTENSIONS
919
920Functions and methods that extend core crossfire objects.
921
922=cut
923
924package cf::player;
925
926use Coro::AIO;
927
928=head3 cf::player
929
930=over 4
931
932=item cf::player::find $login
933
934Returns the given player object, loading it if necessary (might block).
935
936=cut
937
938sub playerdir($) {
939 cf::localdir
940 . "/"
941 . cf::playerdir
942 . "/"
943 . (ref $_[0] ? $_[0]->ob->name : $_[0])
944}
945
946sub path($) {
947 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948
949 (playerdir $login) . "/$login.pl"
950}
951
952sub find_active($) {
953 $cf::PLAYER{$_[0]}
954 and $cf::PLAYER{$_[0]}->active
955 and $cf::PLAYER{$_[0]}
956}
957
958sub exists($) {
959 my ($login) = @_;
960
961 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat path $login }
963}
964
965sub find($) {
966 return $cf::PLAYER{$_[0]} || do {
967 my $login = $_[0];
968
969 my $guard = cf::lock_acquire "user_find:$login";
970
971 $cf::PLAYER{$_[0]} || do {
972 my $pl = load_pl path $login
973 or return;
974 $cf::PLAYER{$login} = $pl
975 }
976 }
977}
978
979sub save($) {
980 my ($pl) = @_;
981
982 return if $pl->{deny_save};
983
984 my $path = path $pl;
985 my $guard = cf::lock_acquire "user_save:$path";
986
987 return if $pl->{deny_save};
988
989 aio_mkdir playerdir $pl, 0770;
990 $pl->{last_save} = $cf::RUNTIME;
991
992 $pl->save_pl ($path);
993 Coro::cede;
994}
995
996sub new($) {
997 my ($login) = @_;
998
999 my $self = create;
1000
1001 $self->ob->name ($login);
1002 $self->{deny_save} = 1;
1003
1004 $cf::PLAYER{$login} = $self;
1005
1006 $self
1007}
1008
1009=item $pl->quit_character
1010
1011Nukes the player without looking back. If logged in, the connection will
1012be destroyed. May block for a long time.
1013
1014=cut
1015
1016sub quit_character {
1017 my ($pl) = @_;
1018
1019 $pl->{deny_save} = 1;
1020 $pl->password ("*"); # this should lock out the player until we nuked the dir
1021
1022 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023 $pl->deactivate;
1024 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1025 $pl->ns->destroy if $pl->ns;
1026
1027 my $path = playerdir $pl;
1028 my $temp = "$path~$cf::RUNTIME~deleting~";
1029 aio_rename $path, $temp;
1030 delete $cf::PLAYER{$pl->ob->name};
1031 $pl->destroy;
1032 IO::AIO::aio_rmtree $temp;
1033}
1034
1035=item cf::player::list_logins
1036
1037Returns am arrayref of all valid playernames in the system, can take a
1038while and may block, so not sync_job-capable, ever.
1039
1040=cut
1041
1042sub list_logins {
1043 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1044 or return [];
1045
1046 my @logins;
1047
1048 for my $login (@$dirs) {
1049 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1050 aio_read $fh, 0, 512, my $buf, 0 or next;
1051 $buf !~ /^password -------------$/m or next; # official not-valid tag
1052
1053 utf8::decode $login;
1054 push @logins, $login;
1055 }
1056
1057 \@logins
1058}
1059
1060=item $player->maps
1061
1062Returns an arrayref of map paths that are private for this
1063player. May block.
1064
1065=cut
1066
1067sub maps($) {
1068 my ($pl) = @_;
1069
1070 my $files = aio_readdir playerdir $pl
1071 or return;
1072
1073 my @paths;
1074
1075 for (@$files) {
1076 utf8::decode $_;
1077 next if /\.(?:pl|pst)$/;
1078 next unless /^$PATH_SEP/o;
1079
1080 s/\.map$//;
1081 push @paths, "~" . $pl->ob->name . "/" . $_;
1082 }
1083
1084 \@paths
1085}
1086
1087=item $player->ext_reply ($msgid, $msgtype, %msg)
1088
1089Sends an ext reply to the player.
1090
1091=cut
1092
1093sub ext_reply($$$%) {
1094 my ($self, $id, %msg) = @_;
1095
1096 $msg{msgid} = $id;
1097
1098 $self->send ("ext " . cf::to_json \%msg);
1099}
1100
1101package cf;
1102
1103=back
1104
1105
1106=head3 cf::map
1107
1108=over 4
1109
1110=cut
1111
1112package cf::map;
1113
1114use Fcntl;
1115use Coro::AIO;
1116
1117use overload
1118 '""' => \&as_string,
1119 fallback => 1;
1120
1121our $MAX_RESET = 3600;
1122our $DEFAULT_RESET = 3000;
1123
1124sub generate_random_map {
1125 my ($self, $rmp) = @_;
1126 # mit "rum" bekleckern, nicht
1127 $self->_create_random_map (
1128 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{exit_on_final_map},
1132 $rmp->{xsize}, $rmp->{ysize},
1133 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}), $rmp->{custom}
1139 )
1140}
1141
1142sub register {
1143 my (undef, $regex) = @_;
1144 my $pkg = caller;
1145
1146 no strict;
1147 push @{"$pkg\::ISA"}, __PACKAGE__;
1148
1149 $EXT_MAP{$pkg} = qr<$regex>;
1150}
1151
1152# also paths starting with '/'
1153$EXT_MAP{"cf::map"} = qr{^(?=/)};
1154
1155sub thawer_merge {
1156 my ($self, $merge) = @_;
1157
1158 # we have to keep some variables in memory intact
1159 local $self->{path};
1160 local $self->{load_path};
1161 local $self->{deny_save};
1162 local $self->{deny_reset};
1163
1164 $self->SUPER::thawer_merge ($merge);
1165}
1166
1167sub normalise {
1168 my ($path, $base) = @_;
1169
1170 # map plan:
1171 #
1172 # /! non-realised random map exit (special hack!)
1173 # {... are special paths that are not being touched
1174 # ?xxx/... are special absolute paths
1175 # ?random/... random maps
1176 # /... normal maps
1177 # ~user/... per-player map of a specific user
1178
1179 $path =~ s/$PATH_SEP/\//go;
1180
1181 # treat it as relative path if it starts with
1182 # something that looks reasonable
1183 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1184 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1185
1186 $base =~ s{[^/]+/?$}{};
1187 $path = "$base/$path";
1188 }
1189
1190 for ($path) {
1191 redo if s{//}{/};
1192 redo if s{/\.?/}{/};
1193 redo if s{/[^/]+/\.\./}{/};
1194 }
1195
1196 $path
1197}
1198
1199sub new_from_path {
1200 my (undef, $path, $base) = @_;
1201
1202 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203
1204 $path = normalise $path, $base;
1205
1206 for my $pkg (keys %EXT_MAP) {
1207 if ($path =~ $EXT_MAP{$pkg}) {
1208 my $self = bless cf::map::new, $pkg;
1209 $self->{path} = $path; $self->path ($path);
1210 $self->init; # pass $1 etc.
1211 return $self;
1212 }
1213 }
1214
1215 Carp::carp "unable to resolve path '$path'.";
1216 ()
1217}
1218
1219sub init {
1220 my ($self) = @_;
1221
1222 $self
1223}
1224
1225sub as_string {
1226 my ($self) = @_;
1227
1228 "$self->{path}"
1229}
1230
1231# the displayed name, this is a one way mapping
1232sub visible_name {
1233 &as_string
1234}
1235
1236# the original (read-only) location
1237sub load_path {
1238 my ($self) = @_;
1239
1240 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1241}
1242
1243# the temporary/swap location
1244sub save_path {
1245 my ($self) = @_;
1246
1247 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1249}
1250
1251# the unique path, undef == no special unique path
1252sub uniq_path {
1253 my ($self) = @_;
1254
1255 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1257}
1258
1259# and all this just because we cannot iterate over
1260# all maps in C++...
1261sub change_all_map_light {
1262 my ($change) = @_;
1263
1264 $_->change_map_light ($change)
1265 for grep $_->outdoor, values %cf::MAP;
1266}
1267
1268sub unlink_save {
1269 my ($self) = @_;
1270
1271 utf8::encode (my $save = $self->save_path);
1272 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1273 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1274}
1275
1276sub load_header_from($) {
1277 my ($self, $path) = @_;
1278
1279 utf8::encode $path;
1280 aio_open $path, O_RDONLY, 0
1281 or return;
1282
1283 $self->_load_header ($path)
1284 or return;
1285
1286 $self->{load_path} = $path;
1287
1288 1
1289}
1290
1291sub load_orig {
1292 my ($self) = @_;
1293
1294 $self->load_header_from ($self->load_path)
1295}
1296
1297sub load_temp {
1298 my ($self) = @_;
1299
1300 $self->load_header_from ($self->save_path)
1301}
1302
1303sub load_header {
1304 my ($self) = @_;
1305
1306 if ($self->load_temp) {
1307 $self->last_access ((delete $self->{last_access})
1308 || $cf::RUNTIME); #d#
1309 # safety
1310 $self->{instantiate_time} = $cf::RUNTIME
1311 if $self->{instantiate_time} > $cf::RUNTIME;
1312 } else {
1313 $self->load_orig
1314 or return;
1315
1316 $self->{load_original} = 1;
1317 $self->{instantiate_time} = $cf::RUNTIME;
1318 $self->last_access ($cf::RUNTIME);
1319 $self->instantiate;
1320 }
1321
1322 1
1323}
1324
1325sub find;
1326sub find {
1327 my ($path, $origin) = @_;
1328
1329 $path = normalise $path, $origin && $origin->path;
1330
1331 cf::lock_wait "map_find:$path";
1332
1333 $cf::MAP{$path} || do {
1334 my $guard = cf::lock_acquire "map_find:$path";
1335 my $map = new_from_path cf::map $path
1336 or return;
1337
1338 $map->{last_save} = $cf::RUNTIME;
1339
1340 $map->load_header
1341 or return;
1342
1343 if ($map->should_reset) {
1344 $cf::WAIT_FOR_TICK->wait;
1345 $map->reset;
1346 undef $guard;
1347 $map = find $path
1348 or return;
1349 }
1350
1351 $cf::MAP{$path} = $map
1352 }
1353}
1354
1355sub load {
1356 my ($self) = @_;
1357
1358 my $path = $self->{path};
1359 my $guard = cf::lock_acquire "map_load:$path";
1360
1361 return if $self->in_memory != cf::MAP_SWAPPED;
1362
1363 $self->in_memory (cf::MAP_LOADING);
1364
1365 $self->alloc;
1366 $self->_load_objects ($self->{load_path}, 1)
1367 or return;
1368
1369 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1370 if delete $self->{load_original};
1371
1372 if (my $uniq = $self->uniq_path) {
1373 utf8::encode $uniq;
1374 if (aio_open $uniq, O_RDONLY, 0) {
1375 $self->clear_unique_items;
1376 $self->_load_objects ($uniq, 0);
1377 }
1378 }
1379
1380 Coro::cede;
1381
1382 # now do the right thing for maps
1383 $self->link_multipart_objects;
1384
1385 unless ($self->{deny_activate}) {
1386 $self->decay_objects;
1387 $self->fix_auto_apply;
1388 $self->update_buttons;
1389 Coro::cede;
1390 $self->set_darkness_map;
1391 $self->difficulty ($self->estimate_difficulty)
1392 unless $self->difficulty;
1393 Coro::cede;
1394 $self->activate;
1395 }
1396
1397 $self->in_memory (cf::MAP_IN_MEMORY);
1398}
1399
1400sub customise_for {
1401 my ($self, $ob) = @_;
1402
1403 return find "~" . $ob->name . "/" . $self->{path}
1404 if $self->per_player;
1405
1406 $self
1407}
1408
1409# find and load all maps in the 3x3 area around a map
1410sub load_diag {
960 my ($map) = @_; 1411 my ($map) = @_;
961 1412
962 my $path = $map->tmpname; 1413 my @diag; # diagonal neighbours
963 defined $path or return;
964 1414
965 unlink "$path.pst"; 1415 for (0 .. 3) {
1416 my $neigh = $map->tile_path ($_)
1417 or next;
1418 $neigh = find $neigh, $map
1419 or next;
1420 $neigh->load;
1421
1422 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1423 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1424 }
1425
1426 for (@diag) {
1427 my $neigh = find @$_
1428 or next;
1429 $neigh->load;
1430 }
1431}
1432
1433sub find_sync {
1434 my ($path, $origin) = @_;
1435
1436 cf::sync_job { find $path, $origin }
1437}
1438
1439sub do_load_sync {
1440 my ($map) = @_;
1441
1442 cf::sync_job { $map->load };
1443}
1444
1445our %MAP_PREFETCH;
1446our $MAP_PREFETCHER = Coro::async {
1447 while () {
1448 for my $path (keys %MAP_PREFETCH) {
1449 my $map = find $path
1450 or next;
1451 $map->load;
1452
1453 delete $MAP_PREFETCH{$path};
1454 }
1455 Coro::schedule;
1456 }
966}; 1457};
967 1458
968cf::map->attach (prio => -10000, package => cf::mapsupport::); 1459sub find_async {
1460 my ($path, $origin) = @_;
969 1461
970############################################################################# 1462 $path = normalise $path, $origin && $origin->{path};
971# load/save perl data associated with player->ob objects
972 1463
973sub all_objects(@) { 1464 if (my $map = $cf::MAP{$path}) {
974 @_, map all_objects ($_->inv), @_ 1465 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
975}
976
977# TODO: compatibility cruft, remove when no longer needed
978cf::player->attach (
979 on_load => sub {
980 my ($pl, $path) = @_;
981
982 for my $o (all_objects $pl->ob) {
983 if (my $value = $o->get_ob_key_value ("_perl_data")) {
984 $o->set_ob_key_value ("_perl_data");
985
986 %$o = %{ Storable::thaw pack "H*", $value };
987 }
988 }
989 }, 1466 }
990);
991 1467
992############################################################################# 1468 $MAP_PREFETCH{$path} = 0;
1469 $MAP_PREFETCHER->ready;
993 1470
994=head2 CORE EXTENSIONS 1471 ()
1472}
995 1473
996Functions and methods that extend core crossfire objects. 1474sub save {
1475 my ($self) = @_;
997 1476
998=head3 cf::player 1477 my $lock = cf::lock_acquire "map_data:" . $self->path;
1478
1479 $self->{last_save} = $cf::RUNTIME;
1480
1481 return unless $self->dirty;
1482
1483 my $save = $self->save_path; utf8::encode $save;
1484 my $uniq = $self->uniq_path; utf8::encode $uniq;
1485
1486 $self->{load_path} = $save;
1487
1488 return if $self->{deny_save};
1489
1490 local $self->{last_access} = $self->last_access;#d#
1491
1492 cf::async {
1493 $_->contr->save for $self->players;
1494 };
1495
1496 if ($uniq) {
1497 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1499 } else {
1500 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1501 }
1502}
1503
1504sub swap_out {
1505 my ($self) = @_;
1506
1507 # save first because save cedes
1508 $self->save;
1509
1510 my $lock = cf::lock_acquire "map_data:" . $self->path;
1511
1512 return if $self->players;
1513 return if $self->in_memory != cf::MAP_IN_MEMORY;
1514 return if $self->{deny_save};
1515
1516 $self->clear;
1517 $self->in_memory (cf::MAP_SWAPPED);
1518}
1519
1520sub reset_at {
1521 my ($self) = @_;
1522
1523 # TODO: safety, remove and allow resettable per-player maps
1524 return 1e99 if $self->isa ("ext::map_per_player");#d#
1525 return 1e99 if $self->{deny_reset};
1526
1527 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529
1530 $time + $to
1531}
1532
1533sub should_reset {
1534 my ($self) = @_;
1535
1536 $self->reset_at <= $cf::RUNTIME
1537}
1538
1539sub reset {
1540 my ($self) = @_;
1541
1542 my $lock = cf::lock_acquire "map_data:$self->{path}";
1543
1544 return if $self->players;
1545 return if $self->isa ("ext::map_per_player");#d#
1546
1547 warn "resetting map ", $self->path;#d#
1548
1549 delete $cf::MAP{$self->path};
1550
1551 $self->in_memory (cf::MAP_SWAPPED);
1552 $self->clear;
1553
1554 $_->clear_links_to ($self) for values %cf::MAP;
1555
1556 $self->unlink_save;
1557 $self->destroy;
1558}
1559
1560my $nuke_counter = "aaaa";
1561
1562sub nuke {
1563 my ($self) = @_;
1564
1565 delete $cf::MAP{$self->path};
1566
1567 $self->unlink_save;
1568
1569 bless $self, "cf::map";
1570 delete $self->{deny_reset};
1571 $self->{deny_save} = 1;
1572 $self->reset_timeout (1);
1573 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1574
1575 $cf::MAP{$self->path} = $self;
1576
1577 $self->reset; # polite request, might not happen
1578}
1579
1580=item cf::map::unique_maps
1581
1582Returns an arrayref of paths of all shared maps that have
1583instantiated unique items. May block.
1584
1585=cut
1586
1587sub unique_maps() {
1588 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1589 or return;
1590
1591 my @paths;
1592
1593 for (@$files) {
1594 utf8::decode $_;
1595 next if /\.pst$/;
1596 next unless /^$PATH_SEP/o;
1597
1598 s/\.map$//;
1599 push @paths, $_;
1600 }
1601
1602 \@paths
1603}
1604
1605package cf;
1606
1607=back
1608
1609=head3 cf::object
1610
1611=cut
1612
1613package cf::object;
999 1614
1000=over 4 1615=over 4
1001 1616
1002=item cf::player::exists $login 1617=item $ob->inv_recursive
1003 1618
1004Returns true when the given account exists. 1619Returns the inventory of the object _and_ their inventories, recursively.
1005 1620
1006=cut 1621=cut
1007 1622
1008sub cf::player::exists($) { 1623sub inv_recursive_;
1009 cf::player::find $_[0] 1624sub inv_recursive_ {
1010 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1625 map { $_, inv_recursive_ $_->inv } @_
1011} 1626}
1012 1627
1013=item $player->ext_reply ($msgid, $msgtype, %msg) 1628sub inv_recursive {
1014 1629 inv_recursive_ inv $_[0]
1015Sends an ext reply to the player.
1016
1017=cut
1018
1019sub cf::player::ext_reply($$$%) {
1020 my ($self, $id, %msg) = @_;
1021
1022 $msg{msgid} = $id;
1023
1024 $self->send ("ext " . to_json \%msg);
1025} 1630}
1631
1632package cf;
1026 1633
1027=back 1634=back
1028 1635
1029=head3 cf::object::player 1636=head3 cf::object::player
1030 1637
1068 (ref $cf::CFG{"may_$access"} 1675 (ref $cf::CFG{"may_$access"}
1069 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1676 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1070 : $cf::CFG{"may_$access"}) 1677 : $cf::CFG{"may_$access"})
1071} 1678}
1072 1679
1680=item $player_object->enter_link
1681
1682Freezes the player and moves him/her to a special map (C<{link}>).
1683
1684The player should be reasonably safe there for short amounts of time. You
1685I<MUST> call C<leave_link> as soon as possible, though.
1686
1687Will never block.
1688
1689=item $player_object->leave_link ($map, $x, $y)
1690
1691Moves the player out of the special C<{link}> map onto the specified
1692map. If the map is not valid (or omitted), the player will be moved back
1693to the location he/she was before the call to C<enter_link>, or, if that
1694fails, to the emergency map position.
1695
1696Might block.
1697
1698=cut
1699
1700sub link_map {
1701 unless ($LINK_MAP) {
1702 $LINK_MAP = cf::map::find "{link}"
1703 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1704 $LINK_MAP->load;
1705 }
1706
1707 $LINK_MAP
1708}
1709
1710sub cf::object::player::enter_link {
1711 my ($self) = @_;
1712
1713 $self->deactivate_recursive;
1714
1715 return if UNIVERSAL::isa $self->map, "ext::map_link";
1716
1717 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718 if $self->map;
1719
1720 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1721}
1722
1723sub cf::object::player::leave_link {
1724 my ($self, $map, $x, $y) = @_;
1725
1726 my $link_pos = delete $self->{_link_pos};
1727
1728 unless ($map) {
1729 # restore original map position
1730 ($map, $x, $y) = @{ $link_pos || [] };
1731 $map = cf::map::find $map;
1732
1733 unless ($map) {
1734 ($map, $x, $y) = @$EMERGENCY_POSITION;
1735 $map = cf::map::find $map
1736 or die "FATAL: cannot load emergency map\n";
1737 }
1738 }
1739
1740 ($x, $y) = (-1, -1)
1741 unless (defined $x) && (defined $y);
1742
1743 # use -1 or undef as default coordinates, not 0, 0
1744 ($x, $y) = ($map->enter_x, $map->enter_y)
1745 if $x <=0 && $y <= 0;
1746
1747 $map->load;
1748 $map->load_diag;
1749
1750 return unless $self->contr->active;
1751 $self->activate_recursive;
1752 $self->enter_map ($map, $x, $y);
1753}
1754
1755cf::player->attach (
1756 on_logout => sub {
1757 my ($pl) = @_;
1758
1759 # abort map switching before logout
1760 if ($pl->ob->{_link_pos}) {
1761 cf::sync_job {
1762 $pl->ob->leave_link
1763 };
1764 }
1765 },
1766 on_login => sub {
1767 my ($pl) = @_;
1768
1769 # try to abort aborted map switching on player login :)
1770 # should happen only on crashes
1771 if ($pl->ob->{_link_pos}) {
1772 $pl->ob->enter_link;
1773 (async {
1774 # we need this sleep as the login has a concurrent enter_exit running
1775 # and this sleep increases chances of the player not ending up in scorn
1776 $pl->ob->reply (undef,
1777 "There was an internal problem at your last logout, "
1778 . "the server will try to bring you to your intended destination in a second.",
1779 cf::NDI_RED);
1780 Coro::Timer::sleep 1;
1781 $pl->ob->leave_link;
1782 })->prio (2);
1783 }
1784 },
1785);
1786
1787=item $player_object->goto ($path, $x, $y)
1788
1789=cut
1790
1791sub cf::object::player::goto {
1792 my ($self, $path, $x, $y) = @_;
1793
1794 $self->enter_link;
1795
1796 (async {
1797 my $map = cf::map::find $path;
1798 $map = $map->customise_for ($self) if $map;
1799
1800# warn "entering ", $map->path, " at ($x, $y)\n"
1801# if $map;
1802
1803 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1804
1805 $self->leave_link ($map, $x, $y);
1806 })->prio (1);
1807}
1808
1809=item $player_object->enter_exit ($exit_object)
1810
1811=cut
1812
1813sub parse_random_map_params {
1814 my ($spec) = @_;
1815
1816 my $rmp = { # defaults
1817 xsize => (cf::rndm 15, 40),
1818 ysize => (cf::rndm 15, 40),
1819 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1820 #layout => string
1821 };
1822
1823 for (split /\n/, $spec) {
1824 my ($k, $v) = split /\s+/, $_, 2;
1825
1826 $rmp->{lc $k} = $v if (length $k) && (length $v);
1827 }
1828
1829 $rmp
1830}
1831
1832sub prepare_random_map {
1833 my ($exit) = @_;
1834
1835 my $guard = cf::lock_acquire "exit_prepare:$exit";
1836
1837 # all this does is basically replace the /! path by
1838 # a new random map path (?random/...) with a seed
1839 # that depends on the exit object
1840
1841 my $rmp = parse_random_map_params $exit->msg;
1842
1843 if ($exit->map) {
1844 $rmp->{region} = $exit->map->region_name;
1845 $rmp->{origin_map} = $exit->map->path;
1846 $rmp->{origin_x} = $exit->x;
1847 $rmp->{origin_y} = $exit->y;
1848 }
1849
1850 $rmp->{random_seed} ||= $exit->random_seed;
1851
1852 my $data = cf::to_json $rmp;
1853 my $md5 = Digest::MD5::md5_hex $data;
1854 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1855
1856 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1857 aio_write $fh, 0, (length $data), $data, 0;
1858 undef $fh;
1859 aio_rename "$meta~", $meta;
1860
1861 $exit->slaying ("?random/$md5");
1862 $exit->msg (undef);
1863 }
1864}
1865
1866sub cf::object::player::enter_exit {
1867 my ($self, $exit) = @_;
1868
1869 return unless $self->type == cf::PLAYER;
1870
1871 $self->enter_link;
1872
1873 (async {
1874 $self->deactivate_recursive; # just to be sure
1875 unless (eval {
1876 prepare_random_map $exit
1877 if $exit->slaying eq "/!";
1878
1879 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1880 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1881
1882 1;
1883 }) {
1884 $self->message ("Something went wrong deep within the crossfire server. "
1885 . "I'll try to bring you back to the map you were before. "
1886 . "Please report this to the dungeon master!",
1887 cf::NDI_UNIQUE | cf::NDI_RED);
1888
1889 warn "ERROR in enter_exit: $@";
1890 $self->leave_link;
1891 }
1892 })->prio (1);
1893}
1894
1073=head3 cf::client 1895=head3 cf::client
1074 1896
1075=over 4 1897=over 4
1076 1898
1077=item $client->send_drawinfo ($text, $flags) 1899=item $client->send_drawinfo ($text, $flags)
1120 on_reply => sub { 1942 on_reply => sub {
1121 my ($ns, $msg) = @_; 1943 my ($ns, $msg) = @_;
1122 1944
1123 # this weird shuffling is so that direct followup queries 1945 # this weird shuffling is so that direct followup queries
1124 # get handled first 1946 # get handled first
1125 my $queue = delete $ns->{query_queue}; 1947 my $queue = delete $ns->{query_queue}
1948 or return; # be conservative, not sure how that can happen, but we saw a crash here
1126 1949
1127 (shift @$queue)->[1]->($msg); 1950 (shift @$queue)->[1]->($msg);
1128 1951
1129 push @{ $ns->{query_queue} }, @$queue; 1952 push @{ $ns->{query_queue} }, @$queue;
1130 1953
1136 } 1959 }
1137 } 1960 }
1138 }, 1961 },
1139); 1962);
1140 1963
1141=item $client->coro (\&cb) 1964=item $client->async (\&cb)
1142 1965
1143Create a new coroutine, running the specified callback. The coroutine will 1966Create a new coroutine, running the specified callback. The coroutine will
1144be automatically cancelled when the client gets destroyed (e.g. on logout, 1967be automatically cancelled when the client gets destroyed (e.g. on logout,
1145or loss of connection). 1968or loss of connection).
1146 1969
1147=cut 1970=cut
1148 1971
1149sub cf::client::coro { 1972sub cf::client::async {
1150 my ($self, $cb) = @_; 1973 my ($self, $cb) = @_;
1151 1974
1152 my $coro; $coro = async { 1975 my $coro = &Coro::async ($cb);
1153 eval {
1154 $cb->();
1155 };
1156 warn $@ if $@;
1157 };
1158 1976
1159 $coro->on_destroy (sub { 1977 $coro->on_destroy (sub {
1160 delete $self->{_coro}{$coro+0}; 1978 delete $self->{_coro}{$coro+0};
1161 }); 1979 });
1162 1980
1334 2152
1335{ 2153{
1336 my $path = cf::localdir . "/database.pst"; 2154 my $path = cf::localdir . "/database.pst";
1337 2155
1338 sub db_load() { 2156 sub db_load() {
1339 warn "loading database $path\n";#d# remove later
1340 $DB = stat $path ? Storable::retrieve $path : { }; 2157 $DB = stat $path ? Storable::retrieve $path : { };
1341 } 2158 }
1342 2159
1343 my $pid; 2160 my $pid;
1344 2161
1345 sub db_save() { 2162 sub db_save() {
1346 warn "saving database $path\n";#d# remove later
1347 waitpid $pid, 0 if $pid; 2163 waitpid $pid, 0 if $pid;
1348 if (0 == ($pid = fork)) { 2164 if (0 == ($pid = fork)) {
1349 $DB->{_meta}{version} = 1; 2165 $DB->{_meta}{version} = 1;
1350 Storable::nstore $DB, "$path~"; 2166 Storable::nstore $DB, "$path~";
1351 rename "$path~", $path; 2167 rename "$path~", $path;
1399 open my $fh, "<:utf8", cf::confdir . "/config" 2215 open my $fh, "<:utf8", cf::confdir . "/config"
1400 or return; 2216 or return;
1401 2217
1402 local $/; 2218 local $/;
1403 *CFG = YAML::Syck::Load <$fh>; 2219 *CFG = YAML::Syck::Load <$fh>;
2220
2221 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2222
2223 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2224 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2225
2226 if (exists $CFG{mlockall}) {
2227 eval {
2228 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2229 and die "WARNING: m(un)lockall failed: $!\n";
2230 };
2231 warn $@ if $@;
2232 }
1404} 2233}
1405 2234
1406sub main { 2235sub main {
1407 # we must not ever block the main coroutine 2236 # we must not ever block the main coroutine
1408 local $Coro::idle = sub { 2237 local $Coro::idle = sub {
1409 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2238 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1410 (Coro::unblock_sub { 2239 (async {
1411 Event::one_event; 2240 Event::one_event;
1412 })->(); 2241 })->prio (Coro::PRIO_MAX);
1413 }; 2242 };
1414 2243
1415 cfg_load; 2244 cfg_load;
1416 db_load; 2245 db_load;
1417 load_extensions; 2246 load_extensions;
1418 Event::loop; 2247 Event::loop;
1419} 2248}
1420 2249
1421############################################################################# 2250#############################################################################
1422# initialisation 2251# initialisation and cleanup
1423 2252
2253# install some emergency cleanup handlers
2254BEGIN {
2255 for my $signal (qw(INT HUP TERM)) {
2256 Event->signal (
2257 data => WF_AUTOCANCEL,
2258 signal => $signal,
2259 cb => sub {
2260 cf::cleanup "SIG$signal";
2261 },
2262 );
2263 }
2264}
2265
2266sub emergency_save() {
2267 my $freeze_guard = cf::freeze_mainloop;
2268
2269 warn "enter emergency perl save\n";
2270
2271 cf::sync_job {
2272 # use a peculiar iteration method to avoid tripping on perl
2273 # refcount bugs in for. also avoids problems with players
2274 # and maps saved/destroyed asynchronously.
2275 warn "begin emergency player save\n";
2276 for my $login (keys %cf::PLAYER) {
2277 my $pl = $cf::PLAYER{$login} or next;
2278 $pl->valid or next;
2279 $pl->save;
2280 }
2281 warn "end emergency player save\n";
2282
2283 warn "begin emergency map save\n";
2284 for my $path (keys %cf::MAP) {
2285 my $map = $cf::MAP{$path} or next;
2286 $map->valid or next;
2287 $map->save;
2288 }
2289 warn "end emergency map save\n";
2290 };
2291
2292 warn "leave emergency perl save\n";
2293}
2294
1424sub perl_reload() { 2295sub reload() {
1425 # can/must only be called in main 2296 # can/must only be called in main
1426 if ($Coro::current != $Coro::main) { 2297 if ($Coro::current != $Coro::main) {
1427 warn "can only reload from main coroutine\n"; 2298 warn "can only reload from main coroutine\n";
1428 return; 2299 return;
1429 } 2300 }
1430 2301
1431 warn "reloading..."; 2302 warn "reloading...";
1432 2303
1433 local $FREEZE = 1; 2304 warn "freezing server";
2305 my $guard = freeze_mainloop;
1434 cf::emergency_save; 2306 cf::emergency_save;
2307
2308 warn "sync database to disk";
2309 cf::db_sync;
2310 IO::AIO::flush;
1435 2311
1436 eval { 2312 eval {
1437 # if anything goes wrong in here, we should simply crash as we already saved 2313 # if anything goes wrong in here, we should simply crash as we already saved
1438 2314
1439 # cancel all watchers 2315 warn "cancel all watchers";
1440 for (Event::all_watchers) { 2316 for (Event::all_watchers) {
1441 $_->cancel if $_->data & WF_AUTOCANCEL; 2317 $_->cancel if $_->data & WF_AUTOCANCEL;
1442 } 2318 }
1443 2319
1444 # cancel all extension coros 2320 warn "cancel all extension coros";
1445 $_->cancel for values %EXT_CORO; 2321 $_->cancel for values %EXT_CORO;
1446 %EXT_CORO = (); 2322 %EXT_CORO = ();
1447 2323
2324 warn "remove commands";
2325 %COMMAND = ();
2326
2327 warn "remove ext commands";
2328 %EXTCMD = ();
2329
1448 # unload all extensions 2330 warn "unload/nuke all extensions";
1449 for (@exts) { 2331 for my $pkg (@EXTS) {
1450 warn "unloading <$_>"; 2332 warn "... unloading $pkg";
1451 unload_extension $_; 2333
2334 if (my $cb = $pkg->can ("unload")) {
2335 eval {
2336 $cb->($pkg);
2337 1
2338 } or warn "$pkg unloaded, but with errors: $@";
1452 } 2339 }
1453 2340
2341 warn "... nuking $pkg";
2342 Symbol::delete_package $pkg;
2343 }
2344
1454 # unload all modules loaded from $LIBDIR 2345 warn "unload all perl modules loaded from $LIBDIR";
1455 while (my ($k, $v) = each %INC) { 2346 while (my ($k, $v) = each %INC) {
1456 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2347 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1457 2348
1458 warn "removing <$k>"; 2349 warn "removing <$k>";
1459 delete $INC{$k}; 2350 delete $INC{$k};
1466 } 2357 }
1467 2358
1468 Symbol::delete_package $k; 2359 Symbol::delete_package $k;
1469 } 2360 }
1470 2361
1471 # sync database to disk
1472 cf::db_sync;
1473 IO::AIO::flush;
1474
1475 # get rid of safe::, as good as possible 2362 warn "get rid of safe::, as good as possible";
1476 Symbol::delete_package "safe::$_" 2363 Symbol::delete_package "safe::$_"
1477 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2364 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1478 2365
1479 # remove register_script_function callbacks
1480 # TODO
1481
1482 # unload cf.pm "a bit" 2366 warn "unload cf.pm \"a bit\"";
1483 delete $INC{"cf.pm"}; 2367 delete $INC{"cf.pm"};
1484 2368
1485 # don't, removes xs symbols, too, 2369 # don't, removes xs symbols, too,
1486 # and global variables created in xs 2370 # and global variables created in xs
1487 #Symbol::delete_package __PACKAGE__; 2371 #Symbol::delete_package __PACKAGE__;
1488 2372
1489 # reload cf.pm
1490 warn "reloading cf.pm"; 2373 warn "reloading cf.pm";
1491 require cf; 2374 require cf;
1492 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2375 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1493 2376
1494 # load config and database again 2377 warn "load config and database again";
1495 cf::cfg_load; 2378 cf::cfg_load;
1496 cf::db_load; 2379 cf::db_load;
1497 2380
1498 # load extensions
1499 warn "load extensions"; 2381 warn "load extensions";
1500 cf::load_extensions; 2382 cf::load_extensions;
1501 2383
1502 # reattach attachments to objects 2384 warn "reattach attachments to objects/players";
1503 warn "reattach";
1504 _global_reattach; 2385 _global_reattach;
2386 warn "reattach attachments to maps";
2387 reattach $_ for values %MAP;
1505 }; 2388 };
1506 2389
1507 if ($@) { 2390 if ($@) {
1508 warn $@; 2391 warn $@;
1509 warn "error while reloading, exiting."; 2392 warn "error while reloading, exiting.";
1510 exit 1; 2393 exit 1;
1511 } 2394 }
1512 2395
1513 warn "reloaded successfully"; 2396 warn "reloaded";
1514}; 2397};
1515 2398
1516############################################################################# 2399our $RELOAD_WATCHER; # used only during reload
1517 2400
1518unless ($LINK_MAP) {
1519 $LINK_MAP = cf::map::new;
1520
1521 $LINK_MAP->width (41);
1522 $LINK_MAP->height (41);
1523 $LINK_MAP->alloc;
1524 $LINK_MAP->path ("{link}");
1525 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1526 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1527}
1528
1529register "<global>", __PACKAGE__;
1530
1531register_command "perl-reload" => sub { 2401register_command "reload" => sub {
1532 my ($who, $arg) = @_; 2402 my ($who, $arg) = @_;
1533 2403
1534 if ($who->flag (FLAG_WIZ)) { 2404 if ($who->flag (FLAG_WIZ)) {
1535 $who->message ("start of reload.");
1536 perl_reload;
1537 $who->message ("end of reload."); 2405 $who->message ("reloading server.");
2406
2407 # doing reload synchronously and two reloads happen back-to-back,
2408 # coro crashes during coro_state_free->destroy here.
2409
2410 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2411 reload;
2412 undef $RELOAD_WATCHER;
2413 });
1538 } 2414 }
1539}; 2415};
1540 2416
1541unshift @INC, $LIBDIR; 2417unshift @INC, $LIBDIR;
1542 2418
1544 reentrant => 0, 2420 reentrant => 0,
1545 prio => 0, 2421 prio => 0,
1546 at => $NEXT_TICK || $TICK, 2422 at => $NEXT_TICK || $TICK,
1547 data => WF_AUTOCANCEL, 2423 data => WF_AUTOCANCEL,
1548 cb => sub { 2424 cb => sub {
1549 unless ($FREEZE) { 2425 $NOW = Event::time;
2426
1550 cf::server_tick; # one server iteration 2427 cf::server_tick; # one server iteration
1551 $RUNTIME += $TICK; 2428 $RUNTIME += $TICK;
1552 }
1553
1554 $NEXT_TICK += $TICK; 2429 $NEXT_TICK += $TICK;
2430
2431 $WAIT_FOR_TICK->broadcast;
2432 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1555 2433
1556 # if we are delayed by four ticks or more, skip them all 2434 # if we are delayed by four ticks or more, skip them all
1557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2435 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1558 2436
1559 $TICK_WATCHER->at ($NEXT_TICK); 2437 $TICK_WATCHER->at ($NEXT_TICK);
1561 }, 2439 },
1562); 2440);
1563 2441
1564IO::AIO::max_poll_time $TICK * 0.2; 2442IO::AIO::max_poll_time $TICK * 0.2;
1565 2443
1566Event->io ( 2444$AIO_POLL_WATCHER = Event->io (
1567 fd => IO::AIO::poll_fileno, 2445 fd => IO::AIO::poll_fileno,
1568 poll => 'r', 2446 poll => 'r',
1569 prio => 5, 2447 prio => 5,
1570 data => WF_AUTOCANCEL, 2448 data => WF_AUTOCANCEL,
1571 cb => \&IO::AIO::poll_cb, 2449 cb => \&IO::AIO::poll_cb,
1572); 2450);
1573 2451
1574Event->timer ( 2452$WRITE_RUNTIME_WATCHER = Event->timer (
1575 data => WF_AUTOCANCEL, 2453 data => WF_AUTOCANCEL,
1576 after => 0, 2454 after => 0,
1577 interval => 10, 2455 interval => 10,
1578 cb => sub { 2456 cb => sub {
1579 (Coro::unblock_sub { 2457 (Coro::unblock_sub {
1581 or warn "ERROR: unable to write runtime file: $!"; 2459 or warn "ERROR: unable to write runtime file: $!";
1582 })->(); 2460 })->();
1583 }, 2461 },
1584); 2462);
1585 2463
2464END { cf::emergency_save }
2465
15861 24661
1587 2467

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines