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.127 by root, Wed Jan 3 00:05:26 2007 UTC vs.
Revision 1.274 by root, Tue Jun 5 13:05:02 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use BDB ();
		26	use Data::Dumper;
20	use Digest::MD5;	27	use Digest::MD5;
21	use Fcntl;	28	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
24	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
25		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
27		41
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
30		44
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		46
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		48
35	our %COMMAND = ();	49	our %COMMAND = ();
36	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
38		56
		57	our $RELOAD; # number of reloads so far
39	our @EVENT;	58	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		59
42	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	76	our $NEXT_TICK;
45	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
46		82
47	our %CFG;	83	our %CFG;
48		84
49	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	86	our $RUNTIME;
51		87
		88	our %PLAYER; # all users
52	our %MAP; # all maps	89	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
54	our $FREEZE;	91
55	our $RANDOM_MAPS = cf::localdir . "/random";	92	# used to convert map paths into valid unix filenames by replacing / by ∕
56	our %EXT_CORO;	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
57		98
58	binmode STDOUT;	99	binmode STDOUT;
59	binmode STDERR;	100	binmode STDERR;
60		101
61	# read virtual server time, if available	102	# read virtual server time, if available
62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
64	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
65	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
66	}	107	}
67		108
68	mkdir cf::localdir;	109	mkdir $_
69	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70	mkdir cf::localdir . "/" . cf::tmpdir;
71	mkdir cf::localdir . "/" . cf::uniquedir;
72	mkdir $RANDOM_MAPS;
73		111
74	# a special map that is always available	112	our $EMERGENCY_POSITION;
75	our $LINK_MAP;
76		113
77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];	114	sub cf::map::normalise;
78		115
79	#############################################################################	116	#############################################################################
80		117
81	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
82		119
…		…
89	=item $cf::RUNTIME	126	=item $cf::RUNTIME
90		127
91	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
92	every server tick.	129	every server tick.
93		130
94	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95		134
96	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
97	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
98		139
99	=item $cf::NOW	140	=item $cf::NOW
100		141
101	The time of the last (current) server tick.	142	The time of the last (current) server tick.
102		143
103	=item $cf::TICK	144	=item $cf::TICK
104		145
105	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
106		157
107	=item %cf::CFG	158	=item %cf::CFG
108		159
109	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
110	from wherever your confdir points to.	161	from wherever your confdir points to.
		162
		163	=item cf::wait_for_tick, cf::wait_for_tick_begin
		164
		165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		166	returns directly I<after> the tick processing (and consequently, can only wake one process
		167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
111		168
112	=back	169	=back
113		170
114	=cut	171	=cut
115		172
116	BEGIN {	173	BEGIN {
117	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
118	my $msg = join "", @_;	175	my $msg = join "", @_;
119	utf8::encode $msg;
120		176
121	$msg .= "\n"	177	$msg .= "\n"
122	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
123		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
124	LOG llevError, "cfperl: $msg";	183	LOG llevError, $msg;
125	};	184	};
126	}	185	}
127		186
128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134		194
135	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
136	# within the Safe compartment.	196	# within the Safe compartment.
137	for my $pkg (qw(	197	for my $pkg (qw(
138	cf::global cf::attachable	198	cf::global cf::attachable
…		…
147		207
148	$Event::DIED = sub {	208	$Event::DIED = sub {
149	warn "error in event callback: @_";	209	warn "error in event callback: @_";
150	};	210	};
151		211
152	my %ext_pkg;
153	my @exts;
154	my @hook;
155
156	=head2 UTILITY FUNCTIONS	212	=head2 UTILITY FUNCTIONS
157		213
158	=over 4	214	=over 4
159		215
160	=cut	216	=item dumpval $ref
161		217
		218	=cut
		219
		220	sub dumpval {
		221	eval {
		222	local $SIG{__DIE__};
		223	my $d;
		224	if (1) {
		225	$d = new Data::Dumper([$_[0]], ["*var"]);
		226	$d->Terse(1);
		227	$d->Indent(2);
		228	$d->Quotekeys(0);
		229	$d->Useqq(1);
		230	#$d->Bless(...);
		231	$d->Seen($_[1]) if @_ > 1;
		232	$d = $d->Dump();
		233	}
		234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		235	$d
		236	} || "[unable to dump $_[0]: '$@']";
		237	}
		238
162	use JSON::Syck (); # TODO# replace by JSON::PC once working	239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
163		240
164	=item $ref = cf::from_json $json	241	=item $ref = cf::from_json $json
165		242
166	Converts a JSON string into the corresponding perl data structure.	243	Converts a JSON string into the corresponding perl data structure.
167		244
168	=cut
169
170	sub from_json($) {
171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172	JSON::Syck::Load $_[0]
173	}
174
175	=item $json = cf::to_json $ref	245	=item $json = cf::to_json $ref
176		246
177	Converts a perl data structure into its JSON representation.	247	Converts a perl data structure into its JSON representation.
178		248
179	=cut
180
181	sub to_json($) {
182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183	JSON::Syck::Dump $_[0]
184	}
185
186	=item my $guard = cf::guard { BLOCK }
187
188	Run the given callback when the guard object gets destroyed (useful for
189	coroutine cancellations).
190
191	You can call C<< ->cancel >> on the guard object to stop the block from
192	being executed.
193
194	=cut
195
196	sub guard(&) {
197	bless \(my $cb = $_[0]), cf::guard::;
198	}
199
200	sub cf::guard::cancel {
201	${$_[0]} = sub { };
202	}
203
204	sub cf::guard::DESTROY {
205	${$_[0]}->();
206	}
207
208	=item cf::lock_wait $string	249	=item cf::lock_wait $string
209		250
210	Wait until the given lock is available. See cf::lock_acquire.	251	Wait until the given lock is available. See cf::lock_acquire.
211		252
212	=item my $lock = cf::lock_acquire $string	253	=item my $lock = cf::lock_acquire $string
213		254
214	Wait until the given lock is available and then acquires it and returns	255	Wait until the given lock is available and then acquires it and returns
215	a guard object. If the guard object gets destroyed (goes out of scope,	256	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216	for example when the coroutine gets canceled), the lock is automatically	257	for example when the coroutine gets canceled), the lock is automatically
217	returned.	258	returned.
218		259
219	Lock names should begin with a unique identifier (for example, find_map	260	Lock names should begin with a unique identifier (for example, cf::map::find
220	uses map_find and load_map uses map_load).	261	uses map_find and cf::map::load uses map_load).
		262
		263	=item $locked = cf::lock_active $string
		264
		265	Return true if the lock is currently active, i.e. somebody has locked it.
221		266
222	=cut	267	=cut
223		268
224	our %LOCK;	269	our %LOCK;
225		270
…		…
239	# wait, to be sure we are not locked	284	# wait, to be sure we are not locked
240	lock_wait $key;	285	lock_wait $key;
241		286
242	$LOCK{$key} = [];	287	$LOCK{$key} = [];
243		288
244	cf::guard {	289	Coro::guard {
245	# wake up all waiters, to be on the safe side	290	# wake up all waiters, to be on the safe side
246	$_->ready for @{ delete $LOCK{$key} };	291	$_->ready for @{ delete $LOCK{$key} };
247	}	292	}
248	}	293	}
249		294
		295	sub lock_active($) {
		296	my ($key) = @_;
		297
		298	! ! $LOCK{$key}
		299	}
		300
		301	sub freeze_mainloop {
		302	return unless $TICK_WATCHER->is_active;
		303
		304	my $guard = Coro::guard {
		305	$TICK_WATCHER->start;
		306	};
		307	$TICK_WATCHER->stop;
		308	$guard
		309	}
		310
250	=item cf::async { BLOCK }	311	=item cf::async { BLOCK }
251		312
252	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the	313	Currently the same as Coro::async_pool, meaning you cannot use
253	error instead of exiting the server in case of a problem.	314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		315	thing you are allowed to do is call C<prio> on it.
254		316
255	=cut	317	=cut
256		318
257	sub async(&) {	319	BEGIN { *async = \&Coro::async_pool }
258	my ($cb) = @_;
259
260	Coro::async {
261	eval { $cb->() };
262	warn $@ if $@;
263	}
264	}
265		320
266	=item cf::sync_job { BLOCK }	321	=item cf::sync_job { BLOCK }
267		322
268	The design of crossfire+ requires that the main coro ($Coro::main) is	323	The design of crossfire+ requires that the main coro ($Coro::main) is
269	always able to handle events or runnable, as crossfire+ is only partly	324	always able to handle events or runnable, as crossfire+ is only partly
…		…
278		333
279	sub sync_job(&) {	334	sub sync_job(&) {
280	my ($job) = @_;	335	my ($job) = @_;
281		336
282	if ($Coro::current == $Coro::main) {	337	if ($Coro::current == $Coro::main) {
		338	my $time = Event::time;
		339
283	# this is the main coro, too bad, we have to block	340	# this is the main coro, too bad, we have to block
284	# till the operation succeeds, freezing the server :/	341	# till the operation succeeds, freezing the server :/
285		342
286	# TODO: use suspend/resume instead	343	# TODO: use suspend/resume instead
287	# (but this is cancel-safe)	344	# (but this is cancel-safe)
288	local $FREEZE = 1;	345	my $freeze_guard = freeze_mainloop;
289		346
290	my $busy = 1;	347	my $busy = 1;
291	my @res;	348	my @res;
292		349
293	(Coro::async {	350	(async {
294	@res = eval { $job->() };	351	@res = eval { $job->() };
295	warn $@ if $@;	352	warn $@ if $@;
296	undef $busy;	353	undef $busy;
297	})->prio (Coro::PRIO_MAX);	354	})->prio (Coro::PRIO_MAX);
298		355
299	while ($busy) {	356	while ($busy) {
300	Coro::cede_notself;	357	Coro::cede or Event::one_event;
301	Event::one_event unless Coro::nready;
302	}	358	}
		359
		360	$time = Event::time - $time;
		361
		362	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		363	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		364
		365	$tick_start += $time; # do not account sync jobs to server load
303		366
304	wantarray ? @res : $res[0]	367	wantarray ? @res : $res[0]
305	} else {	368	} else {
306	# we are in another coroutine, how wonderful, everything just works	369	# we are in another coroutine, how wonderful, everything just works
307		370
308	$job->()	371	$job->()
309	}	372	}
310	}	373	}
311		374
312	=item $coro = cf::coro { BLOCK }	375	=item $coro = cf::async_ext { BLOCK }
313		376
314	Creates and returns a new coro. This coro is automcatially being canceled	377	Like async, but this coro is automatically being canceled when the
315	when the extension calling this is being unloaded.	378	extension calling this is being unloaded.
316		379
317	=cut	380	=cut
318		381
319	sub coro(&) {	382	sub async_ext(&) {
320	my $cb = shift;	383	my $cb = shift;
321		384
322	my $coro = &cf::async ($cb);	385	my $coro = &Coro::async ($cb);
323		386
324	$coro->on_destroy (sub {	387	$coro->on_destroy (sub {
325	delete $EXT_CORO{$coro+0};	388	delete $EXT_CORO{$coro+0};
326	});	389	});
327	$EXT_CORO{$coro+0} = $coro;	390	$EXT_CORO{$coro+0} = $coro;
328		391
329	$coro	392	$coro
330	}	393	}
331		394
332	sub write_runtime {	395	sub write_runtime {
333	my $runtime = cf::localdir . "/runtime";	396	my $runtime = "$LOCALDIR/runtime";
		397
		398	# first touch the runtime file to show we are still running:
		399	# the fsync below can take a very very long time.
		400
		401	IO::AIO::aio_utime $runtime, undef, undef;
		402
		403	my $guard = cf::lock_acquire "write_runtime";
334		404
335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
336	or return;	406	or return;
337		407
		408	my $value = $cf::RUNTIME + 90 + 10;
338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	409	# 10 is the runtime save interval, for a monotonic clock
		410	# 60 allows for the watchdog to kill the server.
		411
339	(aio_write $fh, 0, (length $value), $value, 0) <= 0	412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
340	and return;	413	and return;
341		414
		415	# always fsync - this file is important
342	aio_fsync $fh	416	aio_fsync $fh
343	and return;	417	and return;
344		418
		419	# touch it again to show we are up-to-date
		420	aio_utime $fh, undef, undef;
		421
345	close $fh	422	close $fh
346	or return;	423	or return;
347		424
348	aio_rename "$runtime~", $runtime	425	aio_rename "$runtime~", $runtime
349	and return;	426	and return;
350		427
		428	warn "runtime file written.\n";
		429
351	1	430	1
352	}	431	}
353		432
		433	=item cf::datalog type => key => value, ...
		434
		435	Log a datalog packet of the given type with the given key-value pairs.
		436
		437	=cut
		438
		439	sub datalog($@) {
		440	my ($type, %kv) = @_;
		441	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		442	}
		443
354	=back	444	=back
355		445
356	=cut	446	=cut
357
358	#############################################################################
359
360	package cf::path;
361
362	sub new {
363	my ($class, $path, $base) = @_;
364
365	$path = $path->as_string if ref $path;
366
367	my $self = bless { }, $class;
368
369	# {... are special paths that are not touched
370	# ?xxx/... are special absolute paths
371	# ?random/... random maps
372	# /! non-realised random map exit
373	# /... normal maps
374	# ~/... per-player maps without a specific player (DO NOT USE)
375	# ~user/... per-player map of a specific user
376
377	if ($path =~ /^{/) {
378	# fine as it is
379	} elsif ($path =~ s{^\?random/}{}) {
380	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
381	$self->{random} = cf::from_json $data;
382	} else {
383	if ($path =~ s{^~([^/]+)?}{}) {
384	$self->{user_rel} = 1;
385
386	if (defined $1) {
387	$self->{user} = $1;
388	} elsif ($base =~ m{^~([^/]+)/}) {
389	$self->{user} = $1;
390	} else {
391	warn "cannot resolve user-relative path without user <$path,$base>\n";
392	}
393	} elsif ($path =~ /^\//) {
394	# already absolute
395	} else {
396	$base =~ s{[^/]+/?$}{};
397	return $class->new ("$base/$path");
398	}
399
400	for ($path) {
401	redo if s{/\.?/}{/};
402	redo if s{/[^/]+/\.\./}{/};
403	}
404	}
405
406	$self->{path} = $path;
407
408	$self
409	}
410
411	# the name / primary key / in-game path
412	sub as_string {
413	my ($self) = @_;
414
415	$self->{user_rel} ? "~$self->{user}$self->{path}"
416	: $self->{random} ? "?random/$self->{path}"
417	: $self->{path}
418	}
419
420	# the displayed name, this is a one way mapping
421	sub visible_name {
422	my ($self) = @_;
423
424	# if (my $rmp = $self->{random}) {
425	# # todo: be more intelligent about this
426	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
427	# } else {
428	$self->as_string
429	# }
430	}
431
432	# escape the /'s in the path
433	sub _escaped_path {
434	# ∕ is U+2215
435	(my $path = $_[0]{path}) =~ s/\//∕/g;
436	$path
437	}
438
439	# the original (read-only) location
440	sub load_path {
441	my ($self) = @_;
442
443	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
444	}
445
446	# the temporary/swap location
447	sub save_path {
448	my ($self) = @_;
449
450	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
451	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
452	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
453	}
454
455	# the unique path, might be eq to save_path
456	sub uniq_path {
457	my ($self) = @_;
458
459	$self->{user_rel} || $self->{random}
460	? undef
461	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
462	}
463
464	# return random map parameters, or undef
465	sub random_map_params {
466	my ($self) = @_;
467
468	$self->{random}
469	}
470
471	# this is somewhat ugly, but style maps do need special treatment
472	sub is_style_map {
473	$_[0]{path} =~ m{^/styles/}
474	}
475
476	package cf;
477		447
478	#############################################################################	448	#############################################################################
479		449
480	=head2 ATTACHABLE OBJECTS	450	=head2 ATTACHABLE OBJECTS
481		451
…		…
607	our @CB_TYPE = (); # registry for type (cf-object class) based events	577	our @CB_TYPE = (); # registry for type (cf-object class) based events
608	our @CB_MAP = ();	578	our @CB_MAP = ();
609		579
610	my %attachment;	580	my %attachment;
611		581
		582	sub cf::attachable::thawer_merge {
		583	# simply override everything except _meta
		584	local $_[0]{_meta};
		585	%{$_[0]} = %{$_[1]};
		586	}
		587
612	sub _attach_cb($$$$) {	588	sub _attach_cb($$$$) {
613	my ($registry, $event, $prio, $cb) = @_;	589	my ($registry, $event, $prio, $cb) = @_;
614		590
615	use sort 'stable';	591	use sort 'stable';
616		592
…		…
650	$registry = $CB_TYPE[$object_type] ||= [];	626	$registry = $CB_TYPE[$object_type] ||= [];
651		627
652	} elsif ($type eq "subtype") {	628	} elsif ($type eq "subtype") {
653	defined $object_type or Carp::croak "subtype specified without type";	629	defined $object_type or Carp::croak "subtype specified without type";
654	my $object_subtype = shift @arg;	630	my $object_subtype = shift @arg;
655	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	631	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
656		632
657	} elsif ($type eq "package") {	633	} elsif ($type eq "package") {
658	my $pkg = shift @arg;	634	my $pkg = shift @arg;
659		635
660	while (my ($name, $id) = each %cb_id) {	636	while (my ($name, $id) = each %cb_id) {
…		…
701	if (ref $_[0]) {	677	if (ref $_[0]) {
702	_object_attach @_;	678	_object_attach @_;
703	} else {	679	} else {
704	_attach shift->_attach_registry, @_;	680	_attach shift->_attach_registry, @_;
705	}	681	}
		682	_recalc_want;
706	};	683	};
707		684
708	# all those should be optimised	685	# all those should be optimised
709	sub cf::attachable::detach {	686	sub cf::attachable::detach {
710	my ($obj, $name) = @_;	687	my ($obj, $name) = @_;
…		…
713	delete $obj->{_attachment}{$name};	690	delete $obj->{_attachment}{$name};
714	reattach ($obj);	691	reattach ($obj);
715	} else {	692	} else {
716	Carp::croak "cannot, currently, detach class attachments";	693	Carp::croak "cannot, currently, detach class attachments";
717	}	694	}
		695	_recalc_want;
718	};	696	};
719		697
720	sub cf::attachable::attached {	698	sub cf::attachable::attached {
721	my ($obj, $name) = @_;	699	my ($obj, $name) = @_;
722		700
…		…
787	# object support	765	# object support
788		766
789	sub reattach {	767	sub reattach {
790	# basically do the same as instantiate, without calling instantiate	768	# basically do the same as instantiate, without calling instantiate
791	my ($obj) = @_;	769	my ($obj) = @_;
		770
		771	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
792		772
793	my $registry = $obj->registry;	773	my $registry = $obj->registry;
794		774
795	@$registry = ();	775	@$registry = ();
796		776
…		…
843	$filename, length $$rdata, scalar @$objs;	823	$filename, length $$rdata, scalar @$objs;
844		824
845	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
846	chmod SAVE_MODE, $fh;	826	chmod SAVE_MODE, $fh;
847	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
848	aio_fsync $fh;	828	aio_fsync $fh if $cf::USE_FSYNC;
849	close $fh;	829	close $fh;
850		830
851	if (@$objs) {	831	if (@$objs) {
852	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	832	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
853	chmod SAVE_MODE, $fh;	833	chmod SAVE_MODE, $fh;
854	my $data = Storable::nfreeze { version => 1, objs => $objs };	834	my $data = Storable::nfreeze { version => 1, objs => $objs };
855	aio_write $fh, 0, (length $data), $data, 0;	835	aio_write $fh, 0, (length $data), $data, 0;
856	aio_fsync $fh;	836	aio_fsync $fh if $cf::USE_FSYNC;
857	close $fh;	837	close $fh;
858	aio_rename "$filename.pst~", "$filename.pst";	838	aio_rename "$filename.pst~", "$filename.pst";
859	}	839	}
860	} else {	840	} else {
861	aio_unlink "$filename.pst";	841	aio_unlink "$filename.pst";
…		…
893	or return;	873	or return;
894	$av = eval { (Storable::thaw $av)->{objs} };	874	$av = eval { (Storable::thaw $av)->{objs} };
895	}	875	}
896		876
897	warn sprintf "loading %s (%d)\n",	877	warn sprintf "loading %s (%d)\n",
898	$filename, length $data, scalar @{$av || []};#d#	878	$filename, length $data, scalar @{$av || []};
899	return ($data, $av);	879	return ($data, $av);
900	}	880	}
901		881
902	#############################################################################	882	#############################################################################
903	# command handling &c	883	# command handling &c
…		…
928	=cut	908	=cut
929		909
930	sub register_extcmd {	910	sub register_extcmd {
931	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
932		912
933	my $caller = caller;
934	#warn "registering extcmd '$name' to '$caller'";
935
936	$EXTCMD{$name} = [$cb, $caller];	913	$EXTCMD{$name} = $cb;
937	}	914	}
938		915
939	cf::player->attach (	916	cf::player->attach (
940	on_command => sub {	917	on_command => sub {
941	my ($pl, $name, $params) = @_;	918	my ($pl, $name, $params) = @_;
…		…
954		931
955	my $msg = eval { from_json $buf };	932	my $msg = eval { from_json $buf };
956		933
957	if (ref $msg) {	934	if (ref $msg) {
958	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
959	if (my %reply = $cb->[0]->($pl, $msg)) {	936	if (my %reply = $cb->($pl, $msg)) {
960	$pl->ext_reply ($msg->{msgid}, %reply);	937	$pl->ext_reply ($msg->{msgid}, %reply);
961	}	938	}
962	}	939	}
963	} else {	940	} else {
964	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
966		943
967	cf::override;	944	cf::override;
968	},	945	},
969	);	946	);
970		947
971	sub register {
972	my ($base, $pkg) = @_;
973
974	#TODO
975	}
976
977	sub load_extension {	948	sub load_extension {
978	my ($path) = @_;	949	my ($path) = @_;
979		950
980	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	951	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
981	my $base = $1;	952	my $base = $1;
982	my $pkg = $1;	953	my $pkg = $1;
983	$pkg =~ s/[^[:word:]]/_/g;	954	$pkg =~ s/[^[:word:]]/_/g;
984	$pkg = "ext::$pkg";	955	$pkg = "ext::$pkg";
985		956
986	warn "loading '$path' into '$pkg'\n";	957	warn "... loading '$path' into '$pkg'\n";
987		958
988	open my $fh, "<:utf8", $path	959	open my $fh, "<:utf8", $path
989	or die "$path: $!";	960	or die "$path: $!";
990		961
991	my $source =	962	my $source =
992	"package $pkg; use strict; use utf8;\n"	963	"package $pkg; use strict; use utf8;\n"
993	. "#line 1 \"$path\"\n{\n"	964	. "#line 1 \"$path\"\n{\n"
994	. (do { local $/; <$fh> })	965	. (do { local $/; <$fh> })
995	. "\n};\n1";	966	. "\n};\n1";
996		967
997	eval $source	968	unless (eval $source) {
998	or die $@ ? "$path: $@\n"	969	my $msg = $@ ? "$path: $@\n"
999	: "extension disabled.\n";	970	: "extension disabled.\n";
1000		971	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
1001	push @exts, $pkg;	972	warn $@;
1002	$ext_pkg{$base} = $pkg;	973	warn "mandatory extension failed to load, exiting.\n";
1003		974	exit 1;
1004	# no strict 'refs';	975	}
1005	# @{"$pkg\::ISA"} = ext::;	976	die $@;
1006
1007	register $base, $pkg;
1008	}
1009
1010	sub unload_extension {
1011	my ($pkg) = @_;
1012
1013	warn "removing extension $pkg\n";
1014
1015	# remove hooks
1016	#TODO
1017	# for my $idx (0 .. $#PLUGIN_EVENT) {
1018	# delete $hook[$idx]{$pkg};
1019	# }	977	}
1020		978
1021	# remove commands	979	push @EXTS, $pkg;
1022	for my $name (keys %COMMAND) {
1023	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1024
1025	if (@cb) {
1026	$COMMAND{$name} = \@cb;
1027	} else {
1028	delete $COMMAND{$name};
1029	}
1030	}
1031
1032	# remove extcmds
1033	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1034	delete $EXTCMD{$name};
1035	}
1036
1037	if (my $cb = $pkg->can ("unload")) {
1038	eval {
1039	$cb->($pkg);
1040	1
1041	} or warn "$pkg unloaded, but with errors: $@";
1042	}
1043
1044	Symbol::delete_package $pkg;
1045	}	980	}
1046		981
1047	sub load_extensions {	982	sub load_extensions {
1048	for my $ext (<$LIBDIR/*.ext>) {	983	for my $ext (<$LIBDIR/*.ext>) {
1049	next unless -r $ext;	984	next unless -r $ext;
…		…
1053	} or warn "$ext not loaded: $@";	988	} or warn "$ext not loaded: $@";
1054	}	989	}
1055	}	990	}
1056		991
1057	#############################################################################	992	#############################################################################
1058	# load/save/clean perl data associated with a map
1059
1060	*cf::mapsupport::on_clean = sub {
1061	my ($map) = @_;
1062
1063	my $path = $map->tmpname;
1064	defined $path or return;
1065
1066	unlink "$path.pst";
1067	};
1068
1069	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1070
1071	#############################################################################
1072	# load/save perl data associated with player->ob objects
1073
1074	sub all_objects(@) {
1075	@_, map all_objects ($_->inv), @_
1076	}
1077
1078	# TODO: compatibility cruft, remove when no longer needed
1079	cf::player->attach (
1080	on_load => sub {
1081	my ($pl, $path) = @_;
1082
1083	for my $o (all_objects $pl->ob) {
1084	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1085	$o->set_ob_key_value ("_perl_data");
1086
1087	%$o = %{ Storable::thaw pack "H*", $value };
1088	}
1089	}
1090	},
1091	);
1092
1093	#############################################################################
1094		993
1095	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
1096		995
1097	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
1098		997
		998	=cut
		999
		1000	package cf::player;
		1001
		1002	use Coro::AIO;
		1003
1099	=head3 cf::player	1004	=head3 cf::player
1100		1005
1101	=over 4	1006	=over 4
1102		1007
1103	=item cf::player::exists $login	1008	=item cf::player::find $login
1104		1009
1105	Returns true when the given account exists.	1010	Returns the given player object, loading it if necessary (might block).
1106		1011
1107	=cut	1012	=cut
1108		1013
1109	sub cf::player::exists($) {	1014	sub playerdir($) {
1110	cf::player::find $_[0]	1015	"$PLAYERDIR/"
1111	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1016	. (ref $_[0] ? $_[0]->ob->name : $_[0])
1112	}	1017	}
1113		1018
		1019	sub path($) {
		1020	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1021
		1022	(playerdir $login) . "/playerdata"
		1023	}
		1024
		1025	sub find_active($) {
		1026	$cf::PLAYER{$_[0]}
		1027	and $cf::PLAYER{$_[0]}->active
		1028	and $cf::PLAYER{$_[0]}
		1029	}
		1030
		1031	sub exists($) {
		1032	my ($login) = @_;
		1033
		1034	$cf::PLAYER{$login}
		1035	or cf::sync_job { !aio_stat path $login }
		1036	}
		1037
		1038	sub find($) {
		1039	return $cf::PLAYER{$_[0]} || do {
		1040	my $login = $_[0];
		1041
		1042	my $guard = cf::lock_acquire "user_find:$login";
		1043
		1044	$cf::PLAYER{$_[0]} || do {
		1045	# rename old playerfiles to new ones
		1046	#TODO: remove when no longer required
		1047	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1048	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1049	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1050	aio_unlink +(playerdir $login) . "/$login.pl";
		1051
		1052	my $pl = load_pl path $login
		1053	or return;
		1054	$cf::PLAYER{$login} = $pl
		1055	}
		1056	}
		1057	}
		1058
		1059	sub save($) {
		1060	my ($pl) = @_;
		1061
		1062	return if $pl->{deny_save};
		1063
		1064	my $path = path $pl;
		1065	my $guard = cf::lock_acquire "user_save:$path";
		1066
		1067	return if $pl->{deny_save};
		1068
		1069	aio_mkdir playerdir $pl, 0770;
		1070	$pl->{last_save} = $cf::RUNTIME;
		1071
		1072	$pl->save_pl ($path);
		1073	Coro::cede;
		1074	}
		1075
		1076	sub new($) {
		1077	my ($login) = @_;
		1078
		1079	my $self = create;
		1080
		1081	$self->ob->name ($login);
		1082	$self->{deny_save} = 1;
		1083
		1084	$cf::PLAYER{$login} = $self;
		1085
		1086	$self
		1087	}
		1088
		1089	=item $pl->quit_character
		1090
		1091	Nukes the player without looking back. If logged in, the connection will
		1092	be destroyed. May block for a long time.
		1093
		1094	=cut
		1095
		1096	sub quit_character {
		1097	my ($pl) = @_;
		1098
		1099	my $name = $pl->ob->name;
		1100
		1101	$pl->{deny_save} = 1;
		1102	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1103
		1104	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1105	$pl->deactivate;
		1106	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1107	$pl->ns->destroy if $pl->ns;
		1108
		1109	my $path = playerdir $pl;
		1110	my $temp = "$path~$cf::RUNTIME~deleting~";
		1111	aio_rename $path, $temp;
		1112	delete $cf::PLAYER{$pl->ob->name};
		1113	$pl->destroy;
		1114
		1115	my $prefix = qr<^~\Q$name\E/>;
		1116
		1117	# nuke player maps
		1118	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1119
		1120	IO::AIO::aio_rmtree $temp;
		1121	}
		1122
		1123	=item $pl->kick
		1124
		1125	Kicks a player out of the game. This destroys the connection.
		1126
		1127	=cut
		1128
		1129	sub kick {
		1130	my ($pl, $kicker) = @_;
		1131
		1132	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1133	$pl->killer ("kicked");
		1134	$pl->ns->destroy;
		1135	}
		1136
		1137	=item cf::player::list_logins
		1138
		1139	Returns am arrayref of all valid playernames in the system, can take a
		1140	while and may block, so not sync_job-capable, ever.
		1141
		1142	=cut
		1143
		1144	sub list_logins {
		1145	my $dirs = aio_readdir $PLAYERDIR
		1146	or return [];
		1147
		1148	my @logins;
		1149
		1150	for my $login (@$dirs) {
		1151	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1152	aio_read $fh, 0, 512, my $buf, 0 or next;
		1153	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1154
		1155	utf8::decode $login;
		1156	push @logins, $login;
		1157	}
		1158
		1159	\@logins
		1160	}
		1161
		1162	=item $player->maps
		1163
		1164	Returns an arrayref of map paths that are private for this
		1165	player. May block.
		1166
		1167	=cut
		1168
		1169	sub maps($) {
		1170	my ($pl) = @_;
		1171
		1172	$pl = ref $pl ? $pl->ob->name : $pl;
		1173
		1174	my $files = aio_readdir playerdir $pl
		1175	or return;
		1176
		1177	my @paths;
		1178
		1179	for (@$files) {
		1180	utf8::decode $_;
		1181	next if /\.(?:pl|pst)$/;
		1182	next unless /^$PATH_SEP/o;
		1183
		1184	push @paths, cf::map::normalise "~$pl/$_";
		1185	}
		1186
		1187	\@paths
		1188	}
		1189
1114	=item $player->ext_reply ($msgid, $msgtype, %msg)	1190	=item $player->ext_reply ($msgid, %msg)
1115		1191
1116	Sends an ext reply to the player.	1192	Sends an ext reply to the player.
1117		1193
1118	=cut	1194	=cut
1119		1195
1120	sub cf::player::ext_reply($$$%) {	1196	sub ext_reply($$%) {
1121	my ($self, $id, %msg) = @_;	1197	my ($self, $id, %msg) = @_;
1122		1198
1123	$msg{msgid} = $id;	1199	$msg{msgid} = $id;
1124		1200
1125	$self->send ("ext " . to_json \%msg);	1201	$self->send ("ext " . cf::to_json \%msg);
		1202	}
		1203
		1204	=item $player->ext_event ($type, %msg)
		1205
		1206	Sends an ext event to the client.
		1207
		1208	=cut
		1209
		1210	sub ext_event($$%) {
		1211	my ($self, $type, %msg) = @_;
		1212
		1213	$self->ns->ext_event ($type, %msg);
		1214	}
		1215
		1216	=head3 cf::region
		1217
		1218	=over 4
		1219
		1220	=cut
		1221
		1222	package cf::region;
		1223
		1224	=item cf::region::find_by_path $path
		1225
		1226	Tries to decuce the probable region for a map knowing only its path.
		1227
		1228	=cut
		1229
		1230	sub find_by_path($) {
		1231	my ($path) = @_;
		1232
		1233	my ($match, $specificity);
		1234
		1235	for my $region (list) {
		1236	if ($region->match && $path =~ $region->match) {
		1237	($match, $specificity) = ($region, $region->specificity)
		1238	if $region->specificity > $specificity;
		1239	}
		1240	}
		1241
		1242	$match
1126	}	1243	}
1127		1244
1128	=back	1245	=back
1129
1130		1246
1131	=head3 cf::map	1247	=head3 cf::map
1132		1248
1133	=over 4	1249	=over 4
1134		1250
…		…
1137	package cf::map;	1253	package cf::map;
1138		1254
1139	use Fcntl;	1255	use Fcntl;
1140	use Coro::AIO;	1256	use Coro::AIO;
1141		1257
		1258	use overload
		1259	'""' => \&as_string,
		1260	fallback => 1;
		1261
1142	our $MAX_RESET = 7200;	1262	our $MAX_RESET = 3600;
1143	our $DEFAULT_RESET = 3600;	1263	our $DEFAULT_RESET = 3000;
1144		1264
1145	sub generate_random_map {	1265	sub generate_random_map {
1146	my ($path, $rmp) = @_;	1266	my ($self, $rmp) = @_;
1147
1148	# mit "rum" bekleckern, nicht	1267	# mit "rum" bekleckern, nicht
1149	cf::map::_create_random_map	1268	$self->_create_random_map (
1150	$path,
1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1269	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1270	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1271	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154	$rmp->{exit_on_final_map},	1272	$rmp->{exit_on_final_map},
1155	$rmp->{xsize}, $rmp->{ysize},	1273	$rmp->{xsize}, $rmp->{ysize},
1156	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1274	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1275	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1158	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1276	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1159	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1277	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1160	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1278	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1161	(cf::region::find $rmp->{region})	1279	(cf::region::find $rmp->{region}), $rmp->{custom}
		1280	)
		1281	}
		1282
		1283	=item cf::map->register ($regex, $prio)
		1284
		1285	Register a handler for the map path matching the given regex at the
		1286	givne priority (higher is better, built-in handlers have priority 0, the
		1287	default).
		1288
		1289	=cut
		1290
		1291	sub register {
		1292	my (undef, $regex, $prio) = @_;
		1293	my $pkg = caller;
		1294
		1295	no strict;
		1296	push @{"$pkg\::ISA"}, __PACKAGE__;
		1297
		1298	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1299	}
		1300
		1301	# also paths starting with '/'
		1302	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1303
		1304	sub thawer_merge {
		1305	my ($self, $merge) = @_;
		1306
		1307	# we have to keep some variables in memory intact
		1308	local $self->{path};
		1309	local $self->{load_path};
		1310	local $self->{deny_save};
		1311	local $self->{deny_reset};
		1312
		1313	$self->SUPER::thawer_merge ($merge);
		1314	}
		1315
		1316	sub normalise {
		1317	my ($path, $base) = @_;
		1318
		1319	$path = "$path"; # make sure its a string
		1320
		1321	$path =~ s/\.map$//;
		1322
		1323	# map plan:
		1324	#
		1325	# /! non-realised random map exit (special hack!)
		1326	# {... are special paths that are not being touched
		1327	# ?xxx/... are special absolute paths
		1328	# ?random/... random maps
		1329	# /... normal maps
		1330	# ~user/... per-player map of a specific user
		1331
		1332	$path =~ s/$PATH_SEP/\//go;
		1333
		1334	# treat it as relative path if it starts with
		1335	# something that looks reasonable
		1336	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1337	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1338
		1339	$base =~ s{[^/]+/?$}{};
		1340	$path = "$base/$path";
		1341	}
		1342
		1343	for ($path) {
		1344	redo if s{//}{/};
		1345	redo if s{/\.?/}{/};
		1346	redo if s{/[^/]+/\.\./}{/};
		1347	}
		1348
		1349	$path
		1350	}
		1351
		1352	sub new_from_path {
		1353	my (undef, $path, $base) = @_;
		1354
		1355	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1356
		1357	$path = normalise $path, $base;
		1358
		1359	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1360	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1361	my $self = bless cf::map::new, $pkg;
		1362	$self->{path} = $path; $self->path ($path);
		1363	$self->init; # pass $1 etc.
		1364	return $self;
		1365	}
		1366	}
		1367
		1368	Carp::carp "unable to resolve path '$path' (base '$base').";
		1369	()
		1370	}
		1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self
		1376	}
		1377
		1378	sub as_string {
		1379	my ($self) = @_;
		1380
		1381	"$self->{path}"
		1382	}
		1383
		1384	# the displayed name, this is a one way mapping
		1385	sub visible_name {
		1386	&as_string
		1387	}
		1388
		1389	# the original (read-only) location
		1390	sub load_path {
		1391	my ($self) = @_;
		1392
		1393	"$MAPDIR/$self->{path}.map"
		1394	}
		1395
		1396	# the temporary/swap location
		1397	sub save_path {
		1398	my ($self) = @_;
		1399
		1400	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1401	"$TMPDIR/$path.map"
		1402	}
		1403
		1404	# the unique path, undef == no special unique path
		1405	sub uniq_path {
		1406	my ($self) = @_;
		1407
		1408	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1409	"$UNIQUEDIR/$path"
1162	}	1410	}
1163		1411
1164	# and all this just because we cannot iterate over	1412	# and all this just because we cannot iterate over
1165	# all maps in C++...	1413	# all maps in C++...
1166	sub change_all_map_light {	1414	sub change_all_map_light {
…		…
1168		1416
1169	$_->change_map_light ($change)	1417	$_->change_map_light ($change)
1170	for grep $_->outdoor, values %cf::MAP;	1418	for grep $_->outdoor, values %cf::MAP;
1171	}	1419	}
1172		1420
		1421	sub unlink_save {
		1422	my ($self) = @_;
		1423
		1424	utf8::encode (my $save = $self->save_path);
		1425	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1426	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1427	}
		1428
1173	sub try_load_header($) {	1429	sub load_header_from($) {
1174	my ($path) = @_;	1430	my ($self, $path) = @_;
1175		1431
1176	utf8::encode $path;	1432	utf8::encode $path;
1177	aio_open $path, O_RDONLY, 0	1433	#aio_open $path, O_RDONLY, 0
		1434	# or return;
		1435
		1436	$self->_load_header ($path)
1178	or return;	1437	or return;
1179		1438
1180	my $map = cf::map::new	1439	$self->{load_path} = $path;
		1440
		1441	1
		1442	}
		1443
		1444	sub load_header_orig {
		1445	my ($self) = @_;
		1446
		1447	$self->load_header_from ($self->load_path)
		1448	}
		1449
		1450	sub load_header_temp {
		1451	my ($self) = @_;
		1452
		1453	$self->load_header_from ($self->save_path)
		1454	}
		1455
		1456	sub prepare_temp {
		1457	my ($self) = @_;
		1458
		1459	$self->last_access ((delete $self->{last_access})
		1460	|| $cf::RUNTIME); #d#
		1461	# safety
		1462	$self->{instantiate_time} = $cf::RUNTIME
		1463	if $self->{instantiate_time} > $cf::RUNTIME;
		1464	}
		1465
		1466	sub prepare_orig {
		1467	my ($self) = @_;
		1468
		1469	$self->{load_original} = 1;
		1470	$self->{instantiate_time} = $cf::RUNTIME;
		1471	$self->last_access ($cf::RUNTIME);
		1472	$self->instantiate;
		1473	}
		1474
		1475	sub load_header {
		1476	my ($self) = @_;
		1477
		1478	if ($self->load_header_temp) {
		1479	$self->prepare_temp;
		1480	} else {
		1481	$self->load_header_orig
1181	or return;	1482	or return;
		1483	$self->prepare_orig;
		1484	}
1182		1485
1183	$map->load_header ($path)	1486	$self->default_region (cf::region::find_by_path $self->{path})
1184	or return;	1487	unless $self->default_region;
1185		1488
1186	$map->{load_path} = $path;	1489	1
1187
1188	$map
1189	}	1490	}
1190		1491
1191	sub find_map;	1492	sub find;
1192	sub find_map {	1493	sub find {
1193	my ($path, $origin) = @_;	1494	my ($path, $origin) = @_;
1194		1495
1195	#warn "find_map<$path,$origin>\n";#d#
1196
1197	$path = new cf::path $path, $origin && $origin->path;	1496	$path = normalise $path, $origin && $origin->path;
1198	my $key = $path->as_string;
1199		1497
1200	cf::lock_wait "map_find:$key";	1498	cf::lock_wait "map_find:$path";
1201		1499
1202	$cf::MAP{$key} || do {	1500	$cf::MAP{$path} || do {
1203	my $guard = cf::lock_acquire "map_find:$key";	1501	my $guard = cf::lock_acquire "map_find:$path";
1204		1502	my $map = new_from_path cf::map $path
1205	# do it the slow way
1206	my $map = try_load_header $path->save_path;
1207
1208	if ($map) {
1209	# safety
1210	$map->{instantiate_time} = $cf::RUNTIME
1211	if $map->{instantiate_time} > $cf::RUNTIME;
1212	} else {
1213	if (my $rmp = $path->random_map_params) {
1214	$map = generate_random_map $key, $rmp;
1215	} else {
1216	$map = try_load_header $path->load_path;
1217	}
1218
1219	$map or return;	1503	or return;
1220		1504
1221	$map->{load_original} = 1;
1222	$map->{instantiate_time} = $cf::RUNTIME;
1223	$map->instantiate;
1224
1225	# per-player maps become, after loading, normal maps
1226	$map->per_player (0) if $path->{user_rel};
1227	}
1228
1229	$map->path ($key);
1230	$map->{path} = $path;
1231	$map->{last_save} = $cf::RUNTIME;	1505	$map->{last_save} = $cf::RUNTIME;
1232	$map->last_access ($cf::RUNTIME);
1233		1506
1234	if ($map->should_reset) {	1507	$map->load_header
		1508	or return;
		1509
		1510	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1511	# doing this can freeze the server in a sync job, obviously
		1512	#$cf::WAIT_FOR_TICK->wait;
1235	$map->reset;	1513	$map->reset;
1236	undef $guard;	1514	undef $guard;
1237	$map = find_map $path	1515	return find $path;
1238	or return;
1239	}	1516	}
1240		1517
1241	$cf::MAP{$key} = $map	1518	$cf::MAP{$path} = $map
1242	}	1519	}
1243	}	1520	}
		1521
		1522	sub pre_load { }
		1523	sub post_load { }
1244		1524
1245	sub load {	1525	sub load {
1246	my ($self) = @_;	1526	my ($self) = @_;
1247		1527
		1528	local $self->{deny_reset} = 1; # loading can take a long time
		1529
1248	my $path = $self->{path};	1530	my $path = $self->{path};
		1531
		1532	{
1249	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1533	my $guard = cf::lock_acquire "map_load:$path";
1250		1534
1251	return if $self->in_memory != cf::MAP_SWAPPED;	1535	return if $self->in_memory != cf::MAP_SWAPPED;
1252		1536
1253	$self->in_memory (cf::MAP_LOADING);	1537	$self->in_memory (cf::MAP_LOADING);
1254		1538
1255	$self->alloc;	1539	$self->alloc;
		1540
		1541	$self->pre_load;
		1542	Coro::cede;
		1543
1256	$self->load_objects ($self->{load_path}, 1)	1544	$self->_load_objects ($self->{load_path}, 1)
1257	or return;	1545	or return;
1258		1546
1259	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1547	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1260	if delete $self->{load_original};	1548	if delete $self->{load_original};
1261		1549
1262	if (my $uniq = $path->uniq_path) {	1550	if (my $uniq = $self->uniq_path) {
1263	utf8::encode $uniq;	1551	utf8::encode $uniq;
1264	if (aio_open $uniq, O_RDONLY, 0) {	1552	if (aio_open $uniq, O_RDONLY, 0) {
1265	$self->clear_unique_items;	1553	$self->clear_unique_items;
1266	$self->load_objects ($uniq, 0);	1554	$self->_load_objects ($uniq, 0);
1267	}	1555	}
1268	}	1556	}
1269		1557
		1558	Coro::cede;
1270	# now do the right thing for maps	1559	# now do the right thing for maps
1271	$self->link_multipart_objects;	1560	$self->link_multipart_objects;
1272
1273	if ($self->{path}->is_style_map) {
1274	$self->{deny_save} = 1;
1275	$self->{deny_reset} = 1;
1276	} else {
1277	$self->fix_auto_apply;
1278	$self->decay_objects;
1279	$self->update_buttons;
1280	$self->set_darkness_map;
1281	$self->difficulty ($self->estimate_difficulty)	1561	$self->difficulty ($self->estimate_difficulty)
1282	unless $self->difficulty;	1562	unless $self->difficulty;
		1563	Coro::cede;
		1564
		1565	unless ($self->{deny_activate}) {
		1566	$self->decay_objects;
		1567	$self->fix_auto_apply;
		1568	$self->update_buttons;
		1569	Coro::cede;
		1570	$self->set_darkness_map;
		1571	Coro::cede;
1283	$self->activate;	1572	$self->activate;
1284	}	1573	}
1285		1574
1286	$self->in_memory (cf::MAP_IN_MEMORY);	1575	$self->in_memory (cf::MAP_IN_MEMORY);
1287	}	1576	}
1288		1577
1289	sub load_map_sync {	1578	$self->post_load;
		1579	}
		1580
		1581	sub customise_for {
		1582	my ($self, $ob) = @_;
		1583
		1584	return find "~" . $ob->name . "/" . $self->{path}
		1585	if $self->per_player;
		1586
		1587	$self
		1588	}
		1589
		1590	# find and load all maps in the 3x3 area around a map
		1591	sub load_diag {
		1592	my ($map) = @_;
		1593
		1594	my @diag; # diagonal neighbours
		1595
		1596	for (0 .. 3) {
		1597	my $neigh = $map->tile_path ($_)
		1598	or next;
		1599	$neigh = find $neigh, $map
		1600	or next;
		1601	$neigh->load;
		1602
		1603	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1604	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1605	}
		1606
		1607	for (@diag) {
		1608	my $neigh = find @$_
		1609	or next;
		1610	$neigh->load;
		1611	}
		1612	}
		1613
		1614	sub find_sync {
1290	my ($path, $origin) = @_;	1615	my ($path, $origin) = @_;
1291		1616
1292	#warn "load_map_sync<$path, $origin>\n";#d#	1617	cf::sync_job { find $path, $origin }
		1618	}
1293		1619
1294	cf::sync_job {	1620	sub do_load_sync {
1295	my $map = cf::map::find_map $path, $origin	1621	my ($map) = @_;
1296	or return;	1622
		1623	cf::sync_job { $map->load };
		1624	}
		1625
		1626	our %MAP_PREFETCH;
		1627	our $MAP_PREFETCHER = undef;
		1628
		1629	sub find_async {
		1630	my ($path, $origin) = @_;
		1631
		1632	$path = normalise $path, $origin && $origin->{path};
		1633
		1634	if (my $map = $cf::MAP{$path}) {
		1635	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1636	}
		1637
		1638	undef $MAP_PREFETCH{$path};
		1639	$MAP_PREFETCHER ||= cf::async {
		1640	while (%MAP_PREFETCH) {
		1641	for my $path (keys %MAP_PREFETCH) {
		1642	my $map = find $path
		1643	or next;
1297	$map->load;	1644	$map->load;
1298	$map	1645
		1646	delete $MAP_PREFETCH{$path};
		1647	}
		1648	}
		1649	undef $MAP_PREFETCHER;
1299	}	1650	};
		1651	$MAP_PREFETCHER->prio (6);
		1652
		1653	()
1300	}	1654	}
1301		1655
1302	sub save {	1656	sub save {
1303	my ($self) = @_;	1657	my ($self) = @_;
1304		1658
		1659	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1660
1305	$self->{last_save} = $cf::RUNTIME;	1661	$self->{last_save} = $cf::RUNTIME;
1306		1662
1307	return unless $self->dirty;	1663	return unless $self->dirty;
1308		1664
1309	my $save = $self->{path}->save_path; utf8::encode $save;	1665	my $save = $self->save_path; utf8::encode $save;
1310	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1666	my $uniq = $self->uniq_path; utf8::encode $uniq;
1311		1667
1312	$self->{load_path} = $save;	1668	$self->{load_path} = $save;
1313		1669
1314	return if $self->{deny_save};	1670	return if $self->{deny_save};
1315		1671
		1672	local $self->{last_access} = $self->last_access;#d#
		1673
		1674	cf::async {
		1675	$_->contr->save for $self->players;
		1676	};
		1677
1316	if ($uniq) {	1678	if ($uniq) {
1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1679	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1318	$self->save_objects ($uniq, cf::IO_UNIQUES);	1680	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1319	} else {	1681	} else {
1320	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1682	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1321	}	1683	}
1322	}	1684	}
1323		1685
1324	sub swap_out {	1686	sub swap_out {
1325	my ($self) = @_;	1687	my ($self) = @_;
		1688
		1689	# save first because save cedes
		1690	$self->save;
		1691
		1692	my $lock = cf::lock_acquire "map_data:" . $self->path;
1326		1693
1327	return if $self->players;	1694	return if $self->players;
1328	return if $self->in_memory != cf::MAP_IN_MEMORY;	1695	return if $self->in_memory != cf::MAP_IN_MEMORY;
1329	return if $self->{deny_save};	1696	return if $self->{deny_save};
1330		1697
1331	$self->save;
1332	$self->clear;	1698	$self->clear;
1333	$self->in_memory (cf::MAP_SWAPPED);	1699	$self->in_memory (cf::MAP_SWAPPED);
1334	}	1700	}
1335		1701
1336	sub reset_at {	1702	sub reset_at {
1337	my ($self) = @_;	1703	my ($self) = @_;
1338		1704
1339	# TODO: safety, remove and allow resettable per-player maps	1705	# TODO: safety, remove and allow resettable per-player maps
1340	return 1e99 if $self->{path}{user_rel};	1706	return 1e99 if $self->isa ("ext::map_per_player");#d#
1341	return 1e99 if $self->{deny_reset};	1707	return 1e99 if $self->{deny_reset};
1342		1708
1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1709	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1710	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345		1711
…		…
1350	my ($self) = @_;	1716	my ($self) = @_;
1351		1717
1352	$self->reset_at <= $cf::RUNTIME	1718	$self->reset_at <= $cf::RUNTIME
1353	}	1719	}
1354		1720
1355	sub unlink_save {
1356	my ($self) = @_;
1357
1358	utf8::encode (my $save = $self->{path}->save_path);
1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361	}
1362
1363	sub rename {
1364	my ($self, $new_path) = @_;
1365
1366	$self->unlink_save;
1367
1368	delete $cf::MAP{$self->path};
1369	$self->{path} = new cf::path $new_path;
1370	$self->path ($self->{path}->as_string);
1371	$cf::MAP{$self->path} = $self;
1372
1373	$self->save;
1374	}
1375
1376	sub reset {	1721	sub reset {
1377	my ($self) = @_;	1722	my ($self) = @_;
1378		1723
		1724	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1725
1379	return if $self->players;	1726	return if $self->players;
1380	return if $self->{path}{user_rel};#d#	1727	return if $self->isa ("ext::map_per_player");#d#
1381		1728
1382	warn "resetting map ", $self->path;#d#	1729	warn "resetting map ", $self->path;
		1730
		1731	$self->in_memory (cf::MAP_SWAPPED);
		1732
		1733	# need to save uniques path
		1734	unless ($self->{deny_save}) {
		1735	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1736
		1737	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1738	if $uniq;
		1739	}
1383		1740
1384	delete $cf::MAP{$self->path};	1741	delete $cf::MAP{$self->path};
		1742
		1743	$self->clear;
1385		1744
1386	$_->clear_links_to ($self) for values %cf::MAP;	1745	$_->clear_links_to ($self) for values %cf::MAP;
1387		1746
1388	$self->unlink_save;	1747	$self->unlink_save;
1389	$self->destroy;	1748	$self->destroy;
…		…
1392	my $nuke_counter = "aaaa";	1751	my $nuke_counter = "aaaa";
1393		1752
1394	sub nuke {	1753	sub nuke {
1395	my ($self) = @_;	1754	my ($self) = @_;
1396		1755
		1756	delete $cf::MAP{$self->path};
		1757
		1758	$self->unlink_save;
		1759
		1760	bless $self, "cf::map";
		1761	delete $self->{deny_reset};
1397	$self->{deny_save} = 1;	1762	$self->{deny_save} = 1;
1398	$self->reset_timeout (1);	1763	$self->reset_timeout (1);
1399	$self->rename ("{nuke}/" . ($nuke_counter++));	1764	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1765
		1766	$cf::MAP{$self->path} = $self;
		1767
1400	$self->reset; # polite request, might not happen	1768	$self->reset; # polite request, might not happen
1401	}	1769	}
1402		1770
1403	sub customise_for {	1771	=item cf::map::unique_maps
1404	my ($map, $ob) = @_;
1405		1772
1406	if ($map->per_player) {	1773	Returns an arrayref of paths of all shared maps that have
1407	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};	1774	instantiated unique items. May block.
1408	}
1409		1775
1410	$map	1776	=cut
1411	}
1412		1777
1413	sub emergency_save {	1778	sub unique_maps() {
1414	local $cf::FREEZE = 1;	1779	my $files = aio_readdir $UNIQUEDIR
		1780	or return;
1415		1781
1416	warn "enter emergency map save\n";	1782	my @paths;
1417		1783
1418	cf::sync_job {	1784	for (@$files) {
1419	warn "begin emergency map save\n";	1785	utf8::decode $_;
1420	$_->save for values %cf::MAP;	1786	next if /\.pst$/;
		1787	next unless /^$PATH_SEP/o;
		1788
		1789	push @paths, cf::map::normalise $_;
1421	};	1790	}
1422		1791
1423	warn "end emergency map save\n";	1792	\@paths
1424	}	1793	}
1425		1794
1426	package cf;	1795	package cf;
1427		1796
1428	=back	1797	=back
1429		1798
		1799	=head3 cf::object
		1800
		1801	=cut
		1802
		1803	package cf::object;
		1804
		1805	=over 4
		1806
		1807	=item $ob->inv_recursive
		1808
		1809	Returns the inventory of the object _and_ their inventories, recursively.
		1810
		1811	=cut
		1812
		1813	sub inv_recursive_;
		1814	sub inv_recursive_ {
		1815	map { $_, inv_recursive_ $_->inv } @_
		1816	}
		1817
		1818	sub inv_recursive {
		1819	inv_recursive_ inv $_[0]
		1820	}
		1821
		1822	package cf;
		1823
		1824	=back
1430		1825
1431	=head3 cf::object::player	1826	=head3 cf::object::player
1432		1827
1433	=over 4	1828	=over 4
1434		1829
…		…
1474		1869
1475	=item $player_object->enter_link	1870	=item $player_object->enter_link
1476		1871
1477	Freezes the player and moves him/her to a special map (C<{link}>).	1872	Freezes the player and moves him/her to a special map (C<{link}>).
1478		1873
1479	The player should be reaosnably safe there for short amounts of time. You	1874	The player should be reasonably safe there for short amounts of time. You
1480	I<MUST> call C<leave_link> as soon as possible, though.	1875	I<MUST> call C<leave_link> as soon as possible, though.
1481		1876
		1877	Will never block.
		1878
1482	=item $player_object->leave_link ($map, $x, $y)	1879	=item $player_object->leave_link ($map, $x, $y)
1483		1880
1484	Moves the player out of the specila link map onto the given map. If the	1881	Moves the player out of the special C<{link}> map onto the specified
1485	map is not valid (or omitted), the player will be moved back to the	1882	map. If the map is not valid (or omitted), the player will be moved back
1486	location he/she was before the call to C<enter_link>, or, if that fails,	1883	to the location he/she was before the call to C<enter_link>, or, if that
1487	to the emergency map position.	1884	fails, to the emergency map position.
1488		1885
1489	Might block.	1886	Might block.
1490		1887
1491	=cut	1888	=cut
		1889
		1890	sub link_map {
		1891	unless ($LINK_MAP) {
		1892	$LINK_MAP = cf::map::find "{link}"
		1893	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1894	$LINK_MAP->load;
		1895	}
		1896
		1897	$LINK_MAP
		1898	}
1492		1899
1493	sub cf::object::player::enter_link {	1900	sub cf::object::player::enter_link {
1494	my ($self) = @_;	1901	my ($self) = @_;
1495		1902
1496	$self->deactivate_recursive;	1903	$self->deactivate_recursive;
1497		1904
1498	return if $self->map == $LINK_MAP;	1905	return if UNIVERSAL::isa $self->map, "ext::map_link";
1499		1906
1500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1907	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501	if $self->map;	1908	if $self->map && $self->map->{path} ne "{link}";
1502		1909
1503	$self->enter_map ($LINK_MAP, 20, 20);	1910	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1504	}	1911	}
1505		1912
1506	sub cf::object::player::leave_link {	1913	sub cf::object::player::leave_link {
1507	my ($self, $map, $x, $y) = @_;	1914	my ($self, $map, $x, $y) = @_;
		1915
		1916	return unless $self->contr->active;
1508		1917
1509	my $link_pos = delete $self->{_link_pos};	1918	my $link_pos = delete $self->{_link_pos};
1510		1919
1511	unless ($map) {	1920	unless ($map) {
1512	# restore original map position	1921	# restore original map position
1513	($map, $x, $y) = @{ $link_pos || [] };	1922	($map, $x, $y) = @{ $link_pos || [] };
1514	$map = cf::map::find_map $map;	1923	$map = cf::map::find $map;
1515		1924
1516	unless ($map) {	1925	unless ($map) {
1517	($map, $x, $y) = @$EMERGENCY_POSITION;	1926	($map, $x, $y) = @$EMERGENCY_POSITION;
1518	$map = cf::map::find_map $map	1927	$map = cf::map::find $map
1519	or die "FATAL: cannot load emergency map\n";	1928	or die "FATAL: cannot load emergency map\n";
1520	}	1929	}
1521	}	1930	}
1522		1931
1523	($x, $y) = (-1, -1)	1932	($x, $y) = (-1, -1)
…		…
1526	# use -1 or undef as default coordinates, not 0, 0	1935	# use -1 or undef as default coordinates, not 0, 0
1527	($x, $y) = ($map->enter_x, $map->enter_y)	1936	($x, $y) = ($map->enter_x, $map->enter_y)
1528	if $x <=0 && $y <= 0;	1937	if $x <=0 && $y <= 0;
1529		1938
1530	$map->load;	1939	$map->load;
		1940	$map->load_diag;
1531		1941
		1942	return unless $self->contr->active;
1532	$self->activate_recursive;	1943	$self->activate_recursive;
		1944
		1945	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1533	$self->enter_map ($map, $x, $y);	1946	$self->enter_map ($map, $x, $y);
1534	}	1947	}
1535		1948
1536	cf::player->attach (
1537	on_logout => sub {
1538	my ($pl) = @_;
1539
1540	# abort map switching before logout
1541	if ($pl->ob->{_link_pos}) {
1542	cf::sync_job {
1543	$pl->ob->leave_link
1544	};
1545	}
1546	},
1547	on_login => sub {
1548	my ($pl) = @_;
1549
1550	# try to abort aborted map switching on player login :)
1551	# should happen only on crashes
1552	if ($pl->ob->{_link_pos}) {
1553	$pl->ob->enter_link;
1554	cf::async {
1555	# we need this sleep as the login has a concurrent enter_exit running
1556	# and this sleep increases chances of the player not ending up in scorn
1557	Coro::Timer::sleep 1;
1558	$pl->ob->leave_link;
1559	};
1560	}
1561	},
1562	);
1563
1564	=item $player_object->goto_map ($path, $x, $y)	1949	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1565		1950
1566	=cut	1951	Moves the player to the given map-path and coordinates by first freezing
		1952	her, loading and preparing them map, calling the provided $check callback
		1953	that has to return the map if sucecssful, and then unfreezes the player on
		1954	the new (success) or old (failed) map position.
1567		1955
		1956	=cut
		1957
		1958	our $GOTOGEN;
		1959
1568	sub cf::object::player::goto_map {	1960	sub cf::object::player::goto {
1569	my ($self, $path, $x, $y) = @_;	1961	my ($self, $path, $x, $y, $check) = @_;
		1962
		1963	# do generation counting so two concurrent goto's will be executed in-order
		1964	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1570		1965
1571	$self->enter_link;	1966	$self->enter_link;
1572		1967
1573	(cf::async {	1968	(async {
1574	$path = new cf::path $path;	1969	my $map = eval {
1575
1576	my $map = cf::map::find_map $path->as_string;	1970	my $map = cf::map::find $path;
		1971
		1972	if ($map) {
1577	$map = $map->customise_for ($self) if $map;	1973	$map = $map->customise_for ($self);
1578		1974	$map = $check->($map) if $check && $map;
1579	# warn "entering ", $map->path, " at ($x, $y)\n"	1975	} else {
1580	# if $map;
1581
1582	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	1976	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1977	}
1583		1978
		1979	$map
		1980	};
		1981
		1982	if ($@) {
		1983	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		1984	LOG llevError | logBacktrace, Carp::longmess $@;
		1985	}
		1986
		1987	if ($gen == $self->{_goto_generation}) {
		1988	delete $self->{_goto_generation};
1584	$self->leave_link ($map, $x, $y);	1989	$self->leave_link ($map, $x, $y);
		1990	}
1585	})->prio (1);	1991	})->prio (1);
1586	}	1992	}
1587		1993
1588	=item $player_object->enter_exit ($exit_object)	1994	=item $player_object->enter_exit ($exit_object)
1589		1995
…		…
1591		1997
1592	sub parse_random_map_params {	1998	sub parse_random_map_params {
1593	my ($spec) = @_;	1999	my ($spec) = @_;
1594		2000
1595	my $rmp = { # defaults	2001	my $rmp = { # defaults
1596	xsize => 10,	2002	xsize => (cf::rndm 15, 40),
1597	ysize => 10,	2003	ysize => (cf::rndm 15, 40),
		2004	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2005	#layout => string,
1598	};	2006	};
1599		2007
1600	for (split /\n/, $spec) {	2008	for (split /\n/, $spec) {
1601	my ($k, $v) = split /\s+/, $_, 2;	2009	my ($k, $v) = split /\s+/, $_, 2;
1602		2010
…		…
1606	$rmp	2014	$rmp
1607	}	2015	}
1608		2016
1609	sub prepare_random_map {	2017	sub prepare_random_map {
1610	my ($exit) = @_;	2018	my ($exit) = @_;
		2019
		2020	my $guard = cf::lock_acquire "exit_prepare:$exit";
1611		2021
1612	# all this does is basically replace the /! path by	2022	# all this does is basically replace the /! path by
1613	# a new random map path (?random/...) with a seed	2023	# a new random map path (?random/...) with a seed
1614	# that depends on the exit object	2024	# that depends on the exit object
1615		2025
1616	my $rmp = parse_random_map_params $exit->msg;	2026	my $rmp = parse_random_map_params $exit->msg;
1617		2027
1618	if ($exit->map) {	2028	if ($exit->map) {
1619	$rmp->{region} = $exit->map->region_name;	2029	$rmp->{region} = $exit->region->name;
1620	$rmp->{origin_map} = $exit->map->path;	2030	$rmp->{origin_map} = $exit->map->path;
1621	$rmp->{origin_x} = $exit->x;	2031	$rmp->{origin_x} = $exit->x;
1622	$rmp->{origin_y} = $exit->y;	2032	$rmp->{origin_y} = $exit->y;
1623	}	2033	}
1624		2034
1625	$rmp->{random_seed} ||= $exit->random_seed;	2035	$rmp->{random_seed} ||= $exit->random_seed;
1626		2036
1627	my $data = cf::to_json $rmp;	2037	my $data = cf::to_json $rmp;
1628	my $md5 = Digest::MD5::md5_hex $data;	2038	my $md5 = Digest::MD5::md5_hex $data;
		2039	my $meta = "$RANDOMDIR/$md5.meta";
1629		2040
1630	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2041	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1631	aio_write $fh, 0, (length $data), $data, 0;	2042	aio_write $fh, 0, (length $data), $data, 0;
		2043	undef $fh;
		2044	aio_rename "$meta~", $meta;
1632		2045
1633	$exit->slaying ("?random/$md5");	2046	$exit->slaying ("?random/$md5");
1634	$exit->msg (undef);	2047	$exit->msg (undef);
1635	}	2048	}
1636	}	2049	}
…		…
1638	sub cf::object::player::enter_exit {	2051	sub cf::object::player::enter_exit {
1639	my ($self, $exit) = @_;	2052	my ($self, $exit) = @_;
1640		2053
1641	return unless $self->type == cf::PLAYER;	2054	return unless $self->type == cf::PLAYER;
1642		2055
		2056	if ($exit->slaying eq "/!") {
		2057	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2058	# the problem is that $exit might not survive long enough
		2059	# so it needs to be done right now, right here
		2060	cf::sync_job { prepare_random_map $exit };
		2061	}
		2062
		2063	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2064	my $hp = $exit->stats->hp;
		2065	my $sp = $exit->stats->sp;
		2066
1643	$self->enter_link;	2067	$self->enter_link;
1644		2068
1645	(cf::async {	2069	(async {
		2070	$self->deactivate_recursive; # just to be sure
1646	unless (eval {	2071	unless (eval {
1647	prepare_random_map $exit	2072	$self->goto ($slaying, $hp, $sp);
1648	if $exit->slaying eq "/!";
1649
1650	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1651	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1652		2073
1653	1;	2074	1;
1654	}) {	2075	}) {
1655	$self->message ("Something went wrong deep within the crossfire server. "	2076	$self->message ("Something went wrong deep within the crossfire server. "
1656	. "I'll try to bring you back to the map you were before. "	2077	. "I'll try to bring you back to the map you were before. "
1657	. "Please report this to the dungeon master",	2078	. "Please report this to the dungeon master!",
1658	cf::NDI_UNIQUE | cf::NDI_RED);	2079	cf::NDI_UNIQUE | cf::NDI_RED);
1659		2080
1660	warn "ERROR in enter_exit: $@";	2081	warn "ERROR in enter_exit: $@";
1661	$self->leave_link;	2082	$self->leave_link;
1662	}	2083	}
1663	})->prio (1);	2084	})->prio (1);
…		…
1676		2097
1677	sub cf::client::send_drawinfo {	2098	sub cf::client::send_drawinfo {
1678	my ($self, $text, $flags) = @_;	2099	my ($self, $text, $flags) = @_;
1679		2100
1680	utf8::encode $text;	2101	utf8::encode $text;
1681	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2102	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1682	}	2103	}
1683		2104
		2105	=item $client->ext_event ($type, %msg)
		2106
		2107	Sends an exti event to the client.
		2108
		2109	=cut
		2110
		2111	sub cf::client::ext_event($$%) {
		2112	my ($self, $type, %msg) = @_;
		2113
		2114	$msg{msgtype} = "event_$type";
		2115	$self->send_packet ("ext " . cf::to_json \%msg);
		2116	}
1684		2117
1685	=item $success = $client->query ($flags, "text", \&cb)	2118	=item $success = $client->query ($flags, "text", \&cb)
1686		2119
1687	Queues a query to the client, calling the given callback with	2120	Queues a query to the client, calling the given callback with
1688	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2121	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1713	on_reply => sub {	2146	on_reply => sub {
1714	my ($ns, $msg) = @_;	2147	my ($ns, $msg) = @_;
1715		2148
1716	# this weird shuffling is so that direct followup queries	2149	# this weird shuffling is so that direct followup queries
1717	# get handled first	2150	# get handled first
1718	my $queue = delete $ns->{query_queue};	2151	my $queue = delete $ns->{query_queue}
		2152	or return; # be conservative, not sure how that can happen, but we saw a crash here
1719		2153
1720	(shift @$queue)->[1]->($msg);	2154	(shift @$queue)->[1]->($msg);
		2155	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1721		2156
1722	push @{ $ns->{query_queue} }, @$queue;	2157	push @{ $ns->{query_queue} }, @$queue;
1723		2158
1724	if (@{ $ns->{query_queue} } == @$queue) {	2159	if (@{ $ns->{query_queue} } == @$queue) {
1725	if (@$queue) {	2160	if (@$queue) {
…		…
1729	}	2164	}
1730	}	2165	}
1731	},	2166	},
1732	);	2167	);
1733		2168
1734	=item $client->coro (\&cb)	2169	=item $client->async (\&cb)
1735		2170
1736	Create a new coroutine, running the specified callback. The coroutine will	2171	Create a new coroutine, running the specified callback. The coroutine will
1737	be automatically cancelled when the client gets destroyed (e.g. on logout,	2172	be automatically cancelled when the client gets destroyed (e.g. on logout,
1738	or loss of connection).	2173	or loss of connection).
1739		2174
1740	=cut	2175	=cut
1741		2176
1742	sub cf::client::coro {	2177	sub cf::client::async {
1743	my ($self, $cb) = @_;	2178	my ($self, $cb) = @_;
1744		2179
1745	my $coro = &cf::async ($cb);	2180	my $coro = &Coro::async ($cb);
1746		2181
1747	$coro->on_destroy (sub {	2182	$coro->on_destroy (sub {
1748	delete $self->{_coro}{$coro+0};	2183	delete $self->{_coro}{$coro+0};
1749	});	2184	});
1750		2185
…		…
1783		2218
1784	# here we export the classes and methods available to script code	2219	# here we export the classes and methods available to script code
1785		2220
1786	=pod	2221	=pod
1787		2222
1788	The following fucntions and emthods are available within a safe environment:	2223	The following functions and methods are available within a safe environment:
1789		2224
1790	cf::object contr pay_amount pay_player map	2225	cf::object contr pay_amount pay_player map
1791	cf::object::player player	2226	cf::object::player player
1792	cf::player peaceful	2227	cf::player peaceful
1793	cf::map trigger	2228	cf::map trigger
…		…
1878	#############################################################################	2313	#############################################################################
1879		2314
1880	=head2 EXTENSION DATABASE SUPPORT	2315	=head2 EXTENSION DATABASE SUPPORT
1881		2316
1882	Crossfire maintains a very simple database for extension use. It can	2317	Crossfire maintains a very simple database for extension use. It can
1883	currently store anything that can be serialised using Storable, which	2318	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1884	excludes objects.	2319	convert to/from binary).
1885		2320
1886	The parameter C<$family> should best start with the name of the extension	2321	The parameter C<$family> should best start with the name of the extension
1887	using it, it should be unique.	2322	using it, it should be unique.
1888		2323
1889	=over 4	2324	=over 4
1890		2325
1891	=item $hashref = cf::db_get $family
1892
1893	Return a hashref for use by the extension C<$family>, which can be
1894	modified. After modifications, you have to call C<cf::db_dirty> or
1895	C<cf::db_sync>.
1896
1897	=item $value = cf::db_get $family => $key	2326	=item $value = cf::db_get $family => $key
1898		2327
1899	Returns a single value from the database	2328	Returns a single value from the database.
1900
1901	=item cf::db_put $family => $hashref
1902
1903	Stores the given family hashref into the database. Updates are delayed, if
1904	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1905		2329
1906	=item cf::db_put $family => $key => $value	2330	=item cf::db_put $family => $key => $value
1907		2331
1908	Stores the given C<$value> in the family hash. Updates are delayed, if you	2332	Stores the given C<$value> in the family.
1909	want the data to be synced to disk immediately, use C<cf::db_sync>.
1910
1911	=item cf::db_dirty
1912
1913	Marks the database as dirty, to be updated at a later time.
1914
1915	=item cf::db_sync
1916
1917	Immediately write the database to disk I<if it is dirty>.
1918		2333
1919	=cut	2334	=cut
1920		2335
1921	our $DB;	2336	our $DB;
1922		2337
1923	{	2338	sub db_init {
1924	my $path = cf::localdir . "/database.pst";	2339	unless ($DB) {
		2340	$DB = BDB::db_create $DB_ENV;
1925		2341
1926	sub db_load() {	2342	cf::sync_job {
1927	$DB = stat $path ? Storable::retrieve $path : { };	2343	eval {
1928	}	2344	$DB->set_flags (BDB::CHKSUM);
1929		2345
1930	my $pid;	2346	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1931		2347	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1932	sub db_save() {	2348	cf::cleanup "db_open(db): $!" if $!;
1933	waitpid $pid, 0 if $pid;	2349	};
1934	if (0 == ($pid = fork)) {	2350	cf::cleanup "db_open(db): $@" if $@;
1935	$DB->{_meta}{version} = 1;
1936	Storable::nstore $DB, "$path~";
1937	rename "$path~", $path;
1938	cf::_exit 0 if defined $pid;
1939	}	2351	};
1940	}
1941
1942	my $dirty;
1943
1944	sub db_sync() {
1945	db_save if $dirty;
1946	undef $dirty;
1947	}
1948
1949	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1950	db_sync;
1951	});	2352	}
		2353	}
1952		2354
1953	sub db_dirty() {
1954	$dirty = 1;
1955	$idle->start;
1956	}
1957
1958	sub db_get($;$) {	2355	sub db_get($$) {
1959	@_ >= 2	2356	my $key = "$_[0]/$_[1]";
1960	? $DB->{$_[0]}{$_[1]}
1961	: ($DB->{$_[0]} ||= { })
1962	}
1963		2357
		2358	cf::sync_job {
		2359	BDB::db_get $DB, undef, $key, my $data;
		2360
		2361	$! ? ()
		2362	: $data
		2363	}
		2364	}
		2365
1964	sub db_put($$;$) {	2366	sub db_put($$$) {
1965	if (@_ >= 3) {	2367	BDB::dbreq_pri 4;
1966	$DB->{$_[0]}{$_[1]} = $_[2];	2368	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1967	} else {	2369	}
1968	$DB->{$_[0]} = $_[1];
1969	}
1970	db_dirty;
1971	}
1972		2370
1973	cf::global->attach (	2371	=item cf::cache $id => [$paths...], $processversion => $process
1974	prio => 10000,	2372
1975	on_cleanup => sub {	2373	Generic caching function that returns the value of the resource $id,
1976	db_sync;	2374	caching and regenerating as required.
		2375
		2376	This function can block.
		2377
		2378	=cut
		2379
		2380	sub cache {
		2381	my ($id, $src, $processversion, $process) = @_;
		2382
		2383	my $meta =
		2384	join "\x00",
		2385	$processversion,
		2386	map {
		2387	aio_stat $_
		2388	and Carp::croak "$_: $!";
		2389
		2390	($_, (stat _)[7,9])
		2391	} @$src;
		2392
		2393	my $dbmeta = db_get cache => "$id/meta";
		2394	if ($dbmeta ne $meta) {
		2395	# changed, we may need to process
		2396
		2397	my @data;
		2398	my $md5;
		2399
		2400	for (0 .. $#$src) {
		2401	0 <= aio_load $src->[$_], $data[$_]
		2402	or Carp::croak "$src->[$_]: $!";
1977	},	2403	}
1978	);	2404
		2405	# if processing is expensive, check
		2406	# checksum first
		2407	if (1) {
		2408	$md5 =
		2409	join "\x00",
		2410	$processversion,
		2411	map {
		2412	Coro::cede;
		2413	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2414	} 0.. $#$src;
		2415
		2416
		2417	my $dbmd5 = db_get cache => "$id/md5";
		2418	if ($dbmd5 eq $md5) {
		2419	db_put cache => "$id/meta", $meta;
		2420
		2421	return db_get cache => "$id/data";
		2422	}
		2423	}
		2424
		2425	my $t1 = Time::HiRes::time;
		2426	my $data = $process->(\@data);
		2427	my $t2 = Time::HiRes::time;
		2428
		2429	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2430
		2431	db_put cache => "$id/data", $data;
		2432	db_put cache => "$id/md5" , $md5;
		2433	db_put cache => "$id/meta", $meta;
		2434
		2435	return $data;
		2436	}
		2437
		2438	db_get cache => "$id/data"
		2439	}
		2440
		2441	=item fork_call { }, $args
		2442
		2443	Executes the given code block with the given arguments in a seperate
		2444	process, returning the results. Everything must be serialisable with
		2445	Coro::Storable. May, of course, block. Note that the executed sub may
		2446	never block itself or use any form of Event handling.
		2447
		2448	=cut
		2449
		2450	sub fork_call(&@) {
		2451	my ($cb, @args) = @_;
		2452
		2453	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2454	# or die "socketpair: $!";
		2455	pipe my $fh1, my $fh2
		2456	or die "pipe: $!";
		2457
		2458	if (my $pid = fork) {
		2459	close $fh2;
		2460
		2461	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2462	$res = Coro::Storable::thaw $res;
		2463
		2464	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2465
		2466	die $$res unless "ARRAY" eq ref $res;
		2467
		2468	return wantarray ? @$res : $res->[-1];
		2469	} else {
		2470	reset_signals;
		2471	local $SIG{__WARN__};
		2472	local $SIG{__DIE__};
		2473	eval {
		2474	close $fh1;
		2475
		2476	my @res = eval { $cb->(@args) };
		2477	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2478	};
		2479
		2480	warn $@ if $@;
		2481	_exit 0;
		2482	}
1979	}	2483	}
1980		2484
1981	#############################################################################	2485	#############################################################################
1982	# the server's main()	2486	# the server's init and main functions
		2487
		2488	sub load_facedata($) {
		2489	my ($path) = @_;
		2490
		2491	warn "loading facedata from $path\n";
		2492
		2493	my $facedata;
		2494	0 < aio_load $path, $facedata
		2495	or die "$path: $!";
		2496
		2497	$facedata = Coro::Storable::thaw $facedata;
		2498
		2499	$facedata->{version} == 2
		2500	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2501
		2502	{
		2503	my $faces = $facedata->{faceinfo};
		2504
		2505	while (my ($face, $info) = each %$faces) {
		2506	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2507	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2508	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2509	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2510	Coro::cede;
		2511	}
		2512
		2513	while (my ($face, $info) = each %$faces) {
		2514	next unless $info->{smooth};
		2515	my $idx = cf::face::find $face
		2516	or next;
		2517	if (my $smooth = cf::face::find $info->{smooth}) {
		2518	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2519	} else {
		2520	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2521	}
		2522	Coro::cede;
		2523	}
		2524	}
		2525
		2526	{
		2527	my $anims = $facedata->{animinfo};
		2528
		2529	while (my ($anim, $info) = each %$anims) {
		2530	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2531	Coro::cede;
		2532	}
		2533
		2534	cf::anim::invalidate_all; # d'oh
		2535	}
		2536
		2537	1
		2538	}
		2539
		2540	sub reload_regions {
		2541	load_resource_file "$MAPDIR/regions"
		2542	or die "unable to load regions file\n";
		2543	}
		2544
		2545	sub reload_facedata {
		2546	load_facedata "$DATADIR/facedata"
		2547	or die "unable to load facedata\n";
		2548	}
		2549
		2550	sub reload_archetypes {
		2551	load_resource_file "$DATADIR/archetypes"
		2552	or die "unable to load archetypes\n";
		2553	}
		2554
		2555	sub reload_treasures {
		2556	load_resource_file "$DATADIR/treasures"
		2557	or die "unable to load treasurelists\n";
		2558	}
		2559
		2560	sub reload_resources {
		2561	warn "reloading resource files...\n";
		2562
		2563	reload_regions;
		2564	reload_facedata;
		2565	#reload_archetypes;#d#
		2566	reload_archetypes;
		2567	reload_treasures;
		2568
		2569	warn "finished reloading resource files\n";
		2570	}
		2571
		2572	sub init {
		2573	reload_resources;
		2574	}
1983		2575
1984	sub cfg_load {	2576	sub cfg_load {
1985	open my $fh, "<:utf8", cf::confdir . "/config"	2577	open my $fh, "<:utf8", "$CONFDIR/config"
1986	or return;	2578	or return;
1987		2579
1988	local $/;	2580	local $/;
1989	*CFG = YAML::Syck::Load <$fh>;	2581	*CFG = YAML::Syck::Load <$fh>;
		2582
		2583	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2584
		2585	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2586	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2587
		2588	if (exists $CFG{mlockall}) {
		2589	eval {
		2590	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2591	and die "WARNING: m(un)lockall failed: $!\n";
		2592	};
		2593	warn $@ if $@;
		2594	}
1990	}	2595	}
1991		2596
1992	sub main {	2597	sub main {
1993	# we must not ever block the main coroutine	2598	# we must not ever block the main coroutine
1994	local $Coro::idle = sub {	2599	local $Coro::idle = sub {
1995	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2600	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1996	(Coro::unblock_sub {	2601	(async {
1997	Event::one_event;	2602	Event::one_event;
1998	})->();	2603	})->prio (Coro::PRIO_MAX);
1999	};	2604	};
2000		2605
2001	cfg_load;	2606	cfg_load;
2002	db_load;	2607	db_init;
2003	load_extensions;	2608	load_extensions;
		2609
		2610	$TICK_WATCHER->start;
2004	Event::loop;	2611	Event::loop;
2005	}	2612	}
2006		2613
2007	#############################################################################	2614	#############################################################################
2008	# initialisation	2615	# initialisation and cleanup
2009		2616
		2617	# install some emergency cleanup handlers
		2618	BEGIN {
		2619	for my $signal (qw(INT HUP TERM)) {
		2620	Event->signal (
		2621	reentrant => 0,
		2622	data => WF_AUTOCANCEL,
		2623	signal => $signal,
		2624	prio => 0,
		2625	cb => sub {
		2626	cf::cleanup "SIG$signal";
		2627	},
		2628	);
		2629	}
		2630	}
		2631
		2632	sub emergency_save() {
		2633	my $freeze_guard = cf::freeze_mainloop;
		2634
		2635	warn "enter emergency perl save\n";
		2636
		2637	cf::sync_job {
		2638	# use a peculiar iteration method to avoid tripping on perl
		2639	# refcount bugs in for. also avoids problems with players
		2640	# and maps saved/destroyed asynchronously.
		2641	warn "begin emergency player save\n";
		2642	for my $login (keys %cf::PLAYER) {
		2643	my $pl = $cf::PLAYER{$login} or next;
		2644	$pl->valid or next;
		2645	$pl->save;
		2646	}
		2647	warn "end emergency player save\n";
		2648
		2649	warn "begin emergency map save\n";
		2650	for my $path (keys %cf::MAP) {
		2651	my $map = $cf::MAP{$path} or next;
		2652	$map->valid or next;
		2653	$map->save;
		2654	}
		2655	warn "end emergency map save\n";
		2656
		2657	warn "begin emergency database checkpoint\n";
		2658	BDB::db_env_txn_checkpoint $DB_ENV;
		2659	warn "end emergency database checkpoint\n";
		2660	};
		2661
		2662	warn "leave emergency perl save\n";
		2663	}
		2664
		2665	sub post_cleanup {
		2666	my ($make_core) = @_;
		2667
		2668	warn Carp::longmess "post_cleanup backtrace"
		2669	if $make_core;
		2670	}
		2671
2010	sub reload() {	2672	sub do_reload_perl() {
2011	# can/must only be called in main	2673	# can/must only be called in main
2012	if ($Coro::current != $Coro::main) {	2674	if ($Coro::current != $Coro::main) {
2013	warn "can only reload from main coroutine\n";	2675	warn "can only reload from main coroutine";
2014	return;	2676	return;
2015	}	2677	}
2016		2678
2017	warn "reloading...";	2679	warn "reloading...";
2018		2680
2019	local $FREEZE = 1;	2681	warn "entering sync_job";
		2682
		2683	cf::sync_job {
		2684	cf::write_runtime; # external watchdog should not bark
2020	cf::emergency_save;	2685	cf::emergency_save;
		2686	cf::write_runtime; # external watchdog should not bark
2021		2687
2022	eval {	2688	warn "syncing database to disk";
		2689	BDB::db_env_txn_checkpoint $DB_ENV;
		2690
2023	# if anything goes wrong in here, we should simply crash as we already saved	2691	# if anything goes wrong in here, we should simply crash as we already saved
2024		2692
2025	# cancel all watchers	2693	warn "cancelling all WF_AUTOCANCEL watchers";
2026	for (Event::all_watchers) {	2694	for (Event::all_watchers) {
2027	$_->cancel if $_->data & WF_AUTOCANCEL;	2695	$_->cancel if $_->data & WF_AUTOCANCEL;
2028	}	2696	}
2029		2697
		2698	warn "flushing outstanding aio requests";
		2699	for (;;) {
		2700	BDB::flush;
		2701	IO::AIO::flush;
		2702	Coro::cede;
		2703	last unless IO::AIO::nreqs || BDB::nreqs;
		2704	warn "iterate...";
		2705	}
		2706
		2707	++$RELOAD;
		2708
2030	# cancel all extension coros	2709	warn "cancelling all extension coros";
2031	$_->cancel for values %EXT_CORO;	2710	$_->cancel for values %EXT_CORO;
2032	%EXT_CORO = ();	2711	%EXT_CORO = ();
2033		2712
2034	# unload all extensions	2713	warn "removing commands";
2035	for (@exts) {	2714	%COMMAND = ();
		2715
		2716	warn "removing ext commands";
		2717	%EXTCMD = ();
		2718
		2719	warn "unloading/nuking all extensions";
		2720	for my $pkg (@EXTS) {
2036	warn "unloading <$_>";	2721	warn "... unloading $pkg";
2037	unload_extension $_;	2722
		2723	if (my $cb = $pkg->can ("unload")) {
		2724	eval {
		2725	$cb->($pkg);
		2726	1
		2727	} or warn "$pkg unloaded, but with errors: $@";
2038	}	2728	}
2039		2729
		2730	warn "... nuking $pkg";
		2731	Symbol::delete_package $pkg;
		2732	}
		2733
2040	# unload all modules loaded from $LIBDIR	2734	warn "unloading all perl modules loaded from $LIBDIR";
2041	while (my ($k, $v) = each %INC) {	2735	while (my ($k, $v) = each %INC) {
2042	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2736	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2043		2737
2044	warn "removing <$k>";	2738	warn "... unloading $k";
2045	delete $INC{$k};	2739	delete $INC{$k};
2046		2740
2047	$k =~ s/\.pm$//;	2741	$k =~ s/\.pm$//;
2048	$k =~ s/\//::/g;	2742	$k =~ s/\//::/g;
2049		2743
…		…
2052	}	2746	}
2053		2747
2054	Symbol::delete_package $k;	2748	Symbol::delete_package $k;
2055	}	2749	}
2056		2750
2057	# sync database to disk
2058	cf::db_sync;
2059	IO::AIO::flush;
2060
2061	# get rid of safe::, as good as possible	2751	warn "getting rid of safe::, as good as possible";
2062	Symbol::delete_package "safe::$_"	2752	Symbol::delete_package "safe::$_"
2063	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2753	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2064		2754
2065	# remove register_script_function callbacks
2066	# TODO
2067
2068	# unload cf.pm "a bit"	2755	warn "unloading cf.pm \"a bit\"";
2069	delete $INC{"cf.pm"};	2756	delete $INC{"cf.pm"};
		2757	delete $INC{"cf/pod.pm"};
2070		2758
2071	# don't, removes xs symbols, too,	2759	# don't, removes xs symbols, too,
2072	# and global variables created in xs	2760	# and global variables created in xs
2073	#Symbol::delete_package __PACKAGE__;	2761	#Symbol::delete_package __PACKAGE__;
2074		2762
2075	# reload cf.pm	2763	warn "unload completed, starting to reload now";
		2764
2076	warn "reloading cf.pm";	2765	warn "reloading cf.pm";
2077	require cf;	2766	require cf;
2078	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2767	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2079		2768
2080	# load config and database again	2769	warn "loading config and database again";
2081	cf::cfg_load;	2770	cf::cfg_load;
2082	cf::db_load;
2083		2771
2084	# load extensions
2085	warn "load extensions";	2772	warn "loading extensions";
2086	cf::load_extensions;	2773	cf::load_extensions;
2087		2774
2088	# reattach attachments to objects	2775	warn "reattaching attachments to objects/players";
2089	warn "reattach";	2776	_global_reattach; # objects, sockets
2090	_global_reattach;	2777	warn "reattaching attachments to maps";
2091	};	2778	reattach $_ for values %MAP;
		2779	warn "reattaching attachments to players";
		2780	reattach $_ for values %PLAYER;
2092		2781
2093	if ($@) {	2782	warn "leaving sync_job";
		2783
		2784	1
		2785	} or do {
2094	warn $@;	2786	warn $@;
2095	warn "error while reloading, exiting.";	2787	warn "error while reloading, exiting.";
2096	exit 1;	2788	exit 1;
2097	}	2789	};
2098		2790
2099	warn "reloaded successfully";	2791	warn "reloaded";
2100	};	2792	};
2101		2793
2102	#############################################################################	2794	our $RELOAD_WATCHER; # used only during reload
2103		2795
2104	unless ($LINK_MAP) {	2796	sub reload_perl() {
2105	$LINK_MAP = cf::map::new;	2797	# doing reload synchronously and two reloads happen back-to-back,
		2798	# coro crashes during coro_state_free->destroy here.
2106		2799
2107	$LINK_MAP->width (41);	2800	$RELOAD_WATCHER ||= Event->timer (
2108	$LINK_MAP->height (41);	2801	reentrant => 0,
2109	$LINK_MAP->alloc;
2110	$LINK_MAP->path ("{link}");
2111	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2112	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2113
2114	# dirty hack because... archetypes are not yet loaded
2115	Event->timer (
2116	after => 2,	2802	after => 0,
		2803	data => WF_AUTOCANCEL,
2117	cb => sub {	2804	cb => sub {
2118	$_[0]->w->cancel;	2805	do_reload_perl;
2119		2806	undef $RELOAD_WATCHER;
2120	# provide some exits "home"
2121	my $exit = cf::object::new "exit";
2122
2123	$exit->slaying ($EMERGENCY_POSITION->[0]);
2124	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2125	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2126
2127	$LINK_MAP->insert ($exit->clone, 19, 19);
2128	$LINK_MAP->insert ($exit->clone, 19, 20);
2129	$LINK_MAP->insert ($exit->clone, 19, 21);
2130	$LINK_MAP->insert ($exit->clone, 20, 19);
2131	$LINK_MAP->insert ($exit->clone, 20, 21);
2132	$LINK_MAP->insert ($exit->clone, 21, 19);
2133	$LINK_MAP->insert ($exit->clone, 21, 20);
2134	$LINK_MAP->insert ($exit->clone, 21, 21);
2135
2136	$exit->destroy;
2137	});	2807	},
2138		2808	);
2139	$LINK_MAP->{deny_save} = 1;
2140	$LINK_MAP->{deny_reset} = 1;
2141
2142	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2143	}	2809	}
2144
2145	register "<global>", __PACKAGE__;
2146		2810
2147	register_command "reload" => sub {	2811	register_command "reload" => sub {
2148	my ($who, $arg) = @_;	2812	my ($who, $arg) = @_;
2149		2813
2150	if ($who->flag (FLAG_WIZ)) {	2814	if ($who->flag (FLAG_WIZ)) {
2151	$who->message ("start of reload.");
2152	reload;
2153	$who->message ("end of reload.");	2815	$who->message ("reloading server.");
		2816	async { reload_perl };
2154	}	2817	}
2155	};	2818	};
2156		2819
2157	unshift @INC, $LIBDIR;	2820	unshift @INC, $LIBDIR;
2158		2821
		2822	my $bug_warning = 0;
		2823
		2824	our @WAIT_FOR_TICK;
		2825	our @WAIT_FOR_TICK_BEGIN;
		2826
		2827	sub wait_for_tick {
		2828	return unless $TICK_WATCHER->is_active;
		2829	return if $Coro::current == $Coro::main;
		2830
		2831	my $signal = new Coro::Signal;
		2832	push @WAIT_FOR_TICK, $signal;
		2833	$signal->wait;
		2834	}
		2835
		2836	sub wait_for_tick_begin {
		2837	return unless $TICK_WATCHER->is_active;
		2838	return if $Coro::current == $Coro::main;
		2839
		2840	my $signal = new Coro::Signal;
		2841	push @WAIT_FOR_TICK_BEGIN, $signal;
		2842	$signal->wait;
		2843	}
		2844
		2845	my $min = 1e6;#d#
		2846	my $avg = 10;
2159	$TICK_WATCHER = Event->timer (	2847	$TICK_WATCHER = Event->timer (
2160	reentrant => 0,	2848	reentrant => 0,
		2849	parked => 1,
2161	prio => 0,	2850	prio => 0,
2162	at => $NEXT_TICK || $TICK,	2851	at => $NEXT_TICK || $TICK,
2163	data => WF_AUTOCANCEL,	2852	data => WF_AUTOCANCEL,
2164	cb => sub {	2853	cb => sub {
2165	unless ($FREEZE) {	2854	if ($Coro::current != $Coro::main) {
		2855	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2856	unless ++$bug_warning > 10;
		2857	return;
		2858	}
		2859
		2860	$NOW = $tick_start = Event::time;
		2861
2166	cf::server_tick; # one server iteration	2862	cf::server_tick; # one server iteration
2167	$RUNTIME += $TICK;	2863
		2864	0 && sync_job {#d#
		2865	for(1..10) {
		2866	my $t = Event::time;
		2867	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2868	or die;
		2869
		2870	$map->width (50);
		2871	$map->height (50);
		2872	$map->alloc;
		2873	$map->_load_objects ("/tmp/x.map", 1);
		2874	my $t = Event::time - $t;
		2875
		2876	#next unless $t < 0.0013;#d#
		2877	if ($t < $min) {
		2878	$min = $t;
		2879	}
		2880	$avg = $avg * 0.99 + $t * 0.01;
		2881	}
		2882	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2883	exit 0;
		2884	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2168	}	2885	};
2169		2886
		2887	$RUNTIME += $TICK;
2170	$NEXT_TICK += $TICK;	2888	$NEXT_TICK += $TICK;
2171		2889
		2890	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2891	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2892	Coro::async_pool {
		2893	write_runtime
		2894	or warn "ERROR: unable to write runtime file: $!";
		2895	};
		2896	}
		2897
		2898	# my $AFTER = Event::time;
		2899	# warn $AFTER - $NOW;#d#
		2900
		2901	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2902	$sig->send;
		2903	}
		2904	while (my $sig = shift @WAIT_FOR_TICK) {
		2905	$sig->send;
		2906	}
		2907
		2908	$NOW = Event::time;
		2909
2172	# if we are delayed by four ticks or more, skip them all	2910	# if we are delayed by four ticks or more, skip them all
2173	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2911	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2174		2912
2175	$TICK_WATCHER->at ($NEXT_TICK);	2913	$TICK_WATCHER->at ($NEXT_TICK);
2176	$TICK_WATCHER->start;	2914	$TICK_WATCHER->start;
		2915
		2916	$LOAD = ($NOW - $tick_start) / $TICK;
		2917	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2918
		2919	_post_tick;
		2920
		2921
2177	},	2922	},
2178	);	2923	);
2179		2924
		2925	{
2180	IO::AIO::max_poll_time $TICK * 0.2;	2926	BDB::max_poll_time $TICK * 0.1;
2181		2927	$BDB_POLL_WATCHER = Event->io (
2182	Event->io (	2928	reentrant => 0,
2183	fd => IO::AIO::poll_fileno,	2929	fd => BDB::poll_fileno,
2184	poll => 'r',	2930	poll => 'r',
2185	prio => 5,	2931	prio => 0,
2186	data => WF_AUTOCANCEL,
2187	cb => \&IO::AIO::poll_cb,
2188	);
2189
2190	Event->timer (
2191	data => WF_AUTOCANCEL,	2932	data => WF_AUTOCANCEL,
2192	after => 0,	2933	cb => \&BDB::poll_cb,
2193	interval => 10,	2934	);
2194	cb => sub {	2935	BDB::min_parallel 8;
2195	(Coro::unblock_sub {	2936
2196	write_runtime	2937	BDB::set_sync_prepare {
2197	or warn "ERROR: unable to write runtime file: $!";	2938	my $status;
		2939	my $current = $Coro::current;
		2940	(
		2941	sub {
		2942	$status = $!;
		2943	$current->ready; undef $current;
		2944	},
		2945	sub {
		2946	Coro::schedule while defined $current;
		2947	$! = $status;
		2948	},
		2949	)
		2950	};
		2951
		2952	unless ($DB_ENV) {
		2953	$DB_ENV = BDB::db_env_create;
		2954
		2955	cf::sync_job {
		2956	eval {
		2957	BDB::db_env_open
		2958	$DB_ENV,
		2959	$BDBDIR,
		2960	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2961	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2962	0666;
		2963
		2964	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		2965
		2966	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2967	$DB_ENV->set_lk_detect;
		2968	};
		2969
		2970	cf::cleanup "db_env_open(db): $@" if $@;
2198	})->();	2971	};
2199	},	2972	}
2200	);	2973	}
		2974
		2975	{
		2976	IO::AIO::min_parallel 8;
		2977
		2978	undef $Coro::AIO::WATCHER;
		2979	IO::AIO::max_poll_time $TICK * 0.1;
		2980	$AIO_POLL_WATCHER = Event->io (
		2981	reentrant => 0,
		2982	data => WF_AUTOCANCEL,
		2983	fd => IO::AIO::poll_fileno,
		2984	poll => 'r',
		2985	prio => 6,
		2986	cb => \&IO::AIO::poll_cb,
		2987	);
		2988	}
		2989
		2990	my $_log_backtrace;
		2991
		2992	sub _log_backtrace {
		2993	my ($msg, @addr) = @_;
		2994
		2995	$msg =~ s/\n//;
		2996
		2997	# limit the # of concurrent backtraces
		2998	if ($_log_backtrace < 2) {
		2999	++$_log_backtrace;
		3000	async {
		3001	my @bt = fork_call {
		3002	@addr = map { sprintf "%x", $_ } @addr;
		3003	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3004	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3005	or die "addr2line: $!";
		3006
		3007	my @funcs;
		3008	my @res = <$fh>;
		3009	chomp for @res;
		3010	while (@res) {
		3011	my ($func, $line) = splice @res, 0, 2, ();
		3012	push @funcs, "[$func] $line";
		3013	}
		3014
		3015	@funcs
		3016	};
		3017
		3018	LOG llevInfo, "[ABT] $msg\n";
		3019	LOG llevInfo, "[ABT] $_\n" for @bt;
		3020	--$_log_backtrace;
		3021	};
		3022	} else {
		3023	LOG llevInfo, "[ABT] $msg\n";
		3024	LOG llevInfo, "[ABT] [suppressed]\n";
		3025	}
		3026	}
		3027
		3028	# load additional modules
		3029	use cf::pod;
2201		3030
2202	END { cf::emergency_save }	3031	END { cf::emergency_save }
2203		3032
2204	1	3033	1
2205		3034

Diff Legend

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