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.150 by root, Mon Jan 8 19:25:53 2007 UTC vs.
Revision 1.234 by root, Thu Apr 5 13:44:31 2007 UTC

…		…
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
8	use Storable;	8	use Storable;
		9	use Event;
9	use Opcode;	10	use Opcode;
10	use Safe;	11	use Safe;
11	use Safe::Hole;	12	use Safe::Hole;
12		13
13	use Coro 3.3 ();	14	use Coro 3.52 ();
		15	use Coro::State;
14	use Coro::Event;	16	use Coro::Event;
15	use Coro::Timer;	17	use Coro::Timer;
16	use Coro::Signal;	18	use Coro::Signal;
17	use Coro::Semaphore;	19	use Coro::Semaphore;
18	use Coro::AIO;	20	use Coro::AIO;
19		21
		22	use BDB ();
		23	use Data::Dumper;
20	use Digest::MD5;	24	use Digest::MD5;
21	use Fcntl;	25	use Fcntl;
		26	use YAML::Syck ();
22	use IO::AIO 2.32 ();	27	use IO::AIO 2.32 ();
23	use YAML::Syck ();
24	use Time::HiRes;	28	use Time::HiRes;
		29	use Compress::LZF;
25		30
		31	# configure various modules to our taste
		32	#
		33	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		34	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		35
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	36	$Event::Eval = 1; # no idea why this is required, but it is
27		37
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	38	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	39	$YAML::Syck::ImplicitUnicode = 1;
30		40
31	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	41	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		42
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	43	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		44
35	our %COMMAND = ();	45	our %COMMAND = ();
36	our %COMMAND_TIME = ();	46	our %COMMAND_TIME = ();
		47
		48	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	49	our %EXTCMD = ();
		50	our %EXT_CORO = (); # coroutines bound to extensions
		51	our %EXT_MAP = (); # pluggable maps
38		52
		53	our $RELOAD; # number of reloads so far
39	our @EVENT;	54	our @EVENT;
40	our $LIBDIR = datadir . "/ext";	55	our $LIBDIR = datadir . "/ext";
41		56
42	our $TICK = MAX_TIME * 1e-6;	57	our $TICK = MAX_TIME * 1e-6;
43	our $TICK_WATCHER;	58	our $TICK_WATCHER;
		59	our $AIO_POLL_WATCHER;
		60	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	61	our $NEXT_TICK;
45	our $NOW;	62	our $NOW;
		63	our $USE_FSYNC = 1; # use fsync to write maps - default off
		64
		65	our $BDB_POLL_WATCHER;
		66	our $DB_ENV;
46		67
47	our %CFG;	68	our %CFG;
48		69
49	our $UPTIME; $UPTIME ||= time;	70	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	71	our $RUNTIME;
51		72
52	our %PLAYER; # all users	73	our %PLAYER; # all users
53	our %MAP; # all maps	74	our %MAP; # all maps
54	our $LINK_MAP; # the special {link} map	75	our $LINK_MAP; # the special {link} map, which is always available
55	our $RANDOM_MAPS = cf::localdir . "/random";	76	our $RANDOM_MAPS = cf::localdir . "/random";
56	our %EXT_CORO; # coroutines bound to extensions	77	our $BDB_ENV_DIR = cf::localdir . "/db";
		78
		79	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		80	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		81
		82	# used to convert map paths into valid unix filenames by replacing / by ∕
		83	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57		84
58	binmode STDOUT;	85	binmode STDOUT;
59	binmode STDERR;	86	binmode STDERR;
60		87
61	# read virtual server time, if available	88	# read virtual server time, if available
…		…
68	mkdir cf::localdir;	95	mkdir cf::localdir;
69	mkdir cf::localdir . "/" . cf::playerdir;	96	mkdir cf::localdir . "/" . cf::playerdir;
70	mkdir cf::localdir . "/" . cf::tmpdir;	97	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;	98	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;	99	mkdir $RANDOM_MAPS;
		100	mkdir $BDB_ENV_DIR;
73		101
74	# a special map that is always available
75	our $LINK_MAP;
76	our $EMERGENCY_POSITION;	102	our $EMERGENCY_POSITION;
		103
		104	sub cf::map::normalise;
77		105
78	#############################################################################	106	#############################################################################
79		107
80	=head2 GLOBAL VARIABLES	108	=head2 GLOBAL VARIABLES
81		109
…		…
105		133
106	=item %cf::CFG	134	=item %cf::CFG
107		135
108	Configuration for the server, loaded from C</etc/crossfire/config>, or	136	Configuration for the server, loaded from C</etc/crossfire/config>, or
109	from wherever your confdir points to.	137	from wherever your confdir points to.
		138
		139	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		140
		141	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		142	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		143	processing has been done. Call C<< ->wait >> on them to maximise the
		144	window of cpu time available, or simply to synchronise to the server tick.
110		145
111	=back	146	=back
112		147
113	=cut	148	=cut
114		149
…		…
146		181
147	$Event::DIED = sub {	182	$Event::DIED = sub {
148	warn "error in event callback: @_";	183	warn "error in event callback: @_";
149	};	184	};
150		185
151	my %ext_pkg;
152	my @exts;
153	my @hook;
154
155	=head2 UTILITY FUNCTIONS	186	=head2 UTILITY FUNCTIONS
156		187
157	=over 4	188	=over 4
158		189
159	=cut	190	=item dumpval $ref
160		191
		192	=cut
		193
		194	sub dumpval {
		195	eval {
		196	local $SIG{__DIE__};
		197	my $d;
		198	if (1) {
		199	$d = new Data::Dumper([$_[0]], ["*var"]);
		200	$d->Terse(1);
		201	$d->Indent(2);
		202	$d->Quotekeys(0);
		203	$d->Useqq(1);
		204	#$d->Bless(...);
		205	$d->Seen($_[1]) if @_ > 1;
		206	$d = $d->Dump();
		207	}
		208	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		209	$d
		210	} || "[unable to dump $_[0]: '$@']";
		211	}
		212
161	use JSON::Syck (); # TODO# replace by JSON::PC once working	213	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
162		214
163	=item $ref = cf::from_json $json	215	=item $ref = cf::from_json $json
164		216
165	Converts a JSON string into the corresponding perl data structure.	217	Converts a JSON string into the corresponding perl data structure.
166		218
167	=cut
168
169	sub from_json($) {
170	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171	JSON::Syck::Load $_[0]
172	}
173
174	=item $json = cf::to_json $ref	219	=item $json = cf::to_json $ref
175		220
176	Converts a perl data structure into its JSON representation.	221	Converts a perl data structure into its JSON representation.
177
178	=cut
179
180	sub to_json($) {
181	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
182	JSON::Syck::Dump $_[0]
183	}
184		222
185	=item cf::lock_wait $string	223	=item cf::lock_wait $string
186		224
187	Wait until the given lock is available. See cf::lock_acquire.	225	Wait until the given lock is available. See cf::lock_acquire.
188		226
…		…
225	}	263	}
226		264
227	sub freeze_mainloop {	265	sub freeze_mainloop {
228	return unless $TICK_WATCHER->is_active;	266	return unless $TICK_WATCHER->is_active;
229		267
230	my $guard = Coro::guard { $TICK_WATCHER->start };	268	my $guard = Coro::guard {
		269	$TICK_WATCHER->start;
		270	};
231	$TICK_WATCHER->stop;	271	$TICK_WATCHER->stop;
232	$guard	272	$guard
233	}	273	}
234		274
235	=item cf::async { BLOCK }	275	=item cf::async { BLOCK }
…		…
287	}	327	}
288	}	328	}
289		329
290	=item $coro = cf::async_ext { BLOCK }	330	=item $coro = cf::async_ext { BLOCK }
291		331
292	Like async, but this coro is automcatially being canceled when the	332	Like async, but this coro is automatically being canceled when the
293	extension calling this is being unloaded.	333	extension calling this is being unloaded.
294		334
295	=cut	335	=cut
296		336
297	sub async_ext(&) {	337	sub async_ext(&) {
…		…
306		346
307	$coro	347	$coro
308	}	348	}
309		349
310	sub write_runtime {	350	sub write_runtime {
		351	my $guard = cf::lock_acquire "write_runtime";
		352
311	my $runtime = cf::localdir . "/runtime";	353	my $runtime = cf::localdir . "/runtime";
312		354
313	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	355	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
314	or return;	356	or return;
315		357
		358	my $value = $cf::RUNTIME + 90 + 10;
316	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	359	# 10 is the runtime save interval, for a monotonic clock
		360	# 60 allows for the watchdog to kill the server.
		361
317	(aio_write $fh, 0, (length $value), $value, 0) <= 0	362	(aio_write $fh, 0, (length $value), $value, 0) <= 0
318	and return;	363	and return;
319		364
		365	# always fsync - this file is important
320	aio_fsync $fh	366	aio_fsync $fh
321	and return;	367	and return;
322		368
323	close $fh	369	close $fh
324	or return;	370	or return;
…		…
327	and return;	373	and return;
328		374
329	1	375	1
330	}	376	}
331		377
		378	=item cf::datalog type => key => value, ...
		379
		380	Log a datalog packet of the given type with the given key-value pairs.
		381
		382	=cut
		383
		384	sub datalog($@) {
		385	my ($type, %kv) = @_;
		386	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		387	}
		388
332	=back	389	=back
333		390
334	=cut	391	=cut
335
336	#############################################################################
337
338	package cf::path;
339
340	sub new {
341	my ($class, $path, $base) = @_;
342
343	$path = $path->as_string if ref $path;
344
345	my $self = bless { }, $class;
346
347	# {... are special paths that are not touched
348	# ?xxx/... are special absolute paths
349	# ?random/... random maps
350	# /! non-realised random map exit
351	# /... normal maps
352	# ~/... per-player maps without a specific player (DO NOT USE)
353	# ~user/... per-player map of a specific user
354
355	if ($path =~ /^{/) {
356	# fine as it is
357	} elsif ($path =~ s{^\?random/}{}) {
358	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
359	$self->{random} = cf::from_json $data;
360	} else {
361	if ($path =~ s{^~([^/]+)?}{}) {
362	$self->{user_rel} = 1;
363
364	if (defined $1) {
365	$self->{user} = $1;
366	} elsif ($base =~ m{^~([^/]+)/}) {
367	$self->{user} = $1;
368	} else {
369	warn "cannot resolve user-relative path without user <$path,$base>\n";
370	}
371	} elsif ($path =~ /^\//) {
372	# already absolute
373	} else {
374	$base =~ s{[^/]+/?$}{};
375	return $class->new ("$base/$path");
376	}
377
378	for ($path) {
379	redo if s{/\.?/}{/};
380	redo if s{/[^/]+/\.\./}{/};
381	}
382	}
383
384	$self->{path} = $path;
385
386	$self
387	}
388
389	# the name / primary key / in-game path
390	sub as_string {
391	my ($self) = @_;
392
393	$self->{user_rel} ? "~$self->{user}$self->{path}"
394	: $self->{random} ? "?random/$self->{path}"
395	: $self->{path}
396	}
397
398	# the displayed name, this is a one way mapping
399	sub visible_name {
400	my ($self) = @_;
401
402	# if (my $rmp = $self->{random}) {
403	# # todo: be more intelligent about this
404	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
405	# } else {
406	$self->as_string
407	# }
408	}
409
410	# escape the /'s in the path
411	sub _escaped_path {
412	# ∕ is U+2215
413	(my $path = $_[0]{path}) =~ s/\//∕/g;
414	$path
415	}
416
417	# the original (read-only) location
418	sub load_path {
419	my ($self) = @_;
420
421	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
422	}
423
424	# the temporary/swap location
425	sub save_path {
426	my ($self) = @_;
427
428	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
429	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
430	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
431	}
432
433	# the unique path, might be eq to save_path
434	sub uniq_path {
435	my ($self) = @_;
436
437	$self->{user_rel} || $self->{random}
438	? undef
439	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
440	}
441
442	# return random map parameters, or undef
443	sub random_map_params {
444	my ($self) = @_;
445
446	$self->{random}
447	}
448
449	# this is somewhat ugly, but style maps do need special treatment
450	sub is_style_map {
451	$_[0]{path} =~ m{^/styles/}
452	}
453
454	package cf;
455		392
456	#############################################################################	393	#############################################################################
457		394
458	=head2 ATTACHABLE OBJECTS	395	=head2 ATTACHABLE OBJECTS
459		396
…		…
585	our @CB_TYPE = (); # registry for type (cf-object class) based events	522	our @CB_TYPE = (); # registry for type (cf-object class) based events
586	our @CB_MAP = ();	523	our @CB_MAP = ();
587		524
588	my %attachment;	525	my %attachment;
589		526
		527	sub cf::attachable::thawer_merge {
		528	# simply override everything except _meta
		529	local $_[0]{_meta};
		530	%{$_[0]} = %{$_[1]};
		531	}
		532
590	sub _attach_cb($$$$) {	533	sub _attach_cb($$$$) {
591	my ($registry, $event, $prio, $cb) = @_;	534	my ($registry, $event, $prio, $cb) = @_;
592		535
593	use sort 'stable';	536	use sort 'stable';
594		537
…		…
765	# object support	708	# object support
766		709
767	sub reattach {	710	sub reattach {
768	# basically do the same as instantiate, without calling instantiate	711	# basically do the same as instantiate, without calling instantiate
769	my ($obj) = @_;	712	my ($obj) = @_;
		713
		714	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
770		715
771	my $registry = $obj->registry;	716	my $registry = $obj->registry;
772		717
773	@$registry = ();	718	@$registry = ();
774		719
…		…
821	$filename, length $$rdata, scalar @$objs;	766	$filename, length $$rdata, scalar @$objs;
822		767
823	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	768	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
824	chmod SAVE_MODE, $fh;	769	chmod SAVE_MODE, $fh;
825	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	770	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
826	aio_fsync $fh;	771	aio_fsync $fh if $cf::USE_FSYNC;
827	close $fh;	772	close $fh;
828		773
829	if (@$objs) {	774	if (@$objs) {
830	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	775	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
831	chmod SAVE_MODE, $fh;	776	chmod SAVE_MODE, $fh;
832	my $data = Storable::nfreeze { version => 1, objs => $objs };	777	my $data = Storable::nfreeze { version => 1, objs => $objs };
833	aio_write $fh, 0, (length $data), $data, 0;	778	aio_write $fh, 0, (length $data), $data, 0;
834	aio_fsync $fh;	779	aio_fsync $fh if $cf::USE_FSYNC;
835	close $fh;	780	close $fh;
836	aio_rename "$filename.pst~", "$filename.pst";	781	aio_rename "$filename.pst~", "$filename.pst";
837	}	782	}
838	} else {	783	} else {
839	aio_unlink "$filename.pst";	784	aio_unlink "$filename.pst";
…		…
906	=cut	851	=cut
907		852
908	sub register_extcmd {	853	sub register_extcmd {
909	my ($name, $cb) = @_;	854	my ($name, $cb) = @_;
910		855
911	my $caller = caller;
912	#warn "registering extcmd '$name' to '$caller'";
913
914	$EXTCMD{$name} = [$cb, $caller];	856	$EXTCMD{$name} = $cb;
915	}	857	}
916		858
917	cf::player->attach (	859	cf::player->attach (
918	on_command => sub {	860	on_command => sub {
919	my ($pl, $name, $params) = @_;	861	my ($pl, $name, $params) = @_;
…		…
932		874
933	my $msg = eval { from_json $buf };	875	my $msg = eval { from_json $buf };
934		876
935	if (ref $msg) {	877	if (ref $msg) {
936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	878	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937	if (my %reply = $cb->[0]->($pl, $msg)) {	879	if (my %reply = $cb->($pl, $msg)) {
938	$pl->ext_reply ($msg->{msgid}, %reply);	880	$pl->ext_reply ($msg->{msgid}, %reply);
939	}	881	}
940	}	882	}
941	} else {	883	} else {
942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	884	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
944		886
945	cf::override;	887	cf::override;
946	},	888	},
947	);	889	);
948		890
949	sub register {
950	my ($base, $pkg) = @_;
951
952	#TODO
953	}
954
955	sub load_extension {	891	sub load_extension {
956	my ($path) = @_;	892	my ($path) = @_;
957		893
958	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	894	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
959	my $base = $1;	895	my $base = $1;
960	my $pkg = $1;	896	my $pkg = $1;
961	$pkg =~ s/[^[:word:]]/_/g;	897	$pkg =~ s/[^[:word:]]/_/g;
962	$pkg = "ext::$pkg";	898	$pkg = "ext::$pkg";
963		899
964	warn "loading '$path' into '$pkg'\n";	900	warn "... loading '$path' into '$pkg'\n";
965		901
966	open my $fh, "<:utf8", $path	902	open my $fh, "<:utf8", $path
967	or die "$path: $!";	903	or die "$path: $!";
968		904
969	my $source =	905	my $source =
970	"package $pkg; use strict; use utf8;\n"	906	"package $pkg; use strict; use utf8;\n"
971	. "#line 1 \"$path\"\n{\n"	907	. "#line 1 \"$path\"\n{\n"
972	. (do { local $/; <$fh> })	908	. (do { local $/; <$fh> })
973	. "\n};\n1";	909	. "\n};\n1";
974		910
975	eval $source	911	unless (eval $source) {
976	or die $@ ? "$path: $@\n"	912	my $msg = $@ ? "$path: $@\n"
977	: "extension disabled.\n";	913	: "extension disabled.\n";
978		914	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
979	push @exts, $pkg;	915	warn $@;
980	$ext_pkg{$base} = $pkg;	916	warn "mandatory extension failed to load, exiting.\n";
981		917	exit 1;
982	# no strict 'refs';	918	}
983	# @{"$pkg\::ISA"} = ext::;	919	die $@;
984
985	register $base, $pkg;
986	}
987
988	sub unload_extension {
989	my ($pkg) = @_;
990
991	warn "removing extension $pkg\n";
992
993	# remove hooks
994	#TODO
995	# for my $idx (0 .. $#PLUGIN_EVENT) {
996	# delete $hook[$idx]{$pkg};
997	# }	920	}
998		921
999	# remove commands	922	push @EXTS, $pkg;
1000	for my $name (keys %COMMAND) {
1001	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1002
1003	if (@cb) {
1004	$COMMAND{$name} = \@cb;
1005	} else {
1006	delete $COMMAND{$name};
1007	}
1008	}
1009
1010	# remove extcmds
1011	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1012	delete $EXTCMD{$name};
1013	}
1014
1015	if (my $cb = $pkg->can ("unload")) {
1016	eval {
1017	$cb->($pkg);
1018	1
1019	} or warn "$pkg unloaded, but with errors: $@";
1020	}
1021
1022	Symbol::delete_package $pkg;
1023	}	923	}
1024		924
1025	sub load_extensions {	925	sub load_extensions {
1026	for my $ext (<$LIBDIR/*.ext>) {	926	for my $ext (<$LIBDIR/*.ext>) {
1027	next unless -r $ext;	927	next unless -r $ext;
…		…
1031	} or warn "$ext not loaded: $@";	931	} or warn "$ext not loaded: $@";
1032	}	932	}
1033	}	933	}
1034		934
1035	#############################################################################	935	#############################################################################
1036	# load/save/clean perl data associated with a map
1037
1038	*cf::mapsupport::on_clean = sub {
1039	my ($map) = @_;
1040
1041	my $path = $map->tmpname;
1042	defined $path or return;
1043
1044	unlink "$path.pst";
1045	};
1046
1047	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1048
1049	#############################################################################
1050	# load/save perl data associated with player->ob objects
1051
1052	sub all_objects(@) {
1053	@_, map all_objects ($_->inv), @_
1054	}
1055
1056	# TODO: compatibility cruft, remove when no longer needed
1057	cf::player->attach (
1058	on_load => sub {
1059	my ($pl, $path) = @_;
1060
1061	for my $o (all_objects $pl->ob) {
1062	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1063	$o->set_ob_key_value ("_perl_data");
1064
1065	%$o = %{ Storable::thaw pack "H*", $value };
1066	}
1067	}
1068	},
1069	);
1070
1071	#############################################################################
1072		936
1073	=head2 CORE EXTENSIONS	937	=head2 CORE EXTENSIONS
1074		938
1075	Functions and methods that extend core crossfire objects.	939	Functions and methods that extend core crossfire objects.
1076		940
1077	=cut	941	=cut
1078		942
1079	package cf::player;	943	package cf::player;
		944
		945	use Coro::AIO;
1080		946
1081	=head3 cf::player	947	=head3 cf::player
1082		948
1083	=over 4	949	=over 4
1084		950
…		…
1097	}	963	}
1098		964
1099	sub path($) {	965	sub path($) {
1100	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	966	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1101		967
1102	(playerdir $login) . "/$login.pl"	968	(playerdir $login) . "/playerdata"
1103	}	969	}
1104		970
1105	sub find_active($) {	971	sub find_active($) {
1106	$cf::PLAYER{$_[0]}	972	$cf::PLAYER{$_[0]}
1107	and $cf::PLAYER{$_[0]}->active	973	and $cf::PLAYER{$_[0]}->active
…		…
1110		976
1111	sub exists($) {	977	sub exists($) {
1112	my ($login) = @_;	978	my ($login) = @_;
1113		979
1114	$cf::PLAYER{$login}	980	$cf::PLAYER{$login}
1115	or cf::sync_job { !aio_stat $login }	981	or cf::sync_job { !aio_stat path $login }
1116	}	982	}
1117		983
1118	sub find($) {	984	sub find($) {
1119	return $cf::PLAYER{$_[0]} || do {	985	return $cf::PLAYER{$_[0]} || do {
1120	my $login = $_[0];	986	my $login = $_[0];
1121		987
1122	my $guard = cf::lock_acquire "user_find:$login";	988	my $guard = cf::lock_acquire "user_find:$login";
1123		989
1124	$cf::PLAYER{$login} ||= (load_pl path $login or return);	990	$cf::PLAYER{$_[0]} || do {
		991	# rename old playerfiles to new ones
		992	#TODO: remove when no longer required
		993	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		994	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		995	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		996	aio_unlink +(playerdir $login) . "/$login.pl";
		997
		998	my $pl = load_pl path $login
		999	or return;
		1000	$cf::PLAYER{$login} = $pl
		1001	}
1125	};	1002	}
1126	}	1003	}
1127		1004
1128	sub save($) {	1005	sub save($) {
1129	my ($pl) = @_;	1006	my ($pl) = @_;
1130		1007
…		…
1133	my $path = path $pl;	1010	my $path = path $pl;
1134	my $guard = cf::lock_acquire "user_save:$path";	1011	my $guard = cf::lock_acquire "user_save:$path";
1135		1012
1136	return if $pl->{deny_save};	1013	return if $pl->{deny_save};
1137		1014
1138	Coro::AIO::aio_mkdir playerdir $pl, 0770;	1015	aio_mkdir playerdir $pl, 0770;
1139	$pl->{last_save} = $cf::RUNTIME;	1016	$pl->{last_save} = $cf::RUNTIME;
1140		1017
1141	$pl->save_pl ($path);	1018	$pl->save_pl ($path);
1142	Coro::cede;	1019	Coro::cede;
1143	}	1020	}
…		…
1153	$cf::PLAYER{$login} = $self;	1030	$cf::PLAYER{$login} = $self;
1154		1031
1155	$self	1032	$self
1156	}	1033	}
1157		1034
		1035	=item $pl->quit_character
		1036
		1037	Nukes the player without looking back. If logged in, the connection will
		1038	be destroyed. May block for a long time.
		1039
		1040	=cut
		1041
1158	sub quit_character {	1042	sub quit_character {
1159	my ($pl) = @_;	1043	my ($pl) = @_;
		1044
		1045	my $name = $pl->ob->name;
1160		1046
1161	$pl->{deny_save} = 1;	1047	$pl->{deny_save} = 1;
1162	$pl->password ("*"); # this should lock out the player until we nuked the dir	1048	$pl->password ("*"); # this should lock out the player until we nuked the dir
1163		1049
1164	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1050	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1166	$pl->invoke (cf::EVENT_PLAYER_QUIT);	1052	$pl->invoke (cf::EVENT_PLAYER_QUIT);
1167	$pl->ns->destroy if $pl->ns;	1053	$pl->ns->destroy if $pl->ns;
1168		1054
1169	my $path = playerdir $pl;	1055	my $path = playerdir $pl;
1170	my $temp = "$path~$cf::RUNTIME~deleting~";	1056	my $temp = "$path~$cf::RUNTIME~deleting~";
1171	Coro::AIO::aio_rename $path, $temp;	1057	aio_rename $path, $temp;
1172	delete $cf::PLAYER{$pl->ob->name};	1058	delete $cf::PLAYER{$pl->ob->name};
1173	$pl->destroy;	1059	$pl->destroy;
		1060
		1061	my $prefix = qr<^~\Q$name\E/>;
		1062
		1063	# nuke player maps
		1064	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1065
1174	IO::AIO::aio_rmtree $temp;	1066	IO::AIO::aio_rmtree $temp;
1175	}	1067	}
1176		1068
		1069	=item $pl->kick
		1070
		1071	Kicks a player out of the game. This destroys the connection.
		1072
		1073	=cut
		1074
		1075	sub kick {
		1076	my ($pl, $kicker) = @_;
		1077
		1078	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1079	$pl->killer ("kicked");
		1080	$pl->ns->destroy;
		1081	}
		1082
		1083	=item cf::player::list_logins
		1084
		1085	Returns am arrayref of all valid playernames in the system, can take a
		1086	while and may block, so not sync_job-capable, ever.
		1087
		1088	=cut
		1089
		1090	sub list_logins {
		1091	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1092	or return [];
		1093
		1094	my @logins;
		1095
		1096	for my $login (@$dirs) {
		1097	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1098	aio_read $fh, 0, 512, my $buf, 0 or next;
		1099	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1100
		1101	utf8::decode $login;
		1102	push @logins, $login;
		1103	}
		1104
		1105	\@logins
		1106	}
		1107
		1108	=item $player->maps
		1109
		1110	Returns an arrayref of map paths that are private for this
		1111	player. May block.
		1112
		1113	=cut
		1114
		1115	sub maps($) {
		1116	my ($pl) = @_;
		1117
		1118	$pl = ref $pl ? $pl->ob->name : $pl;
		1119
		1120	my $files = aio_readdir playerdir $pl
		1121	or return;
		1122
		1123	my @paths;
		1124
		1125	for (@$files) {
		1126	utf8::decode $_;
		1127	next if /\.(?:pl|pst)$/;
		1128	next unless /^$PATH_SEP/o;
		1129
		1130	push @paths, cf::map::normalise "~$pl/$_";
		1131	}
		1132
		1133	\@paths
		1134	}
		1135
1177	=item $player->ext_reply ($msgid, $msgtype, %msg)	1136	=item $player->ext_reply ($msgid, %msg)
1178		1137
1179	Sends an ext reply to the player.	1138	Sends an ext reply to the player.
1180		1139
1181	=cut	1140	=cut
1182		1141
1183	sub ext_reply($$$%) {	1142	sub ext_reply($$%) {
1184	my ($self, $id, %msg) = @_;	1143	my ($self, $id, %msg) = @_;
1185		1144
1186	$msg{msgid} = $id;	1145	$msg{msgid} = $id;
1187		1146
1188	$self->send ("ext " . cf::to_json \%msg);	1147	$self->send ("ext " . cf::to_json \%msg);
		1148	}
		1149
		1150	=item $player->ext_event ($type, %msg)
		1151
		1152	Sends an ext event to the client.
		1153
		1154	=cut
		1155
		1156	sub ext_event($$%) {
		1157	my ($self, $type, %msg) = @_;
		1158
		1159	$self->ns->ext_event ($type, %msg);
1189	}	1160	}
1190		1161
1191	package cf;	1162	package cf;
1192		1163
1193	=back	1164	=back
…		…
1202	package cf::map;	1173	package cf::map;
1203		1174
1204	use Fcntl;	1175	use Fcntl;
1205	use Coro::AIO;	1176	use Coro::AIO;
1206		1177
		1178	use overload
		1179	'""' => \&as_string,
		1180	fallback => 1;
		1181
1207	our $MAX_RESET = 3600;	1182	our $MAX_RESET = 3600;
1208	our $DEFAULT_RESET = 3000;	1183	our $DEFAULT_RESET = 3000;
1209		1184
1210	sub generate_random_map {	1185	sub generate_random_map {
1211	my ($path, $rmp) = @_;	1186	my ($self, $rmp) = @_;
1212
1213	# mit "rum" bekleckern, nicht	1187	# mit "rum" bekleckern, nicht
1214	cf::map::_create_random_map	1188	$self->_create_random_map (
1215	$path,
1216	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1189	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1217	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1190	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1218	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1191	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1219	$rmp->{exit_on_final_map},	1192	$rmp->{exit_on_final_map},
1220	$rmp->{xsize}, $rmp->{ysize},	1193	$rmp->{xsize}, $rmp->{ysize},
1221	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1194	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1222	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1195	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1223	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1196	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1224	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1197	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1225	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1198	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1226	(cf::region::find $rmp->{region})	1199	(cf::region::find $rmp->{region}), $rmp->{custom}
		1200	)
		1201	}
		1202
		1203	=item cf::map->register ($regex, $prio)
		1204
		1205	Register a handler for the map path matching the given regex at the
		1206	givne priority (higher is better, built-in handlers have priority 0, the
		1207	default).
		1208
		1209	=cut
		1210
		1211	sub register {
		1212	my (undef, $regex, $prio) = @_;
		1213	my $pkg = caller;
		1214
		1215	no strict;
		1216	push @{"$pkg\::ISA"}, __PACKAGE__;
		1217
		1218	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1219	}
		1220
		1221	# also paths starting with '/'
		1222	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1223
		1224	sub thawer_merge {
		1225	my ($self, $merge) = @_;
		1226
		1227	# we have to keep some variables in memory intact
		1228	local $self->{path};
		1229	local $self->{load_path};
		1230	local $self->{deny_save};
		1231	local $self->{deny_reset};
		1232
		1233	$self->SUPER::thawer_merge ($merge);
		1234	}
		1235
		1236	sub normalise {
		1237	my ($path, $base) = @_;
		1238
		1239	$path = "$path"; # make sure its a string
		1240
		1241	$path =~ s/\.map$//;
		1242
		1243	# map plan:
		1244	#
		1245	# /! non-realised random map exit (special hack!)
		1246	# {... are special paths that are not being touched
		1247	# ?xxx/... are special absolute paths
		1248	# ?random/... random maps
		1249	# /... normal maps
		1250	# ~user/... per-player map of a specific user
		1251
		1252	$path =~ s/$PATH_SEP/\//go;
		1253
		1254	# treat it as relative path if it starts with
		1255	# something that looks reasonable
		1256	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1257	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1258
		1259	$base =~ s{[^/]+/?$}{};
		1260	$path = "$base/$path";
		1261	}
		1262
		1263	for ($path) {
		1264	redo if s{//}{/};
		1265	redo if s{/\.?/}{/};
		1266	redo if s{/[^/]+/\.\./}{/};
		1267	}
		1268
		1269	$path
		1270	}
		1271
		1272	sub new_from_path {
		1273	my (undef, $path, $base) = @_;
		1274
		1275	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1276
		1277	$path = normalise $path, $base;
		1278
		1279	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1280	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1281	my $self = bless cf::map::new, $pkg;
		1282	$self->{path} = $path; $self->path ($path);
		1283	$self->init; # pass $1 etc.
		1284	return $self;
		1285	}
		1286	}
		1287
		1288	Carp::carp "unable to resolve path '$path' (base '$base').";
		1289	()
		1290	}
		1291
		1292	sub init {
		1293	my ($self) = @_;
		1294
		1295	$self
		1296	}
		1297
		1298	sub as_string {
		1299	my ($self) = @_;
		1300
		1301	"$self->{path}"
		1302	}
		1303
		1304	# the displayed name, this is a one way mapping
		1305	sub visible_name {
		1306	&as_string
		1307	}
		1308
		1309	# the original (read-only) location
		1310	sub load_path {
		1311	my ($self) = @_;
		1312
		1313	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1314	}
		1315
		1316	# the temporary/swap location
		1317	sub save_path {
		1318	my ($self) = @_;
		1319
		1320	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1321	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1322	}
		1323
		1324	# the unique path, undef == no special unique path
		1325	sub uniq_path {
		1326	my ($self) = @_;
		1327
		1328	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1329	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1227	}	1330	}
1228		1331
1229	# and all this just because we cannot iterate over	1332	# and all this just because we cannot iterate over
1230	# all maps in C++...	1333	# all maps in C++...
1231	sub change_all_map_light {	1334	sub change_all_map_light {
…		…
1233		1336
1234	$_->change_map_light ($change)	1337	$_->change_map_light ($change)
1235	for grep $_->outdoor, values %cf::MAP;	1338	for grep $_->outdoor, values %cf::MAP;
1236	}	1339	}
1237		1340
		1341	sub unlink_save {
		1342	my ($self) = @_;
		1343
		1344	utf8::encode (my $save = $self->save_path);
		1345	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1346	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1347	}
		1348
1238	sub try_load_header($) {	1349	sub load_header_from($) {
1239	my ($path) = @_;	1350	my ($self, $path) = @_;
1240		1351
1241	utf8::encode $path;	1352	utf8::encode $path;
1242	aio_open $path, O_RDONLY, 0	1353	#aio_open $path, O_RDONLY, 0
		1354	# or return;
		1355
		1356	$self->_load_header ($path)
1243	or return;	1357	or return;
1244		1358
1245	my $map = cf::map::new	1359	$self->{load_path} = $path;
		1360
		1361	1
		1362	}
		1363
		1364	sub load_header_orig {
		1365	my ($self) = @_;
		1366
		1367	$self->load_header_from ($self->load_path)
		1368	}
		1369
		1370	sub load_header_temp {
		1371	my ($self) = @_;
		1372
		1373	$self->load_header_from ($self->save_path)
		1374	}
		1375
		1376	sub prepare_temp {
		1377	my ($self) = @_;
		1378
		1379	$self->last_access ((delete $self->{last_access})
		1380	|| $cf::RUNTIME); #d#
		1381	# safety
		1382	$self->{instantiate_time} = $cf::RUNTIME
		1383	if $self->{instantiate_time} > $cf::RUNTIME;
		1384	}
		1385
		1386	sub prepare_orig {
		1387	my ($self) = @_;
		1388
		1389	$self->{load_original} = 1;
		1390	$self->{instantiate_time} = $cf::RUNTIME;
		1391	$self->last_access ($cf::RUNTIME);
		1392	$self->instantiate;
		1393	}
		1394
		1395	sub load_header {
		1396	my ($self) = @_;
		1397
		1398	if ($self->load_header_temp) {
		1399	$self->prepare_temp;
		1400	} else {
		1401	$self->load_header_orig
1246	or return;	1402	or return;
		1403	$self->prepare_orig;
		1404	}
1247		1405
1248	# for better error messages only, will be overwritten	1406	1
1249	$map->path ($path);
1250
1251	$map->load_header ($path)
1252	or return;
1253
1254	$map->{load_path} = $path;
1255
1256	$map
1257	}	1407	}
1258		1408
1259	sub find;	1409	sub find;
1260	sub find {	1410	sub find {
1261	my ($path, $origin) = @_;	1411	my ($path, $origin) = @_;
1262		1412
1263	#warn "find<$path,$origin>\n";#d#
1264
1265	$path = new cf::path $path, $origin && $origin->path;	1413	$path = normalise $path, $origin && $origin->path;
1266	my $key = $path->as_string;
1267		1414
1268	cf::lock_wait "map_find:$key";	1415	cf::lock_wait "map_find:$path";
1269		1416
1270	$cf::MAP{$key} || do {	1417	$cf::MAP{$path} || do {
1271	my $guard = cf::lock_acquire "map_find:$key";	1418	my $guard = cf::lock_acquire "map_find:$path";
1272		1419	my $map = new_from_path cf::map $path
1273	# do it the slow way
1274	my $map = try_load_header $path->save_path;
1275
1276	Coro::cede;
1277
1278	if ($map) {
1279	$map->last_access ((delete $map->{last_access})
1280	|| $cf::RUNTIME); #d#
1281	# safety
1282	$map->{instantiate_time} = $cf::RUNTIME
1283	if $map->{instantiate_time} > $cf::RUNTIME;
1284	} else {
1285	if (my $rmp = $path->random_map_params) {
1286	$map = generate_random_map $key, $rmp;
1287	} else {
1288	$map = try_load_header $path->load_path;
1289	}
1290
1291	$map or return;	1420	or return;
1292		1421
1293	$map->{load_original} = 1;
1294	$map->{instantiate_time} = $cf::RUNTIME;
1295	$map->last_access ($cf::RUNTIME);
1296	$map->instantiate;
1297
1298	# per-player maps become, after loading, normal maps
1299	$map->per_player (0) if $path->{user_rel};
1300	}
1301
1302	$map->path ($key);
1303	$map->{path} = $path;
1304	$map->{last_save} = $cf::RUNTIME;	1422	$map->{last_save} = $cf::RUNTIME;
1305		1423
1306	Coro::cede;	1424	$map->load_header
		1425	or return;
1307		1426
1308	if ($map->should_reset) {	1427	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1428	# doing this can freeze the server in a sync job, obviously
		1429	#$cf::WAIT_FOR_TICK->wait;
1309	$map->reset;	1430	$map->reset;
1310	undef $guard;	1431	undef $guard;
1311	$map = find $path	1432	return find $path;
1312	or return;
1313	}	1433	}
1314		1434
1315	$cf::MAP{$key} = $map	1435	$cf::MAP{$path} = $map
1316	}	1436	}
1317	}	1437	}
		1438
		1439	sub pre_load { }
		1440	sub post_load { }
1318		1441
1319	sub load {	1442	sub load {
1320	my ($self) = @_;	1443	my ($self) = @_;
1321		1444
		1445	local $self->{deny_reset} = 1; # loading can take a long time
		1446
1322	my $path = $self->{path};	1447	my $path = $self->{path};
1323	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1448	my $guard = cf::lock_acquire "map_load:$path";
1324		1449
1325	return if $self->in_memory != cf::MAP_SWAPPED;	1450	return if $self->in_memory != cf::MAP_SWAPPED;
1326		1451
1327	$self->in_memory (cf::MAP_LOADING);	1452	$self->in_memory (cf::MAP_LOADING);
1328		1453
1329	$self->alloc;	1454	$self->alloc;
		1455
		1456	$self->pre_load;
		1457
1330	$self->load_objects ($self->{load_path}, 1)	1458	$self->_load_objects ($self->{load_path}, 1)
1331	or return;	1459	or return;
1332		1460
1333	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1461	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1334	if delete $self->{load_original};	1462	if delete $self->{load_original};
1335		1463
1336	if (my $uniq = $path->uniq_path) {	1464	if (my $uniq = $self->uniq_path) {
1337	utf8::encode $uniq;	1465	utf8::encode $uniq;
1338	if (aio_open $uniq, O_RDONLY, 0) {	1466	if (aio_open $uniq, O_RDONLY, 0) {
1339	$self->clear_unique_items;	1467	$self->clear_unique_items;
1340	$self->load_objects ($uniq, 0);	1468	$self->_load_objects ($uniq, 0);
1341	}	1469	}
1342	}	1470	}
1343		1471
1344	Coro::cede;	1472	Coro::cede;
1345		1473
1346	# now do the right thing for maps	1474	# now do the right thing for maps
1347	$self->link_multipart_objects;	1475	$self->link_multipart_objects;
1348		1476
1349	if ($self->{path}->is_style_map) {	1477	unless ($self->{deny_activate}) {
1350	$self->{deny_save} = 1;	1478	$self->decay_objects;
1351	$self->{deny_reset} = 1;
1352	} else {
1353	$self->fix_auto_apply;	1479	$self->fix_auto_apply;
1354	$self->decay_objects;
1355	$self->update_buttons;	1480	$self->update_buttons;
		1481	Coro::cede;
1356	$self->set_darkness_map;	1482	$self->set_darkness_map;
1357	$self->difficulty ($self->estimate_difficulty)	1483	$self->difficulty ($self->estimate_difficulty)
1358	unless $self->difficulty;	1484	unless $self->difficulty;
		1485	Coro::cede;
1359	$self->activate;	1486	$self->activate;
1360	}	1487	}
1361		1488
1362	Coro::cede;	1489	$self->post_load;
1363		1490
1364	$self->in_memory (cf::MAP_IN_MEMORY);	1491	$self->in_memory (cf::MAP_IN_MEMORY);
		1492	}
		1493
		1494	sub customise_for {
		1495	my ($self, $ob) = @_;
		1496
		1497	return find "~" . $ob->name . "/" . $self->{path}
		1498	if $self->per_player;
		1499
		1500	$self
		1501	}
		1502
		1503	# find and load all maps in the 3x3 area around a map
		1504	sub load_diag {
		1505	my ($map) = @_;
		1506
		1507	my @diag; # diagonal neighbours
		1508
		1509	for (0 .. 3) {
		1510	my $neigh = $map->tile_path ($_)
		1511	or next;
		1512	$neigh = find $neigh, $map
		1513	or next;
		1514	$neigh->load;
		1515
		1516	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1517	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1518	}
		1519
		1520	for (@diag) {
		1521	my $neigh = find @$_
		1522	or next;
		1523	$neigh->load;
		1524	}
1365	}	1525	}
1366		1526
1367	sub find_sync {	1527	sub find_sync {
1368	my ($path, $origin) = @_;	1528	my ($path, $origin) = @_;
1369		1529
1370	cf::sync_job { cf::map::find $path, $origin }	1530	cf::sync_job { find $path, $origin }
1371	}	1531	}
1372		1532
1373	sub do_load_sync {	1533	sub do_load_sync {
1374	my ($map) = @_;	1534	my ($map) = @_;
1375		1535
1376	cf::sync_job { $map->load };	1536	cf::sync_job { $map->load };
1377	}	1537	}
1378		1538
		1539	our %MAP_PREFETCH;
		1540	our $MAP_PREFETCHER = undef;
		1541
		1542	sub find_async {
		1543	my ($path, $origin) = @_;
		1544
		1545	$path = normalise $path, $origin && $origin->{path};
		1546
		1547	if (my $map = $cf::MAP{$path}) {
		1548	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1549	}
		1550
		1551	undef $MAP_PREFETCH{$path};
		1552	$MAP_PREFETCHER ||= cf::async {
		1553	while (%MAP_PREFETCH) {
		1554	for my $path (keys %MAP_PREFETCH) {
		1555	my $map = find $path
		1556	or next;
		1557	$map->load;
		1558
		1559	delete $MAP_PREFETCH{$path};
		1560	}
		1561	}
		1562	undef $MAP_PREFETCHER;
		1563	};
		1564	$MAP_PREFETCHER->prio (6);
		1565
		1566	()
		1567	}
		1568
1379	sub save {	1569	sub save {
1380	my ($self) = @_;	1570	my ($self) = @_;
1381		1571
1382	my $lock = cf::lock_acquire "map_data:" . $self->path;	1572	my $lock = cf::lock_acquire "map_data:" . $self->path;
1383		1573
1384	$self->{last_save} = $cf::RUNTIME;	1574	$self->{last_save} = $cf::RUNTIME;
1385		1575
1386	return unless $self->dirty;	1576	return unless $self->dirty;
1387		1577
1388	my $save = $self->{path}->save_path; utf8::encode $save;	1578	my $save = $self->save_path; utf8::encode $save;
1389	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1579	my $uniq = $self->uniq_path; utf8::encode $uniq;
1390		1580
1391	$self->{load_path} = $save;	1581	$self->{load_path} = $save;
1392		1582
1393	return if $self->{deny_save};	1583	return if $self->{deny_save};
1394		1584
…		…
1397	cf::async {	1587	cf::async {
1398	$_->contr->save for $self->players;	1588	$_->contr->save for $self->players;
1399	};	1589	};
1400		1590
1401	if ($uniq) {	1591	if ($uniq) {
1402	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1592	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1403	$self->save_objects ($uniq, cf::IO_UNIQUES);	1593	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1404	} else {	1594	} else {
1405	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1595	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1406	}	1596	}
1407	}	1597	}
1408		1598
1409	sub swap_out {	1599	sub swap_out {
1410	my ($self) = @_;	1600	my ($self) = @_;
…		…
1424		1614
1425	sub reset_at {	1615	sub reset_at {
1426	my ($self) = @_;	1616	my ($self) = @_;
1427		1617
1428	# TODO: safety, remove and allow resettable per-player maps	1618	# TODO: safety, remove and allow resettable per-player maps
1429	return 1e99 if $self->{path}{user_rel};	1619	return 1e99 if $self->isa ("ext::map_per_player");#d#
1430	return 1e99 if $self->{deny_reset};	1620	return 1e99 if $self->{deny_reset};
1431		1621
1432	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1622	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1433	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1623	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1434		1624
…		…
1439	my ($self) = @_;	1629	my ($self) = @_;
1440		1630
1441	$self->reset_at <= $cf::RUNTIME	1631	$self->reset_at <= $cf::RUNTIME
1442	}	1632	}
1443		1633
1444	sub unlink_save {
1445	my ($self) = @_;
1446
1447	utf8::encode (my $save = $self->{path}->save_path);
1448	aioreq_pri 3; IO::AIO::aio_unlink $save;
1449	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1450	}
1451
1452	sub rename {
1453	my ($self, $new_path) = @_;
1454
1455	$self->unlink_save;
1456
1457	delete $cf::MAP{$self->path};
1458	$self->{path} = new cf::path $new_path;
1459	$self->path ($self->{path}->as_string);
1460	$cf::MAP{$self->path} = $self;
1461
1462	$self->save;
1463	}
1464
1465	sub reset {	1634	sub reset {
1466	my ($self) = @_;	1635	my ($self) = @_;
1467		1636
1468	my $lock = cf::lock_acquire "map_data:" . $self->path;	1637	my $lock = cf::lock_acquire "map_data:$self->{path}";
1469		1638
1470	return if $self->players;	1639	return if $self->players;
1471	return if $self->{path}{user_rel};#d#	1640	return if $self->isa ("ext::map_per_player");#d#
1472		1641
1473	warn "resetting map ", $self->path;#d#	1642	warn "resetting map ", $self->path;#d#
1474		1643
		1644	$self->in_memory (cf::MAP_SWAPPED);
		1645
		1646	# need to save uniques path
		1647	unless ($self->{deny_save}) {
		1648	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1649
		1650	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1651	if $uniq;
		1652	}
		1653
1475	delete $cf::MAP{$self->path};	1654	delete $cf::MAP{$self->path};
		1655
		1656	$self->clear;
1476		1657
1477	$_->clear_links_to ($self) for values %cf::MAP;	1658	$_->clear_links_to ($self) for values %cf::MAP;
1478		1659
1479	$self->unlink_save;	1660	$self->unlink_save;
1480	$self->destroy;	1661	$self->destroy;
…		…
1483	my $nuke_counter = "aaaa";	1664	my $nuke_counter = "aaaa";
1484		1665
1485	sub nuke {	1666	sub nuke {
1486	my ($self) = @_;	1667	my ($self) = @_;
1487		1668
		1669	delete $cf::MAP{$self->path};
		1670
		1671	$self->unlink_save;
		1672
		1673	bless $self, "cf::map";
		1674	delete $self->{deny_reset};
1488	$self->{deny_save} = 1;	1675	$self->{deny_save} = 1;
1489	$self->reset_timeout (1);	1676	$self->reset_timeout (1);
1490	$self->rename ("{nuke}/" . ($nuke_counter++));	1677	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1678
		1679	$cf::MAP{$self->path} = $self;
		1680
1491	$self->reset; # polite request, might not happen	1681	$self->reset; # polite request, might not happen
1492	}	1682	}
1493		1683
1494	sub customise_for {	1684	=item cf::map::unique_maps
1495	my ($map, $ob) = @_;
1496		1685
1497	if ($map->per_player) {	1686	Returns an arrayref of paths of all shared maps that have
1498	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	1687	instantiated unique items. May block.
1499	}
1500		1688
1501	$map	1689	=cut
1502	}
1503		1690
1504	sub emergency_save {	1691	sub unique_maps() {
1505	my $freeze_guard = cf::freeze_mainloop;	1692	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1693	or return;
1506		1694
1507	warn "enter emergency perl save\n";	1695	my @paths;
1508		1696
1509	cf::sync_job {	1697	for (@$files) {
1510	warn "begin emergency player save\n";	1698	utf8::decode $_;
1511	$_->save for values %cf::PLAYER;	1699	next if /\.pst$/;
1512	warn "end emergency player save\n";	1700	next unless /^$PATH_SEP/o;
1513		1701
1514	warn "begin emergency map save\n";	1702	push @paths, cf::map::normalise $_;
1515	$_->save for values %cf::MAP;
1516	warn "end emergency map save\n";
1517	};	1703	}
1518		1704
1519	warn "leave emergency perl save\n";	1705	\@paths
1520	}	1706	}
1521		1707
1522	package cf;	1708	package cf;
1523		1709
1524	=back	1710	=back
1525		1711
		1712	=head3 cf::object
		1713
		1714	=cut
		1715
		1716	package cf::object;
		1717
		1718	=over 4
		1719
		1720	=item $ob->inv_recursive
		1721
		1722	Returns the inventory of the object _and_ their inventories, recursively.
		1723
		1724	=cut
		1725
		1726	sub inv_recursive_;
		1727	sub inv_recursive_ {
		1728	map { $_, inv_recursive_ $_->inv } @_
		1729	}
		1730
		1731	sub inv_recursive {
		1732	inv_recursive_ inv $_[0]
		1733	}
		1734
		1735	package cf;
		1736
		1737	=back
1526		1738
1527	=head3 cf::object::player	1739	=head3 cf::object::player
1528		1740
1529	=over 4	1741	=over 4
1530		1742
…		…
1570		1782
1571	=item $player_object->enter_link	1783	=item $player_object->enter_link
1572		1784
1573	Freezes the player and moves him/her to a special map (C<{link}>).	1785	Freezes the player and moves him/her to a special map (C<{link}>).
1574		1786
1575	The player should be reaosnably safe there for short amounts of time. You	1787	The player should be reasonably safe there for short amounts of time. You
1576	I<MUST> call C<leave_link> as soon as possible, though.	1788	I<MUST> call C<leave_link> as soon as possible, though.
1577		1789
		1790	Will never block.
		1791
1578	=item $player_object->leave_link ($map, $x, $y)	1792	=item $player_object->leave_link ($map, $x, $y)
1579		1793
1580	Moves the player out of the specila link map onto the given map. If the	1794	Moves the player out of the special C<{link}> map onto the specified
1581	map is not valid (or omitted), the player will be moved back to the	1795	map. If the map is not valid (or omitted), the player will be moved back
1582	location he/she was before the call to C<enter_link>, or, if that fails,	1796	to the location he/she was before the call to C<enter_link>, or, if that
1583	to the emergency map position.	1797	fails, to the emergency map position.
1584		1798
1585	Might block.	1799	Might block.
1586		1800
1587	=cut	1801	=cut
		1802
		1803	sub link_map {
		1804	unless ($LINK_MAP) {
		1805	$LINK_MAP = cf::map::find "{link}"
		1806	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1807	$LINK_MAP->load;
		1808	}
		1809
		1810	$LINK_MAP
		1811	}
1588		1812
1589	sub cf::object::player::enter_link {	1813	sub cf::object::player::enter_link {
1590	my ($self) = @_;	1814	my ($self) = @_;
1591		1815
1592	$self->deactivate_recursive;	1816	$self->deactivate_recursive;
1593		1817
1594	return if $self->map == $LINK_MAP;	1818	return if UNIVERSAL::isa $self->map, "ext::map_link";
1595		1819
1596	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1820	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1597	if $self->map;	1821	if $self->map;
1598		1822
1599	$self->enter_map ($LINK_MAP, 20, 20);	1823	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1600	}	1824	}
1601		1825
1602	sub cf::object::player::leave_link {	1826	sub cf::object::player::leave_link {
1603	my ($self, $map, $x, $y) = @_;	1827	my ($self, $map, $x, $y) = @_;
1604		1828
…		…
1622	# use -1 or undef as default coordinates, not 0, 0	1846	# use -1 or undef as default coordinates, not 0, 0
1623	($x, $y) = ($map->enter_x, $map->enter_y)	1847	($x, $y) = ($map->enter_x, $map->enter_y)
1624	if $x <=0 && $y <= 0;	1848	if $x <=0 && $y <= 0;
1625		1849
1626	$map->load;	1850	$map->load;
		1851	$map->load_diag;
1627		1852
1628	return unless $self->contr->active;	1853	return unless $self->contr->active;
1629	$self->activate_recursive;	1854	$self->activate_recursive;
		1855
		1856	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1630	$self->enter_map ($map, $x, $y);	1857	$self->enter_map ($map, $x, $y);
1631	}	1858	}
1632		1859
1633	cf::player->attach (	1860	cf::player->attach (
1634	on_logout => sub {	1861	on_logout => sub {
…		…
1647	# try to abort aborted map switching on player login :)	1874	# try to abort aborted map switching on player login :)
1648	# should happen only on crashes	1875	# should happen only on crashes
1649	if ($pl->ob->{_link_pos}) {	1876	if ($pl->ob->{_link_pos}) {
1650	$pl->ob->enter_link;	1877	$pl->ob->enter_link;
1651	(async {	1878	(async {
1652	# we need this sleep as the login has a concurrent enter_exit running
1653	# and this sleep increases chances of the player not ending up in scorn
1654	$pl->ob->reply (undef,	1879	$pl->ob->reply (undef,
1655	"There was an internal problem at your last logout, "	1880	"There was an internal problem at your last logout, "
1656	. "the server will try to bring you to your intended destination in a second.",	1881	. "the server will try to bring you to your intended destination in a second.",
1657	cf::NDI_RED);	1882	cf::NDI_RED);
		1883	# we need this sleep as the login has a concurrent enter_exit running
		1884	# and this sleep increases chances of the player not ending up in scorn
1658	Coro::Timer::sleep 1;	1885	Coro::Timer::sleep 1;
1659	$pl->ob->leave_link;	1886	$pl->ob->leave_link;
1660	})->prio (2);	1887	})->prio (2);
1661	}	1888	}
1662	},	1889	},
…		…
1670	my ($self, $path, $x, $y) = @_;	1897	my ($self, $path, $x, $y) = @_;
1671		1898
1672	$self->enter_link;	1899	$self->enter_link;
1673		1900
1674	(async {	1901	(async {
1675	$path = new cf::path $path;	1902	my $map = eval {
1676
1677	my $map = cf::map::find $path->as_string;	1903	my $map = cf::map::find $path;
1678	$map = $map->customise_for ($self) if $map;	1904	$map = $map->customise_for ($self) if $map;
1679		1905	$map
1680	# warn "entering ", $map->path, " at ($x, $y)\n"	1906	} or
1681	# if $map;
1682
1683	$map or $map->cluck ("oy");#d#
1684	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);	1907	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1685		1908
1686	$self->leave_link ($map, $x, $y);	1909	$self->leave_link ($map, $x, $y);
1687	})->prio (1);	1910	})->prio (1);
1688	}	1911	}
1689		1912
…		…
1693		1916
1694	sub parse_random_map_params {	1917	sub parse_random_map_params {
1695	my ($spec) = @_;	1918	my ($spec) = @_;
1696		1919
1697	my $rmp = { # defaults	1920	my $rmp = { # defaults
1698	xsize => 10,	1921	xsize => (cf::rndm 15, 40),
1699	ysize => 10,	1922	ysize => (cf::rndm 15, 40),
		1923	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1924	#layout => string,
1700	};	1925	};
1701		1926
1702	for (split /\n/, $spec) {	1927	for (split /\n/, $spec) {
1703	my ($k, $v) = split /\s+/, $_, 2;	1928	my ($k, $v) = split /\s+/, $_, 2;
1704		1929
…		…
1708	$rmp	1933	$rmp
1709	}	1934	}
1710		1935
1711	sub prepare_random_map {	1936	sub prepare_random_map {
1712	my ($exit) = @_;	1937	my ($exit) = @_;
		1938
		1939	my $guard = cf::lock_acquire "exit_prepare:$exit";
1713		1940
1714	# all this does is basically replace the /! path by	1941	# all this does is basically replace the /! path by
1715	# a new random map path (?random/...) with a seed	1942	# a new random map path (?random/...) with a seed
1716	# that depends on the exit object	1943	# that depends on the exit object
1717		1944
1718	my $rmp = parse_random_map_params $exit->msg;	1945	my $rmp = parse_random_map_params $exit->msg;
1719		1946
1720	if ($exit->map) {	1947	if ($exit->map) {
1721	$rmp->{region} = $exit->map->region_name;	1948	$rmp->{region} = $exit->region->name;
1722	$rmp->{origin_map} = $exit->map->path;	1949	$rmp->{origin_map} = $exit->map->path;
1723	$rmp->{origin_x} = $exit->x;	1950	$rmp->{origin_x} = $exit->x;
1724	$rmp->{origin_y} = $exit->y;	1951	$rmp->{origin_y} = $exit->y;
1725	}	1952	}
1726		1953
1727	$rmp->{random_seed} ||= $exit->random_seed;	1954	$rmp->{random_seed} ||= $exit->random_seed;
1728		1955
1729	my $data = cf::to_json $rmp;	1956	my $data = cf::to_json $rmp;
1730	my $md5 = Digest::MD5::md5_hex $data;	1957	my $md5 = Digest::MD5::md5_hex $data;
		1958	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1731		1959
1732	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	1960	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1733	aio_write $fh, 0, (length $data), $data, 0;	1961	aio_write $fh, 0, (length $data), $data, 0;
		1962	undef $fh;
		1963	aio_rename "$meta~", $meta;
1734		1964
1735	$exit->slaying ("?random/$md5");	1965	$exit->slaying ("?random/$md5");
1736	$exit->msg (undef);	1966	$exit->msg (undef);
1737	}	1967	}
1738	}	1968	}
1739		1969
1740	sub cf::object::player::enter_exit {	1970	sub cf::object::player::enter_exit {
1741	my ($self, $exit) = @_;	1971	my ($self, $exit) = @_;
1742		1972
1743	return unless $self->type == cf::PLAYER;	1973	return unless $self->type == cf::PLAYER;
		1974
		1975	if ($exit->slaying eq "/!") {
		1976	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1977	# the problem is that $exit might not survive long enough
		1978	# so it needs to be done right now, right here
		1979	cf::sync_job { prepare_random_map $exit };
		1980	}
		1981
		1982	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1983	my $hp = $exit->stats->hp;
		1984	my $sp = $exit->stats->sp;
1744		1985
1745	$self->enter_link;	1986	$self->enter_link;
1746		1987
1747	(async {	1988	(async {
1748	$self->deactivate_recursive; # just to be sure	1989	$self->deactivate_recursive; # just to be sure
1749	unless (eval {	1990	unless (eval {
1750	prepare_random_map $exit	1991	$self->goto ($slaying, $hp, $sp);
1751	if $exit->slaying eq "/!";
1752
1753	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1754	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1755		1992
1756	1;	1993	1;
1757	}) {	1994	}) {
1758	$self->message ("Something went wrong deep within the crossfire server. "	1995	$self->message ("Something went wrong deep within the crossfire server. "
1759	. "I'll try to bring you back to the map you were before. "	1996	. "I'll try to bring you back to the map you were before. "
1760	. "Please report this to the dungeon master",	1997	. "Please report this to the dungeon master!",
1761	cf::NDI_UNIQUE | cf::NDI_RED);	1998	cf::NDI_UNIQUE | cf::NDI_RED);
1762		1999
1763	warn "ERROR in enter_exit: $@";	2000	warn "ERROR in enter_exit: $@";
1764	$self->leave_link;	2001	$self->leave_link;
1765	}	2002	}
1766	})->prio (1);	2003	})->prio (1);
…		…
1779		2016
1780	sub cf::client::send_drawinfo {	2017	sub cf::client::send_drawinfo {
1781	my ($self, $text, $flags) = @_;	2018	my ($self, $text, $flags) = @_;
1782		2019
1783	utf8::encode $text;	2020	utf8::encode $text;
1784	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2021	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1785	}	2022	}
1786		2023
		2024	=item $client->ext_event ($type, %msg)
		2025
		2026	Sends an exti event to the client.
		2027
		2028	=cut
		2029
		2030	sub cf::client::ext_event($$%) {
		2031	my ($self, $type, %msg) = @_;
		2032
		2033	$msg{msgtype} = "event_$type";
		2034	$self->send_packet ("ext " . cf::to_json \%msg);
		2035	}
1787		2036
1788	=item $success = $client->query ($flags, "text", \&cb)	2037	=item $success = $client->query ($flags, "text", \&cb)
1789		2038
1790	Queues a query to the client, calling the given callback with	2039	Queues a query to the client, calling the given callback with
1791	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2040	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1820	# get handled first	2069	# get handled first
1821	my $queue = delete $ns->{query_queue}	2070	my $queue = delete $ns->{query_queue}
1822	or return; # be conservative, not sure how that can happen, but we saw a crash here	2071	or return; # be conservative, not sure how that can happen, but we saw a crash here
1823		2072
1824	(shift @$queue)->[1]->($msg);	2073	(shift @$queue)->[1]->($msg);
		2074	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1825		2075
1826	push @{ $ns->{query_queue} }, @$queue;	2076	push @{ $ns->{query_queue} }, @$queue;
1827		2077
1828	if (@{ $ns->{query_queue} } == @$queue) {	2078	if (@{ $ns->{query_queue} } == @$queue) {
1829	if (@$queue) {	2079	if (@$queue) {
…		…
1887		2137
1888	# here we export the classes and methods available to script code	2138	# here we export the classes and methods available to script code
1889		2139
1890	=pod	2140	=pod
1891		2141
1892	The following fucntions and emthods are available within a safe environment:	2142	The following functions and methods are available within a safe environment:
1893		2143
1894	cf::object contr pay_amount pay_player map	2144	cf::object contr pay_amount pay_player map
1895	cf::object::player player	2145	cf::object::player player
1896	cf::player peaceful	2146	cf::player peaceful
1897	cf::map trigger	2147	cf::map trigger
…		…
1990	The parameter C<$family> should best start with the name of the extension	2240	The parameter C<$family> should best start with the name of the extension
1991	using it, it should be unique.	2241	using it, it should be unique.
1992		2242
1993	=over 4	2243	=over 4
1994		2244
1995	=item $hashref = cf::db_get $family
1996
1997	Return a hashref for use by the extension C<$family>, which can be
1998	modified. After modifications, you have to call C<cf::db_dirty> or
1999	C<cf::db_sync>.
2000
2001	=item $value = cf::db_get $family => $key	2245	=item $value = cf::db_get $family => $key
2002		2246
2003	Returns a single value from the database	2247	Returns a single value from the database.
2004
2005	=item cf::db_put $family => $hashref
2006
2007	Stores the given family hashref into the database. Updates are delayed, if
2008	you want the data to be synced to disk immediately, use C<cf::db_sync>.
2009		2248
2010	=item cf::db_put $family => $key => $value	2249	=item cf::db_put $family => $key => $value
2011		2250
2012	Stores the given C<$value> in the family hash. Updates are delayed, if you	2251	Stores the given C<$value> in the family.
2013	want the data to be synced to disk immediately, use C<cf::db_sync>.
2014
2015	=item cf::db_dirty
2016
2017	Marks the database as dirty, to be updated at a later time.
2018
2019	=item cf::db_sync
2020
2021	Immediately write the database to disk I<if it is dirty>.
2022		2252
2023	=cut	2253	=cut
2024		2254
2025	our $DB;	2255	our $DB;
2026		2256
2027	{	2257	sub db_init {
		2258	unless ($DB) {
		2259	$DB = BDB::db_create $DB_ENV;
		2260
		2261	cf::sync_job {
		2262	eval {
		2263	$DB->set_flags (BDB::CHKSUM);
		2264
		2265	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2266	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2267	cf::cleanup "db_open(db): $!" if $!;
		2268	};
		2269	cf::cleanup "db_open(db): $@" if $@;
		2270	};
		2271
2028	my $path = cf::localdir . "/database.pst";	2272	my $path = cf::localdir . "/database.pst";
		2273	if (stat $path) {
		2274	cf::sync_job {
		2275	my $pst = Storable::retrieve $path;
2029		2276
2030	sub db_load() {	2277	cf::db_put (board => data => $pst->{board});
2031	$DB = stat $path ? Storable::retrieve $path : { };	2278	cf::db_put (guildrules => data => $pst->{guildrules});
2032	}	2279	cf::db_put (rent => balance => $pst->{rent}{balance});
		2280	BDB::db_env_txn_checkpoint $DB_ENV;
2033		2281
2034	my $pid;	2282	unlink $path;
2035
2036	sub db_save() {
2037	waitpid $pid, 0 if $pid;
2038	if (0 == ($pid = fork)) {
2039	$DB->{_meta}{version} = 1;
2040	Storable::nstore $DB, "$path~";
2041	rename "$path~", $path;
2042	cf::_exit 0 if defined $pid;
2043	}	2283	};
2044	}	2284	}
2045
2046	my $dirty;
2047
2048	sub db_sync() {
2049	db_save if $dirty;
2050	undef $dirty;
2051	}
2052
2053	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2054	db_sync;
2055	});	2285	}
		2286	}
2056		2287
2057	sub db_dirty() {
2058	$dirty = 1;
2059	$idle->start;
2060	}
2061
2062	sub db_get($;$) {	2288	sub db_get($$) {
2063	@_ >= 2	2289	my $key = "$_[0]/$_[1]";
2064	? $DB->{$_[0]}{$_[1]}
2065	: ($DB->{$_[0]} ||= { })
2066	}
2067		2290
		2291	cf::sync_job {
		2292	BDB::db_get $DB, undef, $key, my $data;
		2293
		2294	$! ? ()
		2295	: Compress::LZF::sthaw $data
		2296	}
		2297	}
		2298
2068	sub db_put($$;$) {	2299	sub db_put($$$) {
2069	if (@_ >= 3) {	2300	BDB::dbreq_pri 4;
2070	$DB->{$_[0]}{$_[1]} = $_[2];	2301	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
		2302	}
		2303
		2304	#############################################################################
		2305	# the server's init and main functions
		2306
		2307	sub load_facedata {
		2308	my $path = sprintf "%s/facedata", cf::datadir;
		2309
		2310	warn "loading facedata from $path\n";
		2311
		2312	my $faces;
		2313	0 < aio_load $path, $faces
		2314	or die "$path: $!";
		2315
		2316	Coro::cede;
		2317	$faces = Storable::thaw $faces;
		2318	Coro::cede;
		2319
		2320	my $meta = delete $faces->{""};
		2321	$meta->{version} == 1
		2322	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2323
		2324	while (my ($face, $info) = each %$faces) {
		2325	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2326	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2327	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2328	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2329	Coro::cede;
		2330	}
		2331
		2332	while (my ($face, $info) = each %$faces) {
		2333	next unless $info->{smooth};
		2334	my $idx = cf::face::find $face
		2335	or next;
		2336	if (my $smooth = cf::face::find $info->{smooth}) {
		2337	cf::face::set_smooth $idx, $smooth;
2071	} else {	2338	} else {
2072	$DB->{$_[0]} = $_[1];	2339	warn "smooth face '$info->{smooth}' not found for face '$face'";
2073	}
2074	db_dirty;
2075	}
2076
2077	cf::global->attach (
2078	prio => 10000,
2079	on_cleanup => sub {
2080	db_sync;
2081	},	2340	}
2082	);	2341	Coro::cede;
2083	}	2342	}
2084		2343
2085	#############################################################################	2344	1
2086	# the server's main()	2345	}
		2346
		2347	sub reload_resources {
		2348	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2349	or die "unable to load regions file\n";#d#
		2350	load_facedata
		2351	or die "unable to load facedata\n";#d#
		2352	}
		2353
		2354	sub init {
		2355	reload_resources;
		2356	}
2087		2357
2088	sub cfg_load {	2358	sub cfg_load {
2089	open my $fh, "<:utf8", cf::confdir . "/config"	2359	open my $fh, "<:utf8", cf::confdir . "/config"
2090	or return;	2360	or return;
2091		2361
…		…
2108		2378
2109	sub main {	2379	sub main {
2110	# we must not ever block the main coroutine	2380	# we must not ever block the main coroutine
2111	local $Coro::idle = sub {	2381	local $Coro::idle = sub {
2112	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2382	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2383	(async {
2113	async { Event::one_event };	2384	Event::one_event;
		2385	})->prio (Coro::PRIO_MAX);
2114	};	2386	};
2115		2387
2116	cfg_load;	2388	cfg_load;
2117	db_load;	2389	db_init;
2118	load_extensions;	2390	load_extensions;
		2391
		2392	$TICK_WATCHER->start;
2119	Event::loop;	2393	Event::loop;
2120	}	2394	}
2121		2395
2122	#############################################################################	2396	#############################################################################
2123	# initialisation	2397	# initialisation and cleanup
		2398
		2399	# install some emergency cleanup handlers
		2400	BEGIN {
		2401	for my $signal (qw(INT HUP TERM)) {
		2402	Event->signal (
		2403	reentrant => 0,
		2404	data => WF_AUTOCANCEL,
		2405	signal => $signal,
		2406	prio => 0,
		2407	cb => sub {
		2408	cf::cleanup "SIG$signal";
		2409	},
		2410	);
		2411	}
		2412	}
		2413
		2414	sub emergency_save() {
		2415	my $freeze_guard = cf::freeze_mainloop;
		2416
		2417	warn "enter emergency perl save\n";
		2418
		2419	cf::sync_job {
		2420	# use a peculiar iteration method to avoid tripping on perl
		2421	# refcount bugs in for. also avoids problems with players
		2422	# and maps saved/destroyed asynchronously.
		2423	warn "begin emergency player save\n";
		2424	for my $login (keys %cf::PLAYER) {
		2425	my $pl = $cf::PLAYER{$login} or next;
		2426	$pl->valid or next;
		2427	$pl->save;
		2428	}
		2429	warn "end emergency player save\n";
		2430
		2431	warn "begin emergency map save\n";
		2432	for my $path (keys %cf::MAP) {
		2433	my $map = $cf::MAP{$path} or next;
		2434	$map->valid or next;
		2435	$map->save;
		2436	}
		2437	warn "end emergency map save\n";
		2438
		2439	warn "begin emergency database checkpoint\n";
		2440	BDB::db_env_txn_checkpoint $DB_ENV;
		2441	warn "end emergency database checkpoint\n";
		2442	};
		2443
		2444	warn "leave emergency perl save\n";
		2445	}
		2446
		2447	sub post_cleanup {
		2448	my ($make_core) = @_;
		2449
		2450	warn Carp::longmess "post_cleanup backtrace"
		2451	if $make_core;
		2452	}
2124		2453
2125	sub reload() {	2454	sub reload() {
2126	# can/must only be called in main	2455	# can/must only be called in main
2127	if ($Coro::current != $Coro::main) {	2456	if ($Coro::current != $Coro::main) {
2128	warn "can only reload from main coroutine\n";	2457	warn "can only reload from main coroutine";
2129	return;	2458	return;
2130	}	2459	}
2131		2460
2132	warn "reloading...";	2461	warn "reloading...";
2133		2462
2134	my $guard = freeze_mainloop;	2463	warn "entering sync_job";
		2464
		2465	cf::sync_job {
		2466	cf::write_runtime; # external watchdog should not bark
2135	cf::emergency_save;	2467	cf::emergency_save;
		2468	cf::write_runtime; # external watchdog should not bark
2136		2469
2137	eval {	2470	warn "syncing database to disk";
		2471	BDB::db_env_txn_checkpoint $DB_ENV;
		2472
2138	# if anything goes wrong in here, we should simply crash as we already saved	2473	# if anything goes wrong in here, we should simply crash as we already saved
2139		2474
2140	# cancel all watchers	2475	warn "cancelling all WF_AUTOCANCEL watchers";
2141	for (Event::all_watchers) {	2476	for (Event::all_watchers) {
2142	$_->cancel if $_->data & WF_AUTOCANCEL;	2477	$_->cancel if $_->data & WF_AUTOCANCEL;
2143	}	2478	}
2144		2479
		2480	warn "flushing outstanding aio requests";
		2481	for (;;) {
		2482	BDB::flush;
		2483	IO::AIO::flush;
		2484	Coro::cede;
		2485	last unless IO::AIO::nreqs || BDB::nreqs;
		2486	warn "iterate...";
		2487	}
		2488
		2489	++$RELOAD;
		2490
2145	# cancel all extension coros	2491	warn "cancelling all extension coros";
2146	$_->cancel for values %EXT_CORO;	2492	$_->cancel for values %EXT_CORO;
2147	%EXT_CORO = ();	2493	%EXT_CORO = ();
2148		2494
2149	# unload all extensions	2495	warn "removing commands";
2150	for (@exts) {	2496	%COMMAND = ();
		2497
		2498	warn "removing ext commands";
		2499	%EXTCMD = ();
		2500
		2501	warn "unloading/nuking all extensions";
		2502	for my $pkg (@EXTS) {
2151	warn "unloading <$_>";	2503	warn "... unloading $pkg";
2152	unload_extension $_;	2504
		2505	if (my $cb = $pkg->can ("unload")) {
		2506	eval {
		2507	$cb->($pkg);
		2508	1
		2509	} or warn "$pkg unloaded, but with errors: $@";
2153	}	2510	}
2154		2511
		2512	warn "... nuking $pkg";
		2513	Symbol::delete_package $pkg;
		2514	}
		2515
2155	# unload all modules loaded from $LIBDIR	2516	warn "unloading all perl modules loaded from $LIBDIR";
2156	while (my ($k, $v) = each %INC) {	2517	while (my ($k, $v) = each %INC) {
2157	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2518	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2158		2519
2159	warn "removing <$k>";	2520	warn "... unloading $k";
2160	delete $INC{$k};	2521	delete $INC{$k};
2161		2522
2162	$k =~ s/\.pm$//;	2523	$k =~ s/\.pm$//;
2163	$k =~ s/\//::/g;	2524	$k =~ s/\//::/g;
2164		2525
…		…
2167	}	2528	}
2168		2529
2169	Symbol::delete_package $k;	2530	Symbol::delete_package $k;
2170	}	2531	}
2171		2532
2172	# sync database to disk
2173	cf::db_sync;
2174	IO::AIO::flush;
2175
2176	# get rid of safe::, as good as possible	2533	warn "getting rid of safe::, as good as possible";
2177	Symbol::delete_package "safe::$_"	2534	Symbol::delete_package "safe::$_"
2178	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2535	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2179		2536
2180	# remove register_script_function callbacks
2181	# TODO
2182
2183	# unload cf.pm "a bit"	2537	warn "unloading cf.pm \"a bit\"";
2184	delete $INC{"cf.pm"};	2538	delete $INC{"cf.pm"};
2185		2539
2186	# don't, removes xs symbols, too,	2540	# don't, removes xs symbols, too,
2187	# and global variables created in xs	2541	# and global variables created in xs
2188	#Symbol::delete_package __PACKAGE__;	2542	#Symbol::delete_package __PACKAGE__;
2189		2543
2190	# reload cf.pm	2544	warn "unload completed, starting to reload now";
		2545
2191	warn "reloading cf.pm";	2546	warn "reloading cf.pm";
2192	require cf;	2547	require cf;
2193	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2548	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2194		2549
2195	# load config and database again	2550	warn "loading config and database again";
2196	cf::cfg_load;	2551	cf::cfg_load;
2197	cf::db_load;
2198		2552
2199	# load extensions
2200	warn "load extensions";	2553	warn "loading extensions";
2201	cf::load_extensions;	2554	cf::load_extensions;
2202		2555
2203	# reattach attachments to objects	2556	warn "reattaching attachments to objects/players";
2204	warn "reattach";	2557	_global_reattach; # objects, sockets
2205	_global_reattach;	2558	warn "reattaching attachments to maps";
2206	reattach $_ for values %MAP;	2559	reattach $_ for values %MAP;
2207	};	2560	warn "reattaching attachments to players";
		2561	reattach $_ for values %PLAYER;
2208		2562
2209	if ($@) {	2563	warn "loading reloadable resources";
		2564	reload_resources;
		2565
		2566	warn "leaving sync_job";
		2567
		2568	1
		2569	} or do {
2210	warn $@;	2570	warn $@;
2211	warn "error while reloading, exiting.";	2571	warn "error while reloading, exiting.";
2212	exit 1;	2572	exit 1;
2213	}	2573	};
2214		2574
2215	warn "reloaded successfully";	2575	warn "reloaded";
2216	};	2576	};
2217		2577
2218	#############################################################################	2578	our $RELOAD_WATCHER; # used only during reload
2219
2220	unless ($LINK_MAP) {
2221	$LINK_MAP = cf::map::new;
2222
2223	$LINK_MAP->width (41);
2224	$LINK_MAP->height (41);
2225	$LINK_MAP->alloc;
2226	$LINK_MAP->path ("{link}");
2227	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2228	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2229
2230	# dirty hack because... archetypes are not yet loaded
2231	Event->timer (
2232	after => 10,
2233	cb => sub {
2234	$_[0]->w->cancel;
2235
2236	# provide some exits "home"
2237	my $exit = cf::object::new "exit";
2238
2239	$exit->slaying ($EMERGENCY_POSITION->[0]);
2240	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2241	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2242
2243	$LINK_MAP->insert ($exit->clone, 19, 19);
2244	$LINK_MAP->insert ($exit->clone, 19, 20);
2245	$LINK_MAP->insert ($exit->clone, 19, 21);
2246	$LINK_MAP->insert ($exit->clone, 20, 19);
2247	$LINK_MAP->insert ($exit->clone, 20, 21);
2248	$LINK_MAP->insert ($exit->clone, 21, 19);
2249	$LINK_MAP->insert ($exit->clone, 21, 20);
2250	$LINK_MAP->insert ($exit->clone, 21, 21);
2251
2252	$exit->destroy;
2253	});
2254
2255	$LINK_MAP->{deny_save} = 1;
2256	$LINK_MAP->{deny_reset} = 1;
2257
2258	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2259	}
2260
2261	register "<global>", __PACKAGE__;
2262		2579
2263	register_command "reload" => sub {	2580	register_command "reload" => sub {
2264	my ($who, $arg) = @_;	2581	my ($who, $arg) = @_;
2265		2582
2266	if ($who->flag (FLAG_WIZ)) {	2583	if ($who->flag (FLAG_WIZ)) {
2267	$who->message ("start of reload.");	2584	$who->message ("reloading server.");
		2585
		2586	# doing reload synchronously and two reloads happen back-to-back,
		2587	# coro crashes during coro_state_free->destroy here.
		2588
		2589	$RELOAD_WATCHER ||= Event->timer (
		2590	reentrant => 0,
		2591	after => 0,
		2592	data => WF_AUTOCANCEL,
		2593	cb => sub {
2268	reload;	2594	reload;
2269	$who->message ("end of reload.");	2595	undef $RELOAD_WATCHER;
		2596	},
		2597	);
2270	}	2598	}
2271	};	2599	};
2272		2600
2273	unshift @INC, $LIBDIR;	2601	unshift @INC, $LIBDIR;
		2602
		2603	my $bug_warning = 0;
2274		2604
2275	$TICK_WATCHER = Event->timer (	2605	$TICK_WATCHER = Event->timer (
2276	reentrant => 0,	2606	reentrant => 0,
		2607	parked => 1,
2277	prio => 0,	2608	prio => 0,
2278	at => $NEXT_TICK || $TICK,	2609	at => $NEXT_TICK || $TICK,
2279	data => WF_AUTOCANCEL,	2610	data => WF_AUTOCANCEL,
2280	cb => sub {	2611	cb => sub {
		2612	if ($Coro::current != $Coro::main) {
		2613	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2614	unless ++$bug_warning > 10;
		2615	return;
		2616	}
		2617
		2618	$NOW = Event::time;
		2619
2281	cf::server_tick; # one server iteration	2620	cf::server_tick; # one server iteration
2282	$RUNTIME += $TICK;	2621	$RUNTIME += $TICK;
2283	$NEXT_TICK += $TICK;	2622	$NEXT_TICK += $TICK;
		2623
		2624	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2625	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2626	Coro::async_pool {
		2627	write_runtime
		2628	or warn "ERROR: unable to write runtime file: $!";
		2629	};
		2630	}
		2631
		2632	$WAIT_FOR_TICK->broadcast;
		2633	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2634
		2635	# my $AFTER = Event::time;
		2636	# warn $AFTER - $NOW;#d#
2284		2637
2285	# if we are delayed by four ticks or more, skip them all	2638	# if we are delayed by four ticks or more, skip them all
2286	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2639	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2287		2640
2288	$TICK_WATCHER->at ($NEXT_TICK);	2641	$TICK_WATCHER->at ($NEXT_TICK);
2289	$TICK_WATCHER->start;	2642	$TICK_WATCHER->start;
2290	},	2643	},
2291	);	2644	);
2292		2645
		2646	{
2293	IO::AIO::max_poll_time $TICK * 0.2;	2647	BDB::max_poll_time $TICK * 0.1;
2294		2648	$BDB_POLL_WATCHER = Event->io (
2295	Event->io (	2649	reentrant => 0,
2296	fd => IO::AIO::poll_fileno,	2650	fd => BDB::poll_fileno,
2297	poll => 'r',	2651	poll => 'r',
2298	prio => 5,	2652	prio => 0,
2299	data => WF_AUTOCANCEL,
2300	cb => \&IO::AIO::poll_cb,
2301	);
2302
2303	Event->timer (
2304	data => WF_AUTOCANCEL,	2653	data => WF_AUTOCANCEL,
2305	after => 0,	2654	cb => \&BDB::poll_cb,
2306	interval => 10,	2655	);
2307	cb => sub {	2656	BDB::min_parallel 8;
2308	(Coro::unblock_sub {	2657
2309	write_runtime	2658	BDB::set_sync_prepare {
2310	or warn "ERROR: unable to write runtime file: $!";	2659	my $status;
		2660	my $current = $Coro::current;
		2661	(
		2662	sub {
		2663	$status = $!;
		2664	$current->ready; undef $current;
		2665	},
		2666	sub {
		2667	Coro::schedule while defined $current;
		2668	$! = $status;
		2669	},
		2670	)
		2671	};
		2672
		2673	unless ($DB_ENV) {
		2674	$DB_ENV = BDB::db_env_create;
		2675
		2676	cf::sync_job {
		2677	eval {
		2678	BDB::db_env_open
		2679	$DB_ENV,
		2680	$BDB_ENV_DIR,
		2681	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2682	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2683	0666;
		2684
		2685	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2686
		2687	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2688	$DB_ENV->set_lk_detect;
		2689	};
		2690
		2691	cf::cleanup "db_env_open(db): $@" if $@;
2311	})->();	2692	};
2312	},	2693	}
2313	);	2694	}
		2695
		2696	{
		2697	IO::AIO::min_parallel 8;
		2698
		2699	undef $Coro::AIO::WATCHER;
		2700	IO::AIO::max_poll_time $TICK * 0.1;
		2701	$AIO_POLL_WATCHER = Event->io (
		2702	reentrant => 0,
		2703	data => WF_AUTOCANCEL,
		2704	fd => IO::AIO::poll_fileno,
		2705	poll => 'r',
		2706	prio => 6,
		2707	cb => \&IO::AIO::poll_cb,
		2708	);
		2709	}
2314		2710
2315	END { cf::emergency_save }	2711	END { cf::emergency_save }
2316		2712
2317	1	2713	1
2318		2714

Diff Legend

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