[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC vs. Revision 1.173 by root, Sun Jan 14 18:00:34 2007 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.173 by root, Sun Jan 14 18:00:34 2007 UTC