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.194 by root, Wed Jan 24 22:42:49 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 $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 376
379############################################################################# 377#############################################################################
380 378
381=head2 ATTACHABLE OBJECTS 379=head2 ATTACHABLE OBJECTS
382 380
508our @CB_TYPE = (); # registry for type (cf-object class) based events 506our @CB_TYPE = (); # registry for type (cf-object class) based events
509our @CB_MAP = (); 507our @CB_MAP = ();
510 508
511my %attachment; 509my %attachment;
512 510
511sub cf::attachable::thawer_merge {
512 # simply override everything except _meta
513 local $_[0]{_meta};
514 %{$_[0]} = %{$_[1]};
515}
516
513sub _attach_cb($$$$) { 517sub _attach_cb($$$$) {
514 my ($registry, $event, $prio, $cb) = @_; 518 my ($registry, $event, $prio, $cb) = @_;
515 519
516 use sort 'stable'; 520 use sort 'stable';
517 521
688# object support 692# object support
689 693
690sub reattach { 694sub reattach {
691 # basically do the same as instantiate, without calling instantiate 695 # basically do the same as instantiate, without calling instantiate
692 my ($obj) = @_; 696 my ($obj) = @_;
697
698 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
693 699
694 my $registry = $obj->registry; 700 my $registry = $obj->registry;
695 701
696 @$registry = (); 702 @$registry = ();
697 703
790 or return; 796 or return;
791 797
792 unless (aio_stat "$filename.pst") { 798 unless (aio_stat "$filename.pst") {
793 (aio_load "$filename.pst", $av) >= 0 799 (aio_load "$filename.pst", $av) >= 0
794 or return; 800 or return;
795 $av = eval { (Storable::thaw <$av>)->{objs} }; 801 $av = eval { (Storable::thaw $av)->{objs} };
796 } 802 }
797 803
804 warn sprintf "loading %s (%d)\n",
805 $filename, length $data, scalar @{$av || []};#d#
798 return ($data, $av); 806 return ($data, $av);
799} 807}
800 808
801############################################################################# 809#############################################################################
802# command handling &c 810# command handling &c
827=cut 835=cut
828 836
829sub register_extcmd { 837sub register_extcmd {
830 my ($name, $cb) = @_; 838 my ($name, $cb) = @_;
831 839
832 my $caller = caller;
833 #warn "registering extcmd '$name' to '$caller'";
834
835 $EXTCMD{$name} = [$cb, $caller]; 840 $EXTCMD{$name} = $cb;
836} 841}
837 842
838cf::player->attach ( 843cf::player->attach (
839 on_command => sub { 844 on_command => sub {
840 my ($pl, $name, $params) = @_; 845 my ($pl, $name, $params) = @_;
853 858
854 my $msg = eval { from_json $buf }; 859 my $msg = eval { from_json $buf };
855 860
856 if (ref $msg) { 861 if (ref $msg) {
857 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 862 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
858 if (my %reply = $cb->[0]->($pl, $msg)) { 863 if (my %reply = $cb->($pl, $msg)) {
859 $pl->ext_reply ($msg->{msgid}, %reply); 864 $pl->ext_reply ($msg->{msgid}, %reply);
860 } 865 }
861 } 866 }
862 } else { 867 } else {
863 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
865 870
866 cf::override; 871 cf::override;
867 }, 872 },
868); 873);
869 874
870sub register {
871 my ($base, $pkg) = @_;
872
873 #TODO
874}
875
876sub load_extension { 875sub load_extension {
877 my ($path) = @_; 876 my ($path) = @_;
878 877
879 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
880 my $base = $1; 879 my $base = $1;
881 my $pkg = $1; 880 my $pkg = $1;
882 $pkg =~ s/[^[:word:]]/_/g; 881 $pkg =~ s/[^[:word:]]/_/g;
883 $pkg = "ext::$pkg"; 882 $pkg = "ext::$pkg";
884 883
885 warn "loading '$path' into '$pkg'\n"; 884 warn "... loading '$path' into '$pkg'\n";
886 885
887 open my $fh, "<:utf8", $path 886 open my $fh, "<:utf8", $path
888 or die "$path: $!"; 887 or die "$path: $!";
889 888
890 my $source = 889 my $source =
891 "package $pkg; use strict; use utf8;\n" 890 "package $pkg; use strict; use utf8;\n"
892 . "#line 1 \"$path\"\n{\n" 891 . "#line 1 \"$path\"\n{\n"
893 . (do { local $/; <$fh> }) 892 . (do { local $/; <$fh> })
894 . "\n};\n1"; 893 . "\n};\n1";
895 894
896 eval $source 895 unless (eval $source) {
897 or die $@ ? "$path: $@\n" 896 my $msg = $@ ? "$path: $@\n"
898 : "extension disabled.\n"; 897 : "extension disabled.\n";
899 898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
900 push @exts, $pkg; 899 warn $@;
901 $ext_pkg{$base} = $pkg; 900 warn "mandatory extension failed to load, exiting.\n";
902 901 exit 1;
903# no strict 'refs'; 902 }
904# @{"$pkg\::ISA"} = ext::; 903 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# } 904 }
919 905
920 # remove commands 906 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} 907}
945 908
946sub load_extensions { 909sub load_extensions {
947 for my $ext (<$LIBDIR/*.ext>) { 910 for my $ext (<$LIBDIR/*.ext>) {
948 next unless -r $ext; 911 next unless -r $ext;
952 } or warn "$ext not loaded: $@"; 915 } or warn "$ext not loaded: $@";
953 } 916 }
954} 917}
955 918
956############################################################################# 919#############################################################################
957# load/save/clean perl data associated with a map
958 920
959*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) {
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 my $path = $self->{path};
1386 my $guard = cf::lock_acquire "map_load:$path";
1387
1388 return if $self->in_memory != cf::MAP_SWAPPED;
1389
1390 $self->in_memory (cf::MAP_LOADING);
1391
1392 $self->alloc;
1393
1394 $self->pre_load;
1395
1396 $self->_load_objects ($self->{load_path}, 1)
1397 or return;
1398
1399 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1400 if delete $self->{load_original};
1401
1402 if (my $uniq = $self->uniq_path) {
1403 utf8::encode $uniq;
1404 if (aio_open $uniq, O_RDONLY, 0) {
1405 $self->clear_unique_items;
1406 $self->_load_objects ($uniq, 0);
1407 }
1408 }
1409
1410 Coro::cede;
1411
1412 # now do the right thing for maps
1413 $self->link_multipart_objects;
1414
1415 unless ($self->{deny_activate}) {
1416 $self->decay_objects;
1417 $self->fix_auto_apply;
1418 $self->update_buttons;
1419 Coro::cede;
1420 $self->set_darkness_map;
1421 $self->difficulty ($self->estimate_difficulty)
1422 unless $self->difficulty;
1423 Coro::cede;
1424 $self->activate;
1425 }
1426
1427 $self->post_load;
1428
1429 $self->in_memory (cf::MAP_IN_MEMORY);
1430}
1431
1432sub customise_for {
1433 my ($self, $ob) = @_;
1434
1435 return find "~" . $ob->name . "/" . $self->{path}
1436 if $self->per_player;
1437
1438 $self
1439}
1440
1441# find and load all maps in the 3x3 area around a map
1442sub load_diag {
960 my ($map) = @_; 1443 my ($map) = @_;
961 1444
962 my $path = $map->tmpname; 1445 my @diag; # diagonal neighbours
963 defined $path or return;
964 1446
965 unlink "$path.pst"; 1447 for (0 .. 3) {
966}; 1448 my $neigh = $map->tile_path ($_)
1449 or next;
1450 $neigh = find $neigh, $map
1451 or next;
1452 $neigh->load;
967 1453
968cf::map->attach (prio => -10000, package => cf::mapsupport::); 1454 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1455 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1456 }
969 1457
970############################################################################# 1458 for (@diag) {
971# load/save perl data associated with player->ob objects 1459 my $neigh = find @$_
972 1460 or next;
973sub all_objects(@) { 1461 $neigh->load;
974 @_, map all_objects ($_->inv), @_ 1462 }
975} 1463}
976 1464
977# TODO: compatibility cruft, remove when no longer needed 1465sub find_sync {
978cf::player->attach ( 1466 my ($path, $origin) = @_;
979 on_load => sub {
980 my ($pl, $path) = @_;
981 1467
982 for my $o (all_objects $pl->ob) { 1468 cf::sync_job { find $path, $origin }
983 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1469}
984 $o->set_ob_key_value ("_perl_data");
985 1470
986 %$o = %{ Storable::thaw pack "H*", $value }; 1471sub do_load_sync {
1472 my ($map) = @_;
1473
1474 cf::sync_job { $map->load };
1475}
1476
1477our %MAP_PREFETCH;
1478our $MAP_PREFETCHER = undef;
1479
1480sub find_async {
1481 my ($path, $origin) = @_;
1482
1483 $path = normalise $path, $origin && $origin->{path};
1484
1485 if (my $map = $cf::MAP{$path}) {
1486 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1487 }
1488
1489 undef $MAP_PREFETCH{$path};
1490 $MAP_PREFETCHER ||= cf::async {
1491 while (%MAP_PREFETCH) {
1492 for my $path (keys %MAP_PREFETCH) {
1493 my $map = find $path
1494 or next;
1495 $map->load;
1496
1497 delete $MAP_PREFETCH{$path};
987 } 1498 }
988 } 1499 }
1500 undef $MAP_PREFETCHER;
1501 };
1502 $MAP_PREFETCHER->prio (6);
1503
1504 ()
1505}
1506
1507sub save {
1508 my ($self) = @_;
1509
1510 my $lock = cf::lock_acquire "map_data:" . $self->path;
1511
1512 $self->{last_save} = $cf::RUNTIME;
1513
1514 return unless $self->dirty;
1515
1516 my $save = $self->save_path; utf8::encode $save;
1517 my $uniq = $self->uniq_path; utf8::encode $uniq;
1518
1519 $self->{load_path} = $save;
1520
1521 return if $self->{deny_save};
1522
1523 local $self->{last_access} = $self->last_access;#d#
1524
1525 cf::async {
1526 $_->contr->save for $self->players;
1527 };
1528
1529 if ($uniq) {
1530 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1531 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1532 } else {
1533 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
989 }, 1534 }
990); 1535}
991 1536
992############################################################################# 1537sub swap_out {
1538 my ($self) = @_;
993 1539
994=head2 CORE EXTENSIONS 1540 # save first because save cedes
1541 $self->save;
995 1542
996Functions and methods that extend core crossfire objects. 1543 my $lock = cf::lock_acquire "map_data:" . $self->path;
997 1544
998=head3 cf::player 1545 return if $self->players;
1546 return if $self->in_memory != cf::MAP_IN_MEMORY;
1547 return if $self->{deny_save};
1548
1549 $self->clear;
1550 $self->in_memory (cf::MAP_SWAPPED);
1551}
1552
1553sub reset_at {
1554 my ($self) = @_;
1555
1556 # TODO: safety, remove and allow resettable per-player maps
1557 return 1e99 if $self->isa ("ext::map_per_player");#d#
1558 return 1e99 if $self->{deny_reset};
1559
1560 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1562
1563 $time + $to
1564}
1565
1566sub should_reset {
1567 my ($self) = @_;
1568
1569 $self->reset_at <= $cf::RUNTIME
1570}
1571
1572sub reset {
1573 my ($self) = @_;
1574
1575 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576
1577 return if $self->players;
1578 return if $self->isa ("ext::map_per_player");#d#
1579
1580 warn "resetting map ", $self->path;#d#
1581
1582 delete $cf::MAP{$self->path};
1583
1584 $self->in_memory (cf::MAP_SWAPPED);
1585 $self->clear;
1586
1587 $_->clear_links_to ($self) for values %cf::MAP;
1588
1589 $self->unlink_save;
1590 $self->destroy;
1591}
1592
1593my $nuke_counter = "aaaa";
1594
1595sub nuke {
1596 my ($self) = @_;
1597
1598 delete $cf::MAP{$self->path};
1599
1600 $self->unlink_save;
1601
1602 bless $self, "cf::map";
1603 delete $self->{deny_reset};
1604 $self->{deny_save} = 1;
1605 $self->reset_timeout (1);
1606 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1607
1608 $cf::MAP{$self->path} = $self;
1609
1610 $self->reset; # polite request, might not happen
1611}
1612
1613=item cf::map::unique_maps
1614
1615Returns an arrayref of paths of all shared maps that have
1616instantiated unique items. May block.
1617
1618=cut
1619
1620sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1622 or return;
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_;
1628 next if /\.pst$/;
1629 next unless /^$PATH_SEP/o;
1630
1631 s/\.map$//;
1632 push @paths, $_;
1633 }
1634
1635 \@paths
1636}
1637
1638package cf;
1639
1640=back
1641
1642=head3 cf::object
1643
1644=cut
1645
1646package cf::object;
999 1647
1000=over 4 1648=over 4
1001 1649
1002=item cf::player::exists $login 1650=item $ob->inv_recursive
1003 1651
1004Returns true when the given account exists. 1652Returns the inventory of the object _and_ their inventories, recursively.
1005 1653
1006=cut 1654=cut
1007 1655
1008sub cf::player::exists($) { 1656sub inv_recursive_;
1009 cf::player::find $_[0] 1657sub inv_recursive_ {
1010 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1658 map { $_, inv_recursive_ $_->inv } @_
1011} 1659}
1012 1660
1013=item $player->ext_reply ($msgid, $msgtype, %msg) 1661sub inv_recursive {
1014 1662 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} 1663}
1664
1665package cf;
1026 1666
1027=back 1667=back
1028 1668
1029=head3 cf::object::player 1669=head3 cf::object::player
1030 1670
1068 (ref $cf::CFG{"may_$access"} 1708 (ref $cf::CFG{"may_$access"}
1069 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1709 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1070 : $cf::CFG{"may_$access"}) 1710 : $cf::CFG{"may_$access"})
1071} 1711}
1072 1712
1713=item $player_object->enter_link
1714
1715Freezes the player and moves him/her to a special map (C<{link}>).
1716
1717The player should be reasonably safe there for short amounts of time. You
1718I<MUST> call C<leave_link> as soon as possible, though.
1719
1720Will never block.
1721
1722=item $player_object->leave_link ($map, $x, $y)
1723
1724Moves the player out of the special C<{link}> map onto the specified
1725map. If the map is not valid (or omitted), the player will be moved back
1726to the location he/she was before the call to C<enter_link>, or, if that
1727fails, to the emergency map position.
1728
1729Might block.
1730
1731=cut
1732
1733sub link_map {
1734 unless ($LINK_MAP) {
1735 $LINK_MAP = cf::map::find "{link}"
1736 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1737 $LINK_MAP->load;
1738 }
1739
1740 $LINK_MAP
1741}
1742
1743sub cf::object::player::enter_link {
1744 my ($self) = @_;
1745
1746 $self->deactivate_recursive;
1747
1748 return if UNIVERSAL::isa $self->map, "ext::map_link";
1749
1750 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751 if $self->map;
1752
1753 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1754}
1755
1756sub cf::object::player::leave_link {
1757 my ($self, $map, $x, $y) = @_;
1758
1759 my $link_pos = delete $self->{_link_pos};
1760
1761 unless ($map) {
1762 # restore original map position
1763 ($map, $x, $y) = @{ $link_pos || [] };
1764 $map = cf::map::find $map;
1765
1766 unless ($map) {
1767 ($map, $x, $y) = @$EMERGENCY_POSITION;
1768 $map = cf::map::find $map
1769 or die "FATAL: cannot load emergency map\n";
1770 }
1771 }
1772
1773 ($x, $y) = (-1, -1)
1774 unless (defined $x) && (defined $y);
1775
1776 # use -1 or undef as default coordinates, not 0, 0
1777 ($x, $y) = ($map->enter_x, $map->enter_y)
1778 if $x <=0 && $y <= 0;
1779
1780 $map->load;
1781 $map->load_diag;
1782
1783 return unless $self->contr->active;
1784 $self->activate_recursive;
1785 $self->enter_map ($map, $x, $y);
1786}
1787
1788cf::player->attach (
1789 on_logout => sub {
1790 my ($pl) = @_;
1791
1792 # abort map switching before logout
1793 if ($pl->ob->{_link_pos}) {
1794 cf::sync_job {
1795 $pl->ob->leave_link
1796 };
1797 }
1798 },
1799 on_login => sub {
1800 my ($pl) = @_;
1801
1802 # try to abort aborted map switching on player login :)
1803 # should happen only on crashes
1804 if ($pl->ob->{_link_pos}) {
1805 $pl->ob->enter_link;
1806 (async {
1807 # we need this sleep as the login has a concurrent enter_exit running
1808 # and this sleep increases chances of the player not ending up in scorn
1809 $pl->ob->reply (undef,
1810 "There was an internal problem at your last logout, "
1811 . "the server will try to bring you to your intended destination in a second.",
1812 cf::NDI_RED);
1813 Coro::Timer::sleep 1;
1814 $pl->ob->leave_link;
1815 })->prio (2);
1816 }
1817 },
1818);
1819
1820=item $player_object->goto ($path, $x, $y)
1821
1822=cut
1823
1824sub cf::object::player::goto {
1825 my ($self, $path, $x, $y) = @_;
1826
1827 $self->enter_link;
1828
1829 (async {
1830 my $map = cf::map::find $path;
1831 $map = $map->customise_for ($self) if $map;
1832
1833# warn "entering ", $map->path, " at ($x, $y)\n"
1834# if $map;
1835
1836 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1837
1838 $self->leave_link ($map, $x, $y);
1839 })->prio (1);
1840}
1841
1842=item $player_object->enter_exit ($exit_object)
1843
1844=cut
1845
1846sub parse_random_map_params {
1847 my ($spec) = @_;
1848
1849 my $rmp = { # defaults
1850 xsize => (cf::rndm 15, 40),
1851 ysize => (cf::rndm 15, 40),
1852 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1853 #layout => string,
1854 };
1855
1856 for (split /\n/, $spec) {
1857 my ($k, $v) = split /\s+/, $_, 2;
1858
1859 $rmp->{lc $k} = $v if (length $k) && (length $v);
1860 }
1861
1862 $rmp
1863}
1864
1865sub prepare_random_map {
1866 my ($exit) = @_;
1867
1868 my $guard = cf::lock_acquire "exit_prepare:$exit";
1869
1870 # all this does is basically replace the /! path by
1871 # a new random map path (?random/...) with a seed
1872 # that depends on the exit object
1873
1874 my $rmp = parse_random_map_params $exit->msg;
1875
1876 if ($exit->map) {
1877 $rmp->{region} = $exit->map->region_name;
1878 $rmp->{origin_map} = $exit->map->path;
1879 $rmp->{origin_x} = $exit->x;
1880 $rmp->{origin_y} = $exit->y;
1881 }
1882
1883 $rmp->{random_seed} ||= $exit->random_seed;
1884
1885 my $data = cf::to_json $rmp;
1886 my $md5 = Digest::MD5::md5_hex $data;
1887 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1888
1889 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890 aio_write $fh, 0, (length $data), $data, 0;
1891 undef $fh;
1892 aio_rename "$meta~", $meta;
1893
1894 $exit->slaying ("?random/$md5");
1895 $exit->msg (undef);
1896 }
1897}
1898
1899sub cf::object::player::enter_exit {
1900 my ($self, $exit) = @_;
1901
1902 return unless $self->type == cf::PLAYER;
1903
1904 $self->enter_link;
1905
1906 (async {
1907 $self->deactivate_recursive; # just to be sure
1908 unless (eval {
1909 prepare_random_map $exit
1910 if $exit->slaying eq "/!";
1911
1912 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1913 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1914
1915 1;
1916 }) {
1917 $self->message ("Something went wrong deep within the crossfire server. "
1918 . "I'll try to bring you back to the map you were before. "
1919 . "Please report this to the dungeon master!",
1920 cf::NDI_UNIQUE | cf::NDI_RED);
1921
1922 warn "ERROR in enter_exit: $@";
1923 $self->leave_link;
1924 }
1925 })->prio (1);
1926}
1927
1073=head3 cf::client 1928=head3 cf::client
1074 1929
1075=over 4 1930=over 4
1076 1931
1077=item $client->send_drawinfo ($text, $flags) 1932=item $client->send_drawinfo ($text, $flags)
1120 on_reply => sub { 1975 on_reply => sub {
1121 my ($ns, $msg) = @_; 1976 my ($ns, $msg) = @_;
1122 1977
1123 # this weird shuffling is so that direct followup queries 1978 # this weird shuffling is so that direct followup queries
1124 # get handled first 1979 # get handled first
1125 my $queue = delete $ns->{query_queue}; 1980 my $queue = delete $ns->{query_queue}
1981 or return; # be conservative, not sure how that can happen, but we saw a crash here
1126 1982
1127 (shift @$queue)->[1]->($msg); 1983 (shift @$queue)->[1]->($msg);
1128 1984
1129 push @{ $ns->{query_queue} }, @$queue; 1985 push @{ $ns->{query_queue} }, @$queue;
1130 1986
1136 } 1992 }
1137 } 1993 }
1138 }, 1994 },
1139); 1995);
1140 1996
1141=item $client->coro (\&cb) 1997=item $client->async (\&cb)
1142 1998
1143Create a new coroutine, running the specified callback. The coroutine will 1999Create a new coroutine, running the specified callback. The coroutine will
1144be automatically cancelled when the client gets destroyed (e.g. on logout, 2000be automatically cancelled when the client gets destroyed (e.g. on logout,
1145or loss of connection). 2001or loss of connection).
1146 2002
1147=cut 2003=cut
1148 2004
1149sub cf::client::coro { 2005sub cf::client::async {
1150 my ($self, $cb) = @_; 2006 my ($self, $cb) = @_;
1151 2007
1152 my $coro; $coro = async { 2008 my $coro = &Coro::async ($cb);
1153 eval {
1154 $cb->();
1155 };
1156 warn $@ if $@;
1157 };
1158 2009
1159 $coro->on_destroy (sub { 2010 $coro->on_destroy (sub {
1160 delete $self->{_coro}{$coro+0}; 2011 delete $self->{_coro}{$coro+0};
1161 }); 2012 });
1162 2013
1334 2185
1335{ 2186{
1336 my $path = cf::localdir . "/database.pst"; 2187 my $path = cf::localdir . "/database.pst";
1337 2188
1338 sub db_load() { 2189 sub db_load() {
1339 warn "loading database $path\n";#d# remove later
1340 $DB = stat $path ? Storable::retrieve $path : { }; 2190 $DB = stat $path ? Storable::retrieve $path : { };
1341 } 2191 }
1342 2192
1343 my $pid; 2193 my $pid;
1344 2194
1345 sub db_save() { 2195 sub db_save() {
1346 warn "saving database $path\n";#d# remove later
1347 waitpid $pid, 0 if $pid; 2196 waitpid $pid, 0 if $pid;
1348 if (0 == ($pid = fork)) { 2197 if (0 == ($pid = fork)) {
1349 $DB->{_meta}{version} = 1; 2198 $DB->{_meta}{version} = 1;
1350 Storable::nstore $DB, "$path~"; 2199 Storable::nstore $DB, "$path~";
1351 rename "$path~", $path; 2200 rename "$path~", $path;
1358 sub db_sync() { 2207 sub db_sync() {
1359 db_save if $dirty; 2208 db_save if $dirty;
1360 undef $dirty; 2209 undef $dirty;
1361 } 2210 }
1362 2211
1363 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2212 my $idle = Event->idle (
1364 db_sync; 2213 reentrant => 0,
2214 min => 10,
2215 max => 20,
2216 repeat => 0,
2217 data => WF_AUTOCANCEL,
2218 cb => \&db_sync,
1365 }); 2219 );
1366 2220
1367 sub db_dirty() { 2221 sub db_dirty() {
1368 $dirty = 1; 2222 $dirty = 1;
1369 $idle->start; 2223 $idle->start;
1370 } 2224 }
1399 open my $fh, "<:utf8", cf::confdir . "/config" 2253 open my $fh, "<:utf8", cf::confdir . "/config"
1400 or return; 2254 or return;
1401 2255
1402 local $/; 2256 local $/;
1403 *CFG = YAML::Syck::Load <$fh>; 2257 *CFG = YAML::Syck::Load <$fh>;
2258
2259 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2260
2261 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2262 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2263
2264 if (exists $CFG{mlockall}) {
2265 eval {
2266 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2267 and die "WARNING: m(un)lockall failed: $!\n";
2268 };
2269 warn $@ if $@;
2270 }
1404} 2271}
1405 2272
1406sub main { 2273sub main {
1407 # we must not ever block the main coroutine 2274 # we must not ever block the main coroutine
1408 local $Coro::idle = sub { 2275 local $Coro::idle = sub {
1409 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 2276 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1410 (Coro::unblock_sub { 2277 (async {
1411 Event::one_event; 2278 Event::one_event;
1412 })->(); 2279 })->prio (Coro::PRIO_MAX);
1413 }; 2280 };
1414 2281
1415 cfg_load; 2282 cfg_load;
1416 db_load; 2283 db_load;
1417 load_extensions; 2284 load_extensions;
2285
2286 $TICK_WATCHER->start;
1418 Event::loop; 2287 Event::loop;
1419} 2288}
1420 2289
1421############################################################################# 2290#############################################################################
1422# initialisation 2291# initialisation and cleanup
1423 2292
2293# install some emergency cleanup handlers
2294BEGIN {
2295 for my $signal (qw(INT HUP TERM)) {
2296 Event->signal (
2297 reentrant => 0,
2298 data => WF_AUTOCANCEL,
2299 signal => $signal,
2300 prio => 0,
2301 cb => sub {
2302 cf::cleanup "SIG$signal";
2303 },
2304 );
2305 }
2306}
2307
2308sub emergency_save() {
2309 my $freeze_guard = cf::freeze_mainloop;
2310
2311 warn "enter emergency perl save\n";
2312
2313 cf::sync_job {
2314 # use a peculiar iteration method to avoid tripping on perl
2315 # refcount bugs in for. also avoids problems with players
2316 # and maps saved/destroyed asynchronously.
2317 warn "begin emergency player save\n";
2318 for my $login (keys %cf::PLAYER) {
2319 my $pl = $cf::PLAYER{$login} or next;
2320 $pl->valid or next;
2321 $pl->save;
2322 }
2323 warn "end emergency player save\n";
2324
2325 warn "begin emergency map save\n";
2326 for my $path (keys %cf::MAP) {
2327 my $map = $cf::MAP{$path} or next;
2328 $map->valid or next;
2329 $map->save;
2330 }
2331 warn "end emergency map save\n";
2332 };
2333
2334 warn "leave emergency perl save\n";
2335}
2336
1424sub perl_reload() { 2337sub reload() {
1425 # can/must only be called in main 2338 # can/must only be called in main
1426 if ($Coro::current != $Coro::main) { 2339 if ($Coro::current != $Coro::main) {
1427 warn "can only reload from main coroutine\n"; 2340 warn "can only reload from main coroutine";
1428 return; 2341 return;
1429 } 2342 }
1430 2343
1431 warn "reloading..."; 2344 warn "reloading...";
1432 2345
1433 local $FREEZE = 1; 2346 warn "cancelling server ticker";
2347 $TICK_WATCHER->cancel;
2348
1434 cf::emergency_save; 2349 cf::emergency_save;
1435 2350
1436 eval { 2351 eval {
1437 # if anything goes wrong in here, we should simply crash as we already saved 2352 # if anything goes wrong in here, we should simply crash as we already saved
1438 2353
1439 # cancel all watchers 2354 warn "syncing database to disk";
2355 cf::db_sync;
2356
2357 warn "cancelling all WF_AUTOCANCEL watchers";
1440 for (Event::all_watchers) { 2358 for (Event::all_watchers) {
1441 $_->cancel if $_->data & WF_AUTOCANCEL; 2359 $_->cancel if $_->data & WF_AUTOCANCEL;
1442 } 2360 }
1443 2361
2362 warn "flushing outstanding aio requests";
2363 for (;;) {
2364 IO::AIO::flush;
2365 Coro::cede;
2366 last unless IO::AIO::nreqs;
2367 warn "iterate...";
2368 }
2369
1444 # cancel all extension coros 2370 warn "cancelling all extension coros";
1445 $_->cancel for values %EXT_CORO; 2371 $_->cancel for values %EXT_CORO;
1446 %EXT_CORO = (); 2372 %EXT_CORO = ();
1447 2373
1448 # unload all extensions 2374 warn "removing commands";
1449 for (@exts) { 2375 %COMMAND = ();
2376
2377 warn "removing ext commands";
2378 %EXTCMD = ();
2379
2380 warn "unloading/nuking all extensions";
2381 for my $pkg (@EXTS) {
1450 warn "unloading <$_>"; 2382 warn "... unloading $pkg";
1451 unload_extension $_; 2383
2384 if (my $cb = $pkg->can ("unload")) {
2385 eval {
2386 $cb->($pkg);
2387 1
2388 } or warn "$pkg unloaded, but with errors: $@";
1452 } 2389 }
1453 2390
2391 warn "... nuking $pkg";
2392 Symbol::delete_package $pkg;
2393 }
2394
1454 # unload all modules loaded from $LIBDIR 2395 warn "unloading all perl modules loaded from $LIBDIR";
1455 while (my ($k, $v) = each %INC) { 2396 while (my ($k, $v) = each %INC) {
1456 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2397 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1457 2398
1458 warn "removing <$k>"; 2399 warn "... unloading $k";
1459 delete $INC{$k}; 2400 delete $INC{$k};
1460 2401
1461 $k =~ s/\.pm$//; 2402 $k =~ s/\.pm$//;
1462 $k =~ s/\//::/g; 2403 $k =~ s/\//::/g;
1463 2404
1466 } 2407 }
1467 2408
1468 Symbol::delete_package $k; 2409 Symbol::delete_package $k;
1469 } 2410 }
1470 2411
1471 # sync database to disk
1472 cf::db_sync;
1473 IO::AIO::flush;
1474
1475 # get rid of safe::, as good as possible 2412 warn "getting rid of safe::, as good as possible";
1476 Symbol::delete_package "safe::$_" 2413 Symbol::delete_package "safe::$_"
1477 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2414 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1478 2415
1479 # remove register_script_function callbacks
1480 # TODO
1481
1482 # unload cf.pm "a bit" 2416 warn "unloading cf.pm \"a bit\"";
1483 delete $INC{"cf.pm"}; 2417 delete $INC{"cf.pm"};
1484 2418
1485 # don't, removes xs symbols, too, 2419 # don't, removes xs symbols, too,
1486 # and global variables created in xs 2420 # and global variables created in xs
1487 #Symbol::delete_package __PACKAGE__; 2421 #Symbol::delete_package __PACKAGE__;
1488 2422
1489 # reload cf.pm 2423 warn "unload completed, starting to reload now";
2424
1490 warn "reloading cf.pm"; 2425 warn "reloading cf.pm";
1491 require cf; 2426 require cf;
1492 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2427 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1493 2428
1494 # load config and database again 2429 warn "loading config and database again";
1495 cf::cfg_load; 2430 cf::cfg_load;
1496 cf::db_load; 2431 cf::db_load;
1497 2432
1498 # load extensions
1499 warn "load extensions"; 2433 warn "loading extensions";
1500 cf::load_extensions; 2434 cf::load_extensions;
1501 2435
1502 # reattach attachments to objects 2436 warn "reattaching attachments to objects/players";
1503 warn "reattach";
1504 _global_reattach; 2437 _global_reattach;
2438 warn "reattaching attachments to maps";
2439 reattach $_ for values %MAP;
2440
2441 warn "restarting server ticker";
2442
2443 $TICK_WATCHER->start;
1505 }; 2444 };
1506 2445
1507 if ($@) { 2446 if ($@) {
1508 warn $@; 2447 warn $@;
1509 warn "error while reloading, exiting."; 2448 warn "error while reloading, exiting.";
1510 exit 1; 2449 exit 1;
1511 } 2450 }
1512 2451
1513 warn "reloaded successfully"; 2452 warn "reloaded";
1514}; 2453};
1515 2454
1516############################################################################# 2455our $RELOAD_WATCHER; # used only during reload
1517 2456
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 { 2457register_command "reload" => sub {
1532 my ($who, $arg) = @_; 2458 my ($who, $arg) = @_;
1533 2459
1534 if ($who->flag (FLAG_WIZ)) { 2460 if ($who->flag (FLAG_WIZ)) {
1535 $who->message ("start of reload.");
1536 perl_reload;
1537 $who->message ("end of reload."); 2461 $who->message ("reloading server.");
2462
2463 # doing reload synchronously and two reloads happen back-to-back,
2464 # coro crashes during coro_state_free->destroy here.
2465
2466 $RELOAD_WATCHER ||= Event->timer (
2467 reentrant => 0,
2468 after => 0,
2469 data => WF_AUTOCANCEL,
2470 cb => sub {
2471 reload;
2472 undef $RELOAD_WATCHER;
2473 },
2474 );
1538 } 2475 }
1539}; 2476};
1540 2477
1541unshift @INC, $LIBDIR; 2478unshift @INC, $LIBDIR;
2479
2480my $bug_warning = 0;
1542 2481
1543$TICK_WATCHER = Event->timer ( 2482$TICK_WATCHER = Event->timer (
1544 reentrant => 0, 2483 reentrant => 0,
2484 parked => 1,
1545 prio => 0, 2485 prio => 0,
1546 at => $NEXT_TICK || $TICK, 2486 at => $NEXT_TICK || $TICK,
1547 data => WF_AUTOCANCEL, 2487 data => WF_AUTOCANCEL,
1548 cb => sub { 2488 cb => sub {
1549 unless ($FREEZE) { 2489 if ($Coro::current != $Coro::main) {
2490 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2491 unless ++$bug_warning > 10;
2492 return;
2493 }
2494
2495 $NOW = Event::time;
2496
1550 cf::server_tick; # one server iteration 2497 cf::server_tick; # one server iteration
1551 $RUNTIME += $TICK; 2498 $RUNTIME += $TICK;
1552 }
1553
1554 $NEXT_TICK += $TICK; 2499 $NEXT_TICK += $TICK;
2500
2501 $WAIT_FOR_TICK->broadcast;
2502 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2503
2504 Event::sweep;
2505 Coro::cede_notself;
2506
2507# my $AFTER = Event::time;
2508# warn $AFTER - $NOW;#d#
1555 2509
1556 # if we are delayed by four ticks or more, skip them all 2510 # if we are delayed by four ticks or more, skip them all
1557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2511 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1558 2512
1559 $TICK_WATCHER->at ($NEXT_TICK); 2513 $TICK_WATCHER->at ($NEXT_TICK);
1560 $TICK_WATCHER->start; 2514 $TICK_WATCHER->start;
1561 }, 2515 },
1562); 2516);
1563 2517
1564IO::AIO::max_poll_time $TICK * 0.2; 2518IO::AIO::max_poll_time $TICK * 0.1;
1565 2519
1566Event->io ( 2520undef $Coro::AIO::WATCHER;
2521$AIO_POLL_WATCHER = Event->io (
2522 reentrant => 0,
1567 fd => IO::AIO::poll_fileno, 2523 fd => IO::AIO::poll_fileno,
1568 poll => 'r', 2524 poll => 'r',
1569 prio => 5, 2525 prio => 6,
1570 data => WF_AUTOCANCEL, 2526 data => WF_AUTOCANCEL,
1571 cb => \&IO::AIO::poll_cb, 2527 cb => \&IO::AIO::poll_cb,
1572); 2528);
1573 2529
1574Event->timer ( 2530$WRITE_RUNTIME_WATCHER = Event->timer (
2531 reentrant => 0,
1575 data => WF_AUTOCANCEL, 2532 data => WF_AUTOCANCEL,
1576 after => 0, 2533 after => 1,
1577 interval => 10, 2534 interval => 10,
1578 cb => sub { 2535 prio => 6, # keep it lowest so it acts like a watchdog
1579 (Coro::unblock_sub { 2536 cb => Coro::unblock_sub {
1580 write_runtime 2537 write_runtime
1581 or warn "ERROR: unable to write runtime file: $!"; 2538 or warn "ERROR: unable to write runtime file: $!";
1582 })->();
1583 }, 2539 },
1584); 2540);
1585 2541
2542END { cf::emergency_save }
2543
15861 25441
1587 2545

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines