ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.178 by root, Thu Jan 18 00:06:55 2007 UTC

…		…
8	use Storable;	8	use Storable;
9	use Opcode;	9	use Opcode;
10	use Safe;	10	use Safe;
11	use Safe::Hole;	11	use Safe::Hole;
12		12
13	use Coro 3.3;	13	use Coro 3.4 ();
14	use Coro::Event;	14	use Coro::Event;
15	use Coro::Timer;	15	use Coro::Timer;
16	use Coro::Signal;	16	use Coro::Signal;
17	use Coro::Semaphore;	17	use Coro::Semaphore;
18	use Coro::AIO;	18	use Coro::AIO;
19		19
		20	use Data::Dumper;
20	use Digest::MD5;	21	use Digest::MD5;
21	use Fcntl;	22	use Fcntl;
22	use IO::AIO 2.31 ();	23	use IO::AIO 2.32 ();
23	use YAML::Syck ();	24	use YAML::Syck ();
24	use Time::HiRes;	25	use Time::HiRes;
25		26
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
27		28
		29	sub 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
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		35
35	our %COMMAND = ();	36	our %COMMAND = ();
36	our %COMMAND_TIME = ();	37	our %COMMAND_TIME = ();
		38
		39	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	40	our %EXTCMD = ();
		41	our %EXT_CORO = (); # coroutines bound to extensions
		42	our %EXT_MAP = (); # pluggable maps
38		43
39	our @EVENT;	44	our @EVENT;
40	our $LIBDIR = datadir . "/ext";	45	our $LIBDIR = datadir . "/ext";
41		46
42	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
43	our $TICK_WATCHER;	48	our $TICK_WATCHER;
		49	our $AIO_POLL_WATCHER;
		50	our $WRITE_RUNTIME_WATCHER;
44	our $NEXT_TICK;	51	our $NEXT_TICK;
45	our $NOW;	52	our $NOW;
46		53
47	our %CFG;	54	our %CFG;
48		55
49	our $UPTIME; $UPTIME ||= time;	56	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	57	our $RUNTIME;
51		58
		59	our %PLAYER; # all users
52	our %MAP; # all maps	60	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	61	our $LINK_MAP; # the special {link} map, which is always available
54	our $FREEZE;
55	our $RANDOM_MAPS = cf::localdir . "/random";	62	our $RANDOM_MAPS = cf::localdir . "/random";
56	our %EXT_CORO;	63
		64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		65	our $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 ∕
		68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57		69
58	binmode STDOUT;	70	binmode STDOUT;
59	binmode STDERR;	71	binmode STDERR;
60		72
61	# read virtual server time, if available	73	# read virtual server time, if available
…		…
69	mkdir cf::localdir . "/" . cf::playerdir;	81	mkdir cf::localdir . "/" . cf::playerdir;
70	mkdir cf::localdir . "/" . cf::tmpdir;	82	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;	83	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;	84	mkdir $RANDOM_MAPS;
73		85
74	# a special map that is always available	86	our $EMERGENCY_POSITION;
75	our $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
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	from wherever your confdir points to.	119	from wherever your confdir points to.
		120
		121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		122
		123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		125	processing has been done. Call C<< ->wait >> on them to maximise the
		126	window 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
150	my %ext_pkg;
151	my @exts;
152	my @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
		176	sub 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
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use 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
179	sub to_json($) {	214	sub 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
		221	Wait until the given lock is available. See cf::lock_acquire.
		222
		223	=item my $lock = cf::lock_acquire $string
		224
		225	Wait until the given lock is available and then acquires it and returns
		226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		227	for example when the coroutine gets canceled), the lock is automatically
		228	returned.
		229
		230	Lock names should begin with a unique identifier (for example, cf::map::find
		231	uses map_find and cf::map::load uses map_load).
		232
		233	=cut
		234
		235	our %LOCK;
		236
		237	sub 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
		247	sub 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
		261	sub 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
		275	Currently the same as Coro::async_pool, meaning you cannot use
		276	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		277	thing you are allowed to do is call C<prio> on it.
		278
		279	=cut
		280
		281	BEGIN { *async = \&Coro::async_pool }
183		282
184	=item cf::sync_job { BLOCK }	283	=item cf::sync_job { BLOCK }
185		284
186	The design of crossfire+ requires that the main coro ($Coro::main) is	285	The design of crossfire+ requires that the main coro ($Coro::main) is
187	always able to handle events or runnable, as crossfire+ is only partly	286	always able to handle events or runnable, as crossfire+ is only partly
…		…
195	=cut	294	=cut
196		295
197	sub sync_job(&) {	296	sub 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
227	Creates and returns a new coro. This coro is automcatially being canceled	330	Like async, but this coro is automatically being canceled when the
228	when the extension calling this is being unloaded.	331	extension calling this is being unloaded.
229		332
230	=cut	333	=cut
231		334
232	sub coro(&) {	335	sub 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
278	package cf::path;
279
280	sub new {
281	my ($class, $path, $base) = @_;
282
283	my $self = bless { }, $class;
284
285	if ($path =~ s{^\?random/}{}) {
286	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
287	$self->{random} = cf::from_json $data;
288	} else {
289	if ($path =~ s{^~([^/]+)?}{}) {
290	$self->{user_rel} = 1;
291
292	if (defined $1) {
293	$self->{user} = $1;
294	} elsif ($base =~ m{^~([^/]+)/}) {
295	$self->{user} = $1;
296	} else {
297	warn "cannot resolve user-relative path without user <$path,$base>\n";
298	}
299	} elsif ($path =~ /^\//) {
300	# already absolute
301	} else {
302	$base =~ s{[^/]+/?$}{};
303	return $class->new ("$base/$path");
304	}
305
306	for ($path) {
307	redo if s{/\.?/}{/};
308	redo if s{/[^/]+/\.\./}{/};
309	}
310	}
311
312	$self->{path} = $path;
313
314	$self
315	}
316
317	# the name / primary key / in-game path
318	sub as_string {
319	my ($self) = @_;
320
321	$self->{user_rel} ? "~$self->{user}$self->{path}"
322	: $self->{random} ? "?random/$self->{path}"
323	: $self->{path}
324	}
325
326	# the displayed name, this is a one way mapping
327	sub visible_name {
328	my ($self) = @_;
329
330	# if (my $rmp = $self->{random}) {
331	# # todo: be more intelligent about this
332	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
333	# } else {
334	$self->as_string
335	# }
336	}
337
338	# escape the /'s in the path
339	sub _escaped_path {
340	# ∕ is U+2215
341	(my $path = $_[0]{path}) =~ s/\//∕/g;
342	$path
343	}
344
345	# the original (read-only) location
346	sub load_path {
347	my ($self) = @_;
348
349	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
350	}
351
352	# the temporary/swap location
353	sub save_path {
354	my ($self) = @_;
355
356	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
357	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
358	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
359	}
360
361	# the unique path, might be eq to save_path
362	sub uniq_path {
363	my ($self) = @_;
364
365	$self->{user_rel} || $self->{random}
366	? undef
367	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
368	}
369
370	# return random map parameters, or undef
371	sub random_map_params {
372	my ($self) = @_;
373
374	$self->{random}
375	}
376
377	# this is somewhat ugly, but style maps do need special treatment
378	sub is_style_map {
379	$_[0]{path} =~ m{^/styles/}
380	}
381
382	package cf;
383		373
384	#############################################################################	374	#############################################################################
385		375
386	=head2 ATTACHABLE OBJECTS	376	=head2 ATTACHABLE OBJECTS
387		377
…		…
513	our @CB_TYPE = (); # registry for type (cf-object class) based events	503	our @CB_TYPE = (); # registry for type (cf-object class) based events
514	our @CB_MAP = ();	504	our @CB_MAP = ();
515		505
516	my %attachment;	506	my %attachment;
517		507
		508	sub cf::attachable::thawer_merge {
		509	# simply override everything except _meta
		510	local $_[0]{_meta};
		511	%{$_[0]} = %{$_[1]};
		512	}
		513
518	sub _attach_cb($$$$) {	514	sub _attach_cb($$$$) {
519	my ($registry, $event, $prio, $cb) = @_;	515	my ($registry, $event, $prio, $cb) = @_;
520		516
521	use sort 'stable';	517	use sort 'stable';
522		518
…		…
693	# object support	689	# object support
694		690
695	sub reattach {	691	sub reattach {
696	# basically do the same as instantiate, without calling instantiate	692	# basically do the same as instantiate, without calling instantiate
697	my ($obj) = @_;	693	my ($obj) = @_;
		694
		695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
698		696
699	my $registry = $obj->registry;	697	my $registry = $obj->registry;
700		698
701	@$registry = ();	699	@$registry = ();
702		700
…		…
795	or return;	793	or return;
796		794
797	unless (aio_stat "$filename.pst") {	795	unless (aio_stat "$filename.pst") {
798	(aio_load "$filename.pst", $av) >= 0	796	(aio_load "$filename.pst", $av) >= 0
799	or return;	797	or return;
800	$av = eval { (Storable::thaw <$av>)->{objs} };	798	$av = eval { (Storable::thaw $av)->{objs} };
801	}	799	}
802		800
		801	warn sprintf "loading %s (%d)\n",
		802	$filename, length $data, scalar @{$av || []};#d#
803	return ($data, $av);	803	return ($data, $av);
804	}	804	}
805		805
806	#############################################################################	806	#############################################################################
807	# command handling &c	807	# command handling &c
…		…
832	=cut	832	=cut
833		833
834	sub register_extcmd {	834	sub register_extcmd {
835	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
836		836
837	my $caller = caller;
838	#warn "registering extcmd '$name' to '$caller'";
839
840	$EXTCMD{$name} = [$cb, $caller];	837	$EXTCMD{$name} = $cb;
841	}	838	}
842		839
843	cf::player->attach (	840	cf::player->attach (
844	on_command => sub {	841	on_command => sub {
845	my ($pl, $name, $params) = @_;	842	my ($pl, $name, $params) = @_;
…		…
858		855
859	my $msg = eval { from_json $buf };	856	my $msg = eval { from_json $buf };
860		857
861	if (ref $msg) {	858	if (ref $msg) {
862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
863	if (my %reply = $cb->[0]->($pl, $msg)) {	860	if (my %reply = $cb->($pl, $msg)) {
864	$pl->ext_reply ($msg->{msgid}, %reply);	861	$pl->ext_reply ($msg->{msgid}, %reply);
865	}	862	}
866	}	863	}
867	} else {	864	} else {
868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
870		867
871	cf::override;	868	cf::override;
872	},	869	},
873	);	870	);
874		871
875	sub register {
876	my ($base, $pkg) = @_;
877
878	#TODO
879	}
880
881	sub load_extension {	872	sub load_extension {
882	my ($path) = @_;	873	my ($path) = @_;
883		874
884	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
885	my $base = $1;	876	my $base = $1;
886	my $pkg = $1;	877	my $pkg = $1;
887	$pkg =~ s/[^[:word:]]/_/g;	878	$pkg =~ s/[^[:word:]]/_/g;
888	$pkg = "ext::$pkg";	879	$pkg = "ext::$pkg";
889		880
890	warn "loading '$path' into '$pkg'\n";	881	warn "... loading '$path' into '$pkg'\n";
891		882
892	open my $fh, "<:utf8", $path	883	open my $fh, "<:utf8", $path
893	or die "$path: $!";	884	or die "$path: $!";
894		885
895	my $source =	886	my $source =
896	"package $pkg; use strict; use utf8;\n"	887	"package $pkg; use strict; use utf8;\n"
897	. "#line 1 \"$path\"\n{\n"	888	. "#line 1 \"$path\"\n{\n"
898	. (do { local $/; <$fh> })	889	. (do { local $/; <$fh> })
899	. "\n};\n1";	890	. "\n};\n1";
900		891
901	eval $source	892	unless (eval $source) {
902	or die $@ ? "$path: $@\n"	893	my $msg = $@ ? "$path: $@\n"
903	: "extension disabled.\n";	894	: "extension disabled.\n";
904		895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
905	push @exts, $pkg;	896	warn $@;
906	$ext_pkg{$base} = $pkg;	897	warn "mandatory extension failed to load, exiting.\n";
907		898	exit 1;
908	# no strict 'refs';	899	}
909	# @{"$pkg\::ISA"} = ext::;	900	die $@;
910
911	register $base, $pkg;
912	}
913
914	sub unload_extension {
915	my ($pkg) = @_;
916
917	warn "removing extension $pkg\n";
918
919	# remove hooks
920	#TODO
921	# for my $idx (0 .. $#PLUGIN_EVENT) {
922	# delete $hook[$idx]{$pkg};
923	# }	901	}
924		902
925	# remove commands	903	push @EXTS, $pkg;
926	for my $name (keys %COMMAND) {
927	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
928
929	if (@cb) {
930	$COMMAND{$name} = \@cb;
931	} else {
932	delete $COMMAND{$name};
933	}
934	}
935
936	# remove extcmds
937	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
938	delete $EXTCMD{$name};
939	}
940
941	if (my $cb = $pkg->can ("unload")) {
942	eval {
943	$cb->($pkg);
944	1
945	} or warn "$pkg unloaded, but with errors: $@";
946	}
947
948	Symbol::delete_package $pkg;
949	}	904	}
950		905
951	sub load_extensions {	906	sub load_extensions {
952	for my $ext (<$LIBDIR/*.ext>) {	907	for my $ext (<$LIBDIR/*.ext>) {
953	next unless -r $ext;	908	next unless -r $ext;
…		…
957	} or warn "$ext not loaded: $@";	912	} or warn "$ext not loaded: $@";
958	}	913	}
959	}	914	}
960		915
961	#############################################################################	916	#############################################################################
962	# load/save/clean perl data associated with a map
963		917
964	*cf::mapsupport::on_clean = sub {	918	=head2 CORE EXTENSIONS
		919
		920	Functions and methods that extend core crossfire objects.
		921
		922	=cut
		923
		924	package cf::player;
		925
		926	use Coro::AIO;
		927
		928	=head3 cf::player
		929
		930	=over 4
		931
		932	=item cf::player::find $login
		933
		934	Returns the given player object, loading it if necessary (might block).
		935
		936	=cut
		937
		938	sub playerdir($) {
		939	cf::localdir
		940	. "/"
		941	. cf::playerdir
		942	. "/"
		943	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		944	}
		945
		946	sub path($) {
		947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		948
		949	(playerdir $login) . "/$login.pl"
		950	}
		951
		952	sub find_active($) {
		953	$cf::PLAYER{$_[0]}
		954	and $cf::PLAYER{$_[0]}->active
		955	and $cf::PLAYER{$_[0]}
		956	}
		957
		958	sub exists($) {
		959	my ($login) = @_;
		960
		961	$cf::PLAYER{$login}
		962	or cf::sync_job { !aio_stat $login }
		963	}
		964
		965	sub 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
		979	sub 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
		996	sub 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
		1011	Nukes the player without looking back. If logged in, the connection will
		1012	be destroyed. May block for a long time.
		1013
		1014	=cut
		1015
		1016	sub 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
		1037	Returns am arrayref of all valid playernames in the system, can take a
		1038	while and may block, so not sync_job-capable, ever.
		1039
		1040	=cut
		1041
		1042	sub 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
		1062	Returns an arrayref of map paths that are private for this
		1063	player. May block.
		1064
		1065	=cut
		1066
		1067	sub 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
		1089	Sends an ext reply to the player.
		1090
		1091	=cut
		1092
		1093	sub ext_reply($$$%) {
		1094	my ($self, $id, %msg) = @_;
		1095
		1096	$msg{msgid} = $id;
		1097
		1098	$self->send ("ext " . cf::to_json \%msg);
		1099	}
		1100
		1101	package cf;
		1102
		1103	=back
		1104
		1105
		1106	=head3 cf::map
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	package cf::map;
		1113
		1114	use Fcntl;
		1115	use Coro::AIO;
		1116
		1117	use overload
		1118	'""' => \&as_string,
		1119	fallback => 1;
		1120
		1121	our $MAX_RESET = 3600;
		1122	our $DEFAULT_RESET = 3000;
		1123
		1124	sub 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
		1142	sub 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
		1155	sub 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
		1167	sub 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
		1199	sub 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
		1219	sub init {
		1220	my ($self) = @_;
		1221
		1222	$self
		1223	}
		1224
		1225	sub as_string {
		1226	my ($self) = @_;
		1227
		1228	"$self->{path}"
		1229	}
		1230
		1231	# the displayed name, this is a one way mapping
		1232	sub visible_name {
		1233	&as_string
		1234	}
		1235
		1236	# the original (read-only) location
		1237	sub load_path {
		1238	my ($self) = @_;
		1239
		1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1241	}
		1242
		1243	# the temporary/swap location
		1244	sub 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
		1252	sub 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++...
		1261	sub change_all_map_light {
		1262	my ($change) = @_;
		1263
		1264	$_->change_map_light ($change)
		1265	for grep $_->outdoor, values %cf::MAP;
		1266	}
		1267
		1268	sub 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
		1276	sub 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
		1291	sub load_orig {
		1292	my ($self) = @_;
		1293
		1294	$self->load_header_from ($self->load_path)
		1295	}
		1296
		1297	sub load_temp {
		1298	my ($self) = @_;
		1299
		1300	$self->load_header_from ($self->save_path)
		1301	}
		1302
		1303	sub 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
		1325	sub find;
		1326	sub 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
		1355	sub 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
		1400	sub 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
		1410	sub load_diag {
965	my ($map) = @_;	1411	my ($map) = @_;
966		1412
967	my $path = $map->tmpname;	1413	my @diag; # diagonal neighbours
968	defined $path or return;
969		1414
970	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
		1433	sub find_sync {
		1434	my ($path, $origin) = @_;
		1435
		1436	cf::sync_job { find $path, $origin }
		1437	}
		1438
		1439	sub do_load_sync {
		1440	my ($map) = @_;
		1441
		1442	cf::sync_job { $map->load };
		1443	}
		1444
		1445	our %MAP_PREFETCH;
		1446	our $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	}
971	};	1457	};
972		1458
973	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1459	sub find_async {
		1460	my ($path, $origin) = @_;
974		1461
975	#############################################################################	1462	$path = normalise $path, $origin && $origin->{path};
976	# load/save perl data associated with player->ob objects
977		1463
978	sub all_objects(@) {	1464	if (my $map = $cf::MAP{$path}) {
979	@_, map all_objects ($_->inv), @_	1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
980	}
981
982	# TODO: compatibility cruft, remove when no longer needed
983	cf::player->attach (
984	on_load => sub {
985	my ($pl, $path) = @_;
986
987	for my $o (all_objects $pl->ob) {
988	if (my $value = $o->get_ob_key_value ("_perl_data")) {
989	$o->set_ob_key_value ("_perl_data");
990
991	%$o = %{ Storable::thaw pack "H*", $value };
992	}
993	}
994	},	1466	}
995	);
996		1467
997	#############################################################################	1468	$MAP_PREFETCH{$path} = 0;
		1469	$MAP_PREFETCHER->ready;
998		1470
999	=head2 CORE EXTENSIONS	1471	()
		1472	}
1000		1473
1001	Functions and methods that extend core crossfire objects.	1474	sub save {
		1475	my ($self) = @_;
1002		1476
1003	=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
		1504	sub 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
		1520	sub 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
		1533	sub should_reset {
		1534	my ($self) = @_;
		1535
		1536	$self->reset_at <= $cf::RUNTIME
		1537	}
		1538
		1539	sub 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
		1560	my $nuke_counter = "aaaa";
		1561
		1562	sub 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
		1582	Returns an arrayref of paths of all shared maps that have
		1583	instantiated unique items. May block.
		1584
		1585	=cut
		1586
		1587	sub 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
		1605	package cf;
		1606
		1607	=back
		1608
		1609	=head3 cf::object
		1610
		1611	=cut
		1612
		1613	package cf::object;
1004		1614
1005	=over 4	1615	=over 4
1006		1616
1007	=item cf::player::exists $login	1617	=item $ob->inv_recursive
1008		1618
1009	Returns true when the given account exists.	1619	Returns the inventory of the object _and_ their inventories, recursively.
1010		1620
1011	=cut	1621	=cut
1012		1622
1013	sub cf::player::exists($) {	1623	sub inv_recursive_;
1014	cf::player::find $_[0]	1624	sub inv_recursive_ {
1015	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1625	map { $_, inv_recursive_ $_->inv } @_
1016	}	1626	}
1017		1627
1018	=item $player->ext_reply ($msgid, $msgtype, %msg)	1628	sub inv_recursive {
1019		1629	inv_recursive_ inv $_[0]
1020	Sends an ext reply to the player.
1021
1022	=cut
1023
1024	sub cf::player::ext_reply($$$%) {
1025	my ($self, $id, %msg) = @_;
1026
1027	$msg{msgid} = $id;
1028
1029	$self->send ("ext " . to_json \%msg);
1030	}	1630	}
		1631
		1632	package cf;
1031		1633
1032	=back	1634	=back
1033		1635
1034	=head3 cf::object::player	1636	=head3 cf::object::player
1035		1637
…		…
1073	(ref $cf::CFG{"may_$access"}	1675	(ref $cf::CFG{"may_$access"}
1074	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1676	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1075	: $cf::CFG{"may_$access"})	1677	: $cf::CFG{"may_$access"})
1076	}	1678	}
1077		1679
		1680	=item $player_object->enter_link
		1681
		1682	Freezes the player and moves him/her to a special map (C<{link}>).
		1683
		1684	The player should be reasonably safe there for short amounts of time. You
		1685	I<MUST> call C<leave_link> as soon as possible, though.
		1686
		1687	Will never block.
		1688
		1689	=item $player_object->leave_link ($map, $x, $y)
		1690
		1691	Moves the player out of the special C<{link}> map onto the specified
		1692	map. If the map is not valid (or omitted), the player will be moved back
		1693	to the location he/she was before the call to C<enter_link>, or, if that
		1694	fails, to the emergency map position.
		1695
		1696	Might block.
		1697
		1698	=cut
		1699
		1700	sub 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
		1710	sub 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
		1723	sub 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
		1755	cf::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
		1791	sub 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
		1813	sub parse_random_map_params {
		1814	my ($spec) = @_;
		1815
		1816	my $rmp = { # defaults
		1817	xsize => -1,
		1818	ysize => -1,
		1819	};
		1820
		1821	for (split /\n/, $spec) {
		1822	my ($k, $v) = split /\s+/, $_, 2;
		1823
		1824	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1825	}
		1826
		1827	$rmp
		1828	}
		1829
		1830	sub prepare_random_map {
		1831	my ($exit) = @_;
		1832
		1833	# all this does is basically replace the /! path by
		1834	# a new random map path (?random/...) with a seed
		1835	# that depends on the exit object
		1836
		1837	my $rmp = parse_random_map_params $exit->msg;
		1838
		1839	if ($exit->map) {
		1840	$rmp->{region} = $exit->map->region_name;
		1841	$rmp->{origin_map} = $exit->map->path;
		1842	$rmp->{origin_x} = $exit->x;
		1843	$rmp->{origin_y} = $exit->y;
		1844	}
		1845
		1846	$rmp->{random_seed} ||= $exit->random_seed;
		1847
		1848	my $data = cf::to_json $rmp;
		1849	my $md5 = Digest::MD5::md5_hex $data;
		1850	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1851
		1852	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1853	aio_write $fh, 0, (length $data), $data, 0;
		1854	undef $fh;
		1855	aio_rename "$meta~", $meta;
		1856
		1857	$exit->slaying ("?random/$md5");
		1858	$exit->msg (undef);
		1859	}
		1860	}
		1861
		1862	sub cf::object::player::enter_exit {
		1863	my ($self, $exit) = @_;
		1864
		1865	return unless $self->type == cf::PLAYER;
		1866
		1867	$self->enter_link;
		1868
		1869	(async {
		1870	$self->deactivate_recursive; # just to be sure
		1871	unless (eval {
		1872	prepare_random_map $exit
		1873	if $exit->slaying eq "/!";
		1874
		1875	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1876	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1877
		1878	1;
		1879	}) {
		1880	$self->message ("Something went wrong deep within the crossfire server. "
		1881	. "I'll try to bring you back to the map you were before. "
		1882	. "Please report this to the dungeon master!",
		1883	cf::NDI_UNIQUE | cf::NDI_RED);
		1884
		1885	warn "ERROR in enter_exit: $@";
		1886	$self->leave_link;
		1887	}
		1888	})->prio (1);
		1889	}
		1890
1078	=head3 cf::client	1891	=head3 cf::client
1079		1892
1080	=over 4	1893	=over 4
1081		1894
1082	=item $client->send_drawinfo ($text, $flags)	1895	=item $client->send_drawinfo ($text, $flags)
…		…
1125	on_reply => sub {	1938	on_reply => sub {
1126	my ($ns, $msg) = @_;	1939	my ($ns, $msg) = @_;
1127		1940
1128	# this weird shuffling is so that direct followup queries	1941	# this weird shuffling is so that direct followup queries
1129	# get handled first	1942	# get handled first
1130	my $queue = delete $ns->{query_queue};	1943	my $queue = delete $ns->{query_queue}
		1944	or return; # be conservative, not sure how that can happen, but we saw a crash here
1131		1945
1132	(shift @$queue)->[1]->($msg);	1946	(shift @$queue)->[1]->($msg);
1133		1947
1134	push @{ $ns->{query_queue} }, @$queue;	1948	push @{ $ns->{query_queue} }, @$queue;
1135		1949
…		…
1141	}	1955	}
1142	}	1956	}
1143	},	1957	},
1144	);	1958	);
1145		1959
1146	=item $client->coro (\&cb)	1960	=item $client->async (\&cb)
1147		1961
1148	Create a new coroutine, running the specified callback. The coroutine will	1962	Create a new coroutine, running the specified callback. The coroutine will
1149	be automatically cancelled when the client gets destroyed (e.g. on logout,	1963	be automatically cancelled when the client gets destroyed (e.g. on logout,
1150	or loss of connection).	1964	or loss of connection).
1151		1965
1152	=cut	1966	=cut
1153		1967
1154	sub cf::client::coro {	1968	sub cf::client::async {
1155	my ($self, $cb) = @_;	1969	my ($self, $cb) = @_;
1156		1970
1157	my $coro; $coro = async {	1971	my $coro = &Coro::async ($cb);
1158	eval {
1159	$cb->();
1160	};
1161	warn $@ if $@;
1162	};
1163		1972
1164	$coro->on_destroy (sub {	1973	$coro->on_destroy (sub {
1165	delete $self->{_coro}{$coro+0};	1974	delete $self->{_coro}{$coro+0};
1166	});	1975	});
1167		1976
…		…
1339		2148
1340	{	2149	{
1341	my $path = cf::localdir . "/database.pst";	2150	my $path = cf::localdir . "/database.pst";
1342		2151
1343	sub db_load() {	2152	sub db_load() {
1344	warn "loading database $path\n";#d# remove later
1345	$DB = stat $path ? Storable::retrieve $path : { };	2153	$DB = stat $path ? Storable::retrieve $path : { };
1346	}	2154	}
1347		2155
1348	my $pid;	2156	my $pid;
1349		2157
1350	sub db_save() {	2158	sub db_save() {
1351	warn "saving database $path\n";#d# remove later
1352	waitpid $pid, 0 if $pid;	2159	waitpid $pid, 0 if $pid;
1353	if (0 == ($pid = fork)) {	2160	if (0 == ($pid = fork)) {
1354	$DB->{_meta}{version} = 1;	2161	$DB->{_meta}{version} = 1;
1355	Storable::nstore $DB, "$path~";	2162	Storable::nstore $DB, "$path~";
1356	rename "$path~", $path;	2163	rename "$path~", $path;
…		…
1404	open my $fh, "<:utf8", cf::confdir . "/config"	2211	open my $fh, "<:utf8", cf::confdir . "/config"
1405	or return;	2212	or return;
1406		2213
1407	local $/;	2214	local $/;
1408	*CFG = YAML::Syck::Load <$fh>;	2215	*CFG = YAML::Syck::Load <$fh>;
		2216
		2217	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2218
		2219	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2220	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2221
		2222	if (exists $CFG{mlockall}) {
		2223	eval {
		2224	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2225	and die "WARNING: m(un)lockall failed: $!\n";
		2226	};
		2227	warn $@ if $@;
		2228	}
1409	}	2229	}
1410		2230
1411	sub main {	2231	sub main {
1412	# we must not ever block the main coroutine	2232	# we must not ever block the main coroutine
1413	local $Coro::idle = sub {	2233	local $Coro::idle = sub {
1414	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#	2234	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1415	(Coro::unblock_sub {	2235	(async {
1416	Event::one_event;	2236	Event::one_event;
1417	})->();	2237	})->prio (Coro::PRIO_MAX);
1418	};	2238	};
1419		2239
1420	cfg_load;	2240	cfg_load;
1421	db_load;	2241	db_load;
1422	load_extensions;	2242	load_extensions;
1423	Event::loop;	2243	Event::loop;
1424	}	2244	}
1425		2245
1426	#############################################################################	2246	#############################################################################
1427	# initialisation	2247	# initialisation and cleanup
1428		2248
		2249	# install some emergency cleanup handlers
		2250	BEGIN {
		2251	for my $signal (qw(INT HUP TERM)) {
		2252	Event->signal (
		2253	data => WF_AUTOCANCEL,
		2254	signal => $signal,
		2255	cb => sub {
		2256	cf::cleanup "SIG$signal";
		2257	},
		2258	);
		2259	}
		2260	}
		2261
		2262	sub emergency_save() {
		2263	my $freeze_guard = cf::freeze_mainloop;
		2264
		2265	warn "enter emergency perl save\n";
		2266
		2267	cf::sync_job {
		2268	# use a peculiar iteration method to avoid tripping on perl
		2269	# refcount bugs in for. also avoids problems with players
		2270	# and maps saved/destroyed asynchronously.
		2271	warn "begin emergency player save\n";
		2272	for my $login (keys %cf::PLAYER) {
		2273	my $pl = $cf::PLAYER{$login} or next;
		2274	$pl->valid or next;
		2275	$pl->save;
		2276	}
		2277	warn "end emergency player save\n";
		2278
		2279	warn "begin emergency map save\n";
		2280	for my $path (keys %cf::MAP) {
		2281	my $map = $cf::MAP{$path} or next;
		2282	$map->valid or next;
		2283	$map->save;
		2284	}
		2285	warn "end emergency map save\n";
		2286	};
		2287
		2288	warn "leave emergency perl save\n";
		2289	}
		2290
1429	sub perl_reload() {	2291	sub reload() {
1430	# can/must only be called in main	2292	# can/must only be called in main
1431	if ($Coro::current != $Coro::main) {	2293	if ($Coro::current != $Coro::main) {
1432	warn "can only reload from main coroutine\n";	2294	warn "can only reload from main coroutine\n";
1433	return;	2295	return;
1434	}	2296	}
1435		2297
1436	warn "reloading...";	2298	warn "reloading...";
1437		2299
1438	local $FREEZE = 1;	2300	warn "freezing server";
		2301	my $guard = freeze_mainloop;
1439	cf::emergency_save;	2302	cf::emergency_save;
		2303
		2304	warn "sync database to disk";
		2305	cf::db_sync;
		2306	IO::AIO::flush;
1440		2307
1441	eval {	2308	eval {
1442	# if anything goes wrong in here, we should simply crash as we already saved	2309	# if anything goes wrong in here, we should simply crash as we already saved
1443		2310
1444	# cancel all watchers	2311	warn "cancel all watchers";
1445	for (Event::all_watchers) {	2312	for (Event::all_watchers) {
1446	$_->cancel if $_->data & WF_AUTOCANCEL;	2313	$_->cancel if $_->data & WF_AUTOCANCEL;
1447	}	2314	}
1448		2315
1449	# cancel all extension coros	2316	warn "cancel all extension coros";
1450	$_->cancel for values %EXT_CORO;	2317	$_->cancel for values %EXT_CORO;
1451	%EXT_CORO = ();	2318	%EXT_CORO = ();
1452		2319
		2320	warn "remove commands";
		2321	%COMMAND = ();
		2322
		2323	warn "remove ext commands";
		2324	%EXTCMD = ();
		2325
1453	# unload all extensions	2326	warn "unload/nuke all extensions";
1454	for (@exts) {	2327	for my $pkg (@EXTS) {
1455	warn "unloading <$_>";	2328	warn "... unloading $pkg";
1456	unload_extension $_;	2329
		2330	if (my $cb = $pkg->can ("unload")) {
		2331	eval {
		2332	$cb->($pkg);
		2333	1
		2334	} or warn "$pkg unloaded, but with errors: $@";
1457	}	2335	}
1458		2336
		2337	warn "... nuking $pkg";
		2338	Symbol::delete_package $pkg;
		2339	}
		2340
1459	# unload all modules loaded from $LIBDIR	2341	warn "unload all perl modules loaded from $LIBDIR";
1460	while (my ($k, $v) = each %INC) {	2342	while (my ($k, $v) = each %INC) {
1461	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2343	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1462		2344
1463	warn "removing <$k>";	2345	warn "removing <$k>";
1464	delete $INC{$k};	2346	delete $INC{$k};
…		…
1471	}	2353	}
1472		2354
1473	Symbol::delete_package $k;	2355	Symbol::delete_package $k;
1474	}	2356	}
1475		2357
1476	# sync database to disk
1477	cf::db_sync;
1478	IO::AIO::flush;
1479
1480	# get rid of safe::, as good as possible	2358	warn "get rid of safe::, as good as possible";
1481	Symbol::delete_package "safe::$_"	2359	Symbol::delete_package "safe::$_"
1482	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2360	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1483		2361
1484	# remove register_script_function callbacks
1485	# TODO
1486
1487	# unload cf.pm "a bit"	2362	warn "unload cf.pm \"a bit\"";
1488	delete $INC{"cf.pm"};	2363	delete $INC{"cf.pm"};
1489		2364
1490	# don't, removes xs symbols, too,	2365	# don't, removes xs symbols, too,
1491	# and global variables created in xs	2366	# and global variables created in xs
1492	#Symbol::delete_package __PACKAGE__;	2367	#Symbol::delete_package __PACKAGE__;
1493		2368
1494	# reload cf.pm
1495	warn "reloading cf.pm";	2369	warn "reloading cf.pm";
1496	require cf;	2370	require cf;
1497	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2371	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1498		2372
1499	# load config and database again	2373	warn "load config and database again";
1500	cf::cfg_load;	2374	cf::cfg_load;
1501	cf::db_load;	2375	cf::db_load;
1502		2376
1503	# load extensions
1504	warn "load extensions";	2377	warn "load extensions";
1505	cf::load_extensions;	2378	cf::load_extensions;
1506		2379
1507	# reattach attachments to objects	2380	warn "reattach attachments to objects/players";
1508	warn "reattach";
1509	_global_reattach;	2381	_global_reattach;
		2382	warn "reattach attachments to maps";
		2383	reattach $_ for values %MAP;
1510	};	2384	};
1511		2385
1512	if ($@) {	2386	if ($@) {
1513	warn $@;	2387	warn $@;
1514	warn "error while reloading, exiting.";	2388	warn "error while reloading, exiting.";
1515	exit 1;	2389	exit 1;
1516	}	2390	}
1517		2391
1518	warn "reloaded successfully";	2392	warn "reloaded";
1519	};	2393	};
1520		2394
1521	#############################################################################	2395	our $RELOAD_WATCHER; # used only during reload
1522		2396
1523	unless ($LINK_MAP) {
1524	$LINK_MAP = cf::map::new;
1525
1526	$LINK_MAP->width (41);
1527	$LINK_MAP->height (41);
1528	$LINK_MAP->alloc;
1529	$LINK_MAP->path ("{link}");
1530	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1531	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1532	}
1533
1534	register "<global>", __PACKAGE__;
1535
1536	register_command "perl-reload" => sub {	2397	register_command "reload" => sub {
1537	my ($who, $arg) = @_;	2398	my ($who, $arg) = @_;
1538		2399
1539	if ($who->flag (FLAG_WIZ)) {	2400	if ($who->flag (FLAG_WIZ)) {
1540	$who->message ("start of reload.");
1541	perl_reload;
1542	$who->message ("end of reload.");	2401	$who->message ("reloading server.");
		2402
		2403	# doing reload synchronously and two reloads happen back-to-back,
		2404	# coro crashes during coro_state_free->destroy here.
		2405
		2406	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
		2407	reload;
		2408	undef $RELOAD_WATCHER;
		2409	});
1543	}	2410	}
1544	};	2411	};
1545		2412
1546	unshift @INC, $LIBDIR;	2413	unshift @INC, $LIBDIR;
1547		2414
…		…
1549	reentrant => 0,	2416	reentrant => 0,
1550	prio => 0,	2417	prio => 0,
1551	at => $NEXT_TICK || $TICK,	2418	at => $NEXT_TICK || $TICK,
1552	data => WF_AUTOCANCEL,	2419	data => WF_AUTOCANCEL,
1553	cb => sub {	2420	cb => sub {
1554	unless ($FREEZE) {	2421	$NOW = Event::time;
		2422
1555	cf::server_tick; # one server iteration	2423	cf::server_tick; # one server iteration
1556	$RUNTIME += $TICK;	2424	$RUNTIME += $TICK;
1557	}
1558
1559	$NEXT_TICK += $TICK;	2425	$NEXT_TICK += $TICK;
		2426
		2427	$WAIT_FOR_TICK->broadcast;
		2428	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
1560		2429
1561	# if we are delayed by four ticks or more, skip them all	2430	# if we are delayed by four ticks or more, skip them all
1562	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2431	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1563		2432
1564	$TICK_WATCHER->at ($NEXT_TICK);	2433	$TICK_WATCHER->at ($NEXT_TICK);
…		…
1566	},	2435	},
1567	);	2436	);
1568		2437
1569	IO::AIO::max_poll_time $TICK * 0.2;	2438	IO::AIO::max_poll_time $TICK * 0.2;
1570		2439
1571	Event->io (	2440	$AIO_POLL_WATCHER = Event->io (
1572	fd => IO::AIO::poll_fileno,	2441	fd => IO::AIO::poll_fileno,
1573	poll => 'r',	2442	poll => 'r',
1574	prio => 5,	2443	prio => 5,
1575	data => WF_AUTOCANCEL,	2444	data => WF_AUTOCANCEL,
1576	cb => \&IO::AIO::poll_cb,	2445	cb => \&IO::AIO::poll_cb,
1577	);	2446	);
1578		2447
1579	Event->timer (	2448	$WRITE_RUNTIME_WATCHER = Event->timer (
1580	data => WF_AUTOCANCEL,	2449	data => WF_AUTOCANCEL,
1581	after => 0,	2450	after => 0,
1582	interval => 10,	2451	interval => 10,
1583	cb => sub {	2452	cb => sub {
1584	(Coro::unblock_sub {	2453	(Coro::unblock_sub {
…		…
1586	or warn "ERROR: unable to write runtime file: $!";	2455	or warn "ERROR: unable to write runtime file: $!";
1587	})->();	2456	})->();
1588	},	2457	},
1589	);	2458	);
1590		2459
		2460	END { cf::emergency_save }
		2461
1591	1	2462	1
1592		2463

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines