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.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.170 by root, Sun Jan 14 02:00:37 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
10	use IO::AIO ();	23	use IO::AIO 2.32 ();
11	use YAML::Syck ();	24	use YAML::Syck ();
12	use Time::HiRes;	25	use Time::HiRes;
13	use Event;	26
14	$Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
18		33
19	use strict;	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		35
21	_init_vars;
22
23	our %COMMAND = ();	36	our %COMMAND = ();
		37	our %COMMAND_TIME = ();
		38
		39	our @EXTS = (); # list of extension package names
		40	our %EXTCMD = ();
		41	our %EXT_CORO = (); # coroutines bound to extensions
		42	our %EXT_MAP = (); # pluggable maps
		43
24	our @EVENT;	44	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	45	our $LIBDIR = datadir . "/ext";
26		46
27	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	48	our $TICK_WATCHER;
		49	our $AIO_POLL_WATCHER;
		50	our $WRITE_RUNTIME_WATCHER;
29	our $NEXT_TICK;	51	our $NEXT_TICK;
		52	our $NOW;
30		53
31	our %CFG;	54	our %CFG;
32		55
33	our $UPTIME; $UPTIME ||= time;	56	our $UPTIME; $UPTIME ||= time;
		57	our $RUNTIME;
		58
		59	our %PLAYER; # all users
		60	our %MAP; # all maps
		61	our $LINK_MAP; # the special {link} map, which is always available
		62	our $RANDOM_MAPS = cf::localdir . "/random";
		63
		64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		66
		67	# used to convert map paths into valid unix filenames by replacing / by ∕
		68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		69
		70	binmode STDOUT;
		71	binmode STDERR;
		72
		73	# read virtual server time, if available
		74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		75	open my $fh, "<", cf::localdir . "/runtime"
		76	or die "unable to read runtime file: $!";
		77	$RUNTIME = <$fh> + 0.;
		78	}
		79
		80	mkdir cf::localdir;
		81	mkdir cf::localdir . "/" . cf::playerdir;
		82	mkdir cf::localdir . "/" . cf::tmpdir;
		83	mkdir cf::localdir . "/" . cf::uniquedir;
		84	mkdir $RANDOM_MAPS;
		85
		86	our $EMERGENCY_POSITION;
34		87
35	#############################################################################	88	#############################################################################
36		89
37	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
38		91
39	=over 4	92	=over 4
40		93
41	=item $cf::UPTIME	94	=item $cf::UPTIME
42		95
43	The timestamp of the server start (so not actually an uptime).	96	The timestamp of the server start (so not actually an uptime).
		97
		98	=item $cf::RUNTIME
		99
		100	The time this server has run, starts at 0 and is increased by $cf::TICK on
		101	every server tick.
44		102
45	=item $cf::LIBDIR	103	=item $cf::LIBDIR
46		104
47	The perl library directory, where extensions and cf-specific modules can	105	The perl library directory, where extensions and cf-specific modules can
48	be found. It will be added to C<@INC> automatically.	106	be found. It will be added to C<@INC> automatically.
49		107
		108	=item $cf::NOW
		109
		110	The time of the last (current) server tick.
		111
50	=item $cf::TICK	112	=item $cf::TICK
51		113
52	The interval between server ticks, in seconds.	114	The interval between server ticks, in seconds.
53		115
54	=item %cf::CFG	116	=item %cf::CFG
55		117
56	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
57	from wherever your confdir points to.	119	from wherever your confdir points to.
		120
		121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		122
		123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		125	processing has been done. Call C<< ->wait >> on them to maximise the
		126	window of cpu time available, or simply to synchronise to the server tick.
58		127
59	=back	128	=back
60		129
61	=cut	130	=cut
62		131
63	BEGIN {	132	BEGIN {
64	*CORE::GLOBAL::warn = sub {	133	*CORE::GLOBAL::warn = sub {
65	my $msg = join "", @_;	134	my $msg = join "", @_;
		135	utf8::encode $msg;
		136
66	$msg .= "\n"	137	$msg .= "\n"
67	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
68		139
69	print STDERR "cfperl: $msg";
70	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
71	};	141	};
72	}	142	}
73		143
		144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
74	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
75		150
76	# we bless all objects into (empty) derived classes to force a method lookup	151	# we bless all objects into (empty) derived classes to force a method lookup
77	# within the Safe compartment.	152	# within the Safe compartment.
78	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	153	for my $pkg (qw(
		154	cf::global cf::attachable
		155	cf::object cf::object::player
		156	cf::client cf::player
		157	cf::arch cf::living
		158	cf::map cf::party cf::region
		159	)) {
79	no strict 'refs';	160	no strict 'refs';
80	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
81	}	162	}
82		163
83	$Event::DIED = sub {	164	$Event::DIED = sub {
84	warn "error in event callback: @_";	165	warn "error in event callback: @_";
85	};	166	};
86		167
87	my %ext_pkg;
88	my @exts;
89	my @hook;
90	my %command;
91	my %extcmd;
92
93	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
94		169
95	=over 4	170	=over 4
96		171
		172	=item dumpval $ref
		173
97	=cut	174	=cut
		175
		176	sub dumpval {
		177	eval {
		178	local $SIG{__DIE__};
		179	my $d;
		180	if (1) {
		181	$d = new Data::Dumper([$_[0]], ["*var"]);
		182	$d->Terse(1);
		183	$d->Indent(2);
		184	$d->Quotekeys(0);
		185	$d->Useqq(1);
		186	#$d->Bless(...);
		187	$d->Seen($_[1]) if @_ > 1;
		188	$d = $d->Dump();
		189	}
		190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		191	$d
		192	} || "[unable to dump $_[0]: '$@']";
		193	}
98		194
99	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
100		196
101	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
102		198
…		…
118	sub to_json($) {	214	sub to_json($) {
119	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
120	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
121	}	217	}
122		218
		219	=item cf::lock_wait $string
		220
		221	Wait until the given lock is available. See cf::lock_acquire.
		222
		223	=item my $lock = cf::lock_acquire $string
		224
		225	Wait until the given lock is available and then acquires it and returns
		226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		227	for example when the coroutine gets canceled), the lock is automatically
		228	returned.
		229
		230	Lock names should begin with a unique identifier (for example, cf::map::find
		231	uses map_find and cf::map::load uses map_load).
		232
		233	=cut
		234
		235	our %LOCK;
		236
		237	sub lock_wait($) {
		238	my ($key) = @_;
		239
		240	# wait for lock, if any
		241	while ($LOCK{$key}) {
		242	push @{ $LOCK{$key} }, $Coro::current;
		243	Coro::schedule;
		244	}
		245	}
		246
		247	sub lock_acquire($) {
		248	my ($key) = @_;
		249
		250	# wait, to be sure we are not locked
		251	lock_wait $key;
		252
		253	$LOCK{$key} = [];
		254
		255	Coro::guard {
		256	# wake up all waiters, to be on the safe side
		257	$_->ready for @{ delete $LOCK{$key} };
		258	}
		259	}
		260
		261	sub freeze_mainloop {
		262	return unless $TICK_WATCHER->is_active;
		263
		264	my $guard = Coro::guard {
		265	$TICK_WATCHER->start;
		266	$WRITE_RUNTIME_WATCHER->start;
		267	};
		268	$WRITE_RUNTIME_WATCHER->stop;
		269	$TICK_WATCHER->stop;
		270	$guard
		271	}
		272
		273	=item cf::async { BLOCK }
		274
		275	Currently the same as Coro::async_pool, meaning you cannot use
		276	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		277	thing you are allowed to do is call C<prio> on it.
		278
		279	=cut
		280
		281	BEGIN { *async = \&Coro::async_pool }
		282
		283	=item cf::sync_job { BLOCK }
		284
		285	The design of crossfire+ requires that the main coro ($Coro::main) is
		286	always able to handle events or runnable, as crossfire+ is only partly
		287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		288
		289	If it must be done, put the blocking parts into C<sync_job>. This will run
		290	the given BLOCK in another coroutine while waiting for the result. The
		291	server will be frozen during this time, so the block should either finish
		292	fast or be very important.
		293
		294	=cut
		295
		296	sub sync_job(&) {
		297	my ($job) = @_;
		298
		299	if ($Coro::current == $Coro::main) {
		300	# this is the main coro, too bad, we have to block
		301	# till the operation succeeds, freezing the server :/
		302
		303	# TODO: use suspend/resume instead
		304	# (but this is cancel-safe)
		305	my $freeze_guard = freeze_mainloop;
		306
		307	my $busy = 1;
		308	my @res;
		309
		310	(async {
		311	@res = eval { $job->() };
		312	warn $@ if $@;
		313	undef $busy;
		314	})->prio (Coro::PRIO_MAX);
		315
		316	while ($busy) {
		317	Coro::cede or Event::one_event;
		318	}
		319
		320	wantarray ? @res : $res[0]
		321	} else {
		322	# we are in another coroutine, how wonderful, everything just works
		323
		324	$job->()
		325	}
		326	}
		327
		328	=item $coro = cf::async_ext { BLOCK }
		329
		330	Like async, but this coro is automatically being canceled when the
		331	extension calling this is being unloaded.
		332
		333	=cut
		334
		335	sub async_ext(&) {
		336	my $cb = shift;
		337
		338	my $coro = &Coro::async ($cb);
		339
		340	$coro->on_destroy (sub {
		341	delete $EXT_CORO{$coro+0};
		342	});
		343	$EXT_CORO{$coro+0} = $coro;
		344
		345	$coro
		346	}
		347
		348	sub write_runtime {
		349	my $runtime = cf::localdir . "/runtime";
		350
		351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		352	or return;
		353
		354	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		355	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		356	and return;
		357
		358	aio_fsync $fh
		359	and return;
		360
		361	close $fh
		362	or return;
		363
		364	aio_rename "$runtime~", $runtime
		365	and return;
		366
		367	1
		368	}
		369
123	=back	370	=back
124		371
125	=cut	372	=cut
126		373
127	#############################################################################	374	#############################################################################
128		375
129	=head2 EVENTS AND OBJECT ATTACHMENTS	376	=head2 ATTACHABLE OBJECTS
		377
		378	Many objects in crossfire are so-called attachable objects. That means you can
		379	attach callbacks/event handlers (a collection of which is called an "attachment")
		380	to it. All such attachable objects support the following methods.
		381
		382	In the following description, CLASS can be any of C<global>, C<object>
		383	C<player>, C<client> or C<map> (i.e. the attachable objects in
		384	crossfire+).
130		385
131	=over 4	386	=over 4
132		387
133	=item $object->attach ($attachment, key => $value...)
134
135	=item $object->detach ($attachment)
136
137	Attach/detach a pre-registered attachment to an object.
138
139	=item $player->attach ($attachment, key => $value...)
140
141	=item $player->detach ($attachment)
142
143	Attach/detach a pre-registered attachment to a player.
144
145	=item $map->attach ($attachment, key => $value...)	388	=item $attachable->attach ($attachment, key => $value...)
146		389
147	=item $map->detach ($attachment)	390	=item $attachable->detach ($attachment)
148		391
149	Attach/detach a pre-registered attachment to a map.	392	Attach/detach a pre-registered attachment to a specific object and give it
		393	the specified key/value pairs as arguments.
150		394
151	=item $bool = $object->attached ($name)	395	Example, attach a minesweeper attachment to the given object, making it a
		396	10x10 minesweeper game:
152		397
153	=item $bool = $player->attached ($name)	398	$obj->attach (minesweeper => width => 10, height => 10);
154		399
155	=item $bool = $map->attached ($name)	400	=item $bool = $attachable->attached ($name)
156		401
157	Checks wether the named attachment is currently attached to the object.	402	Checks wether the named attachment is currently attached to the object.
158		403
159	=item cf::attach_global ...	404	=item cf::CLASS->attach ...
160		405
161	Attach handlers for global events.	406	=item cf::CLASS->detach ...
162		407
163	This and all following C<attach_*>-functions expect any number of the	408	Define an anonymous attachment and attach it to all objects of the given
164	following handler/hook descriptions:	409	CLASS. See the next function for an explanation of its arguments.
		410
		411	You can attach to global events by using the C<cf::global> class.
		412
		413	Example, log all player logins:
		414
		415	cf::player->attach (
		416	on_login => sub {
		417	my ($pl) = @_;
		418	...
		419	},
		420	);
		421
		422	Example, attach to the jeweler skill:
		423
		424	cf::object->attach (
		425	type => cf::SKILL,
		426	subtype => cf::SK_JEWELER,
		427	on_use_skill => sub {
		428	my ($sk, $ob, $part, $dir, $msg) = @_;
		429	...
		430	},
		431	);
		432
		433	=item cf::CLASS::attachment $name, ...
		434
		435	Register an attachment by C<$name> through which attachable objects of the
		436	given CLASS can refer to this attachment.
		437
		438	Some classes such as crossfire maps and objects can specify attachments
		439	that are attached at load/instantiate time, thus the need for a name.
		440
		441	These calls expect any number of the following handler/hook descriptions:
165		442
166	=over 4	443	=over 4
167		444
168	=item prio => $number	445	=item prio => $number
169		446
…		…
171	by another C<prio> setting). Lower priority handlers get executed	448	by another C<prio> setting). Lower priority handlers get executed
172	earlier. The default priority is C<0>, and many built-in handlers are	449	earlier. The default priority is C<0>, and many built-in handlers are
173	registered at priority C<-1000>, so lower priorities should not be used	450	registered at priority C<-1000>, so lower priorities should not be used
174	unless you know what you are doing.	451	unless you know what you are doing.
175		452
		453	=item type => $type
		454
		455	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		456	given type of objects only (the additional parameter C<subtype> can be
		457	used to further limit to the given subtype).
		458
176	=item on_I<event> => \&cb	459	=item on_I<event> => \&cb
177		460
178	Call the given code reference whenever the named event happens (event is	461	Call the given code reference whenever the named event happens (event is
179	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	462	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
180	handlers are recognised generally depends on the type of object these	463	handlers are recognised generally depends on the type of object these
…		…
189	package and register them. Only handlers for eevents supported by the	472	package and register them. Only handlers for eevents supported by the
190	object/class are recognised.	473	object/class are recognised.
191		474
192	=back	475	=back
193		476
194	=item cf::attach_to_type $object_type, $subtype, ...	477	Example, define an attachment called "sockpuppet" that calls the given
		478	event handler when a monster attacks:
195		479
196	Attach handlers for a specific object type (e.g. TRANSPORT) and	480	cf::object::attachment sockpuppet =>
197	subtype. If C<$subtype> is zero or undef, matches all objects of the given	481	on_skill_attack => sub {
198	type.	482	my ($self, $victim) = @_;
199		483	...
200	=item cf::attach_to_objects ...
201
202	Attach handlers to all objects. Do not use this except for debugging or
203	very rare events, as handlers are (obviously) called for I<all> objects in
204	the game.
205
206	=item cf::attach_to_players ...
207
208	Attach handlers to all players.
209
210	=item cf::attach_to_maps ...
211
212	Attach handlers to all maps.
213
214	=item cf:register_attachment $name, ...
215
216	Register an attachment by name through which objects can refer to this
217	attachment.
218
219	=item cf:register_player_attachment $name, ...
220
221	Register an attachment by name through which players can refer to this
222	attachment.
223
224	=item cf:register_map_attachment $name, ...
225
226	Register an attachment by name through which maps can refer to this
227	attachment.
228
229	=cut
230
231	# the following variables are defined in .xs and must not be re-created
232	our @CB_GLOBAL = (); # registry for all global events
233	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
234	our @CB_PLAYER = ();
235	our @CB_TYPE = (); # registry for type (cf-object class) based events
236	our @CB_MAP = ();
237
238	my %attachment;
239
240	sub _attach_cb($\%$$$) {
241	my ($registry, $undo, $event, $prio, $cb) = @_;
242
243	use sort 'stable';
244
245	$cb = [$prio, $cb];
246
247	@{$registry->[$event]} = sort
248	{ $a->[0] cmp $b->[0] }
249	@{$registry->[$event] || []}, $cb;
250
251	push @{$undo->{cb}}, [$event, $cb];
252	}
253
254	# attach handles attaching event callbacks
255	# the only thing the caller has to do is pass the correct
256	# registry (== where the callback attaches to).
257	sub _attach(\@$@) {
258	my ($registry, $klass, @arg) = @_;
259
260	my $prio = 0;
261
262	my %undo = (
263	registry => $registry,
264	cb => [],
265	);
266
267	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
268
269	while (@arg) {
270	my $type = shift @arg;
271
272	if ($type eq "prio") {
273	$prio = shift @arg;
274
275	} elsif ($type eq "package") {
276	my $pkg = shift @arg;
277
278	while (my ($name, $id) = each %cb_id) {
279	if (my $cb = $pkg->can ($name)) {
280	_attach_cb $registry, %undo, $id, $prio, $cb;
281	}
282	}	484	}
283
284	} elsif (exists $cb_id{$type}) {
285	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
286
287	} elsif (ref $type) {
288	warn "attaching objects not supported, ignoring.\n";
289
290	} else {
291	shift @arg;
292	warn "attach argument '$type' not supported, ignoring.\n";
293	}
294	}
295
296	\%undo
297	}
298
299	sub _attach_attachment {
300	my ($obj, $name, %arg) = @_;
301
302	return if exists $obj->{_attachment}{$name};
303
304	my $res;
305
306	if (my $attach = $attachment{$name}) {
307	my $registry = $obj->registry;
308
309	for (@$attach) {
310	my ($klass, @attach) = @$_;
311	$res = _attach @$registry, $klass, @attach;
312	}
313
314	$obj->{$name} = \%arg;
315	} else {
316	warn "object uses attachment '$name' that is not available, postponing.\n";
317	}
318
319	$obj->{_attachment}{$name} = undef;
320
321	$res->{attachment} = $name;
322	$res
323	}
324
325	*cf::object::attach =
326	*cf::player::attach =
327	*cf::map::attach = sub {
328	my ($obj, $name, %arg) = @_;
329
330	_attach_attachment $obj, $name, %arg;
331	};
332
333	# all those should be optimised
334	*cf::object::detach =
335	*cf::player::detach =
336	*cf::map::detach = sub {
337	my ($obj, $name) = @_;
338
339	delete $obj->{_attachment}{$name};
340	reattach ($obj);
341	};
342
343	*cf::object::attached =
344	*cf::player::attached =
345	*cf::map::attached = sub {
346	my ($obj, $name) = @_;
347
348	exists $obj->{_attachment}{$name}
349	};
350
351	sub attach_global {
352	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
353	}
354
355	sub attach_to_type {
356	my $type = shift;
357	my $subtype = shift;
358
359	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
360	}
361
362	sub attach_to_objects {
363	_attach @CB_OBJECT, KLASS_OBJECT, @_
364	}
365
366	sub attach_to_players {
367	_attach @CB_PLAYER, KLASS_PLAYER, @_
368	}
369
370	sub attach_to_maps {
371	_attach @CB_MAP, KLASS_MAP, @_
372	}
373
374	sub register_attachment {
375	my $name = shift;
376
377	$attachment{$name} = [[KLASS_OBJECT, @_]];
378	}
379
380	sub register_player_attachment {
381	my $name = shift;
382
383	$attachment{$name} = [[KLASS_PLAYER, @_]];
384	}
385
386	sub register_map_attachment {
387	my $name = shift;
388
389	$attachment{$name} = [[KLASS_MAP, @_]];
390	}
391
392	our $override;
393	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
394
395	sub override {
396	$override = 1;
397	@invoke_results = ();
398	}
399
400	sub do_invoke {
401	my $event = shift;
402	my $callbacks = shift;
403
404	@invoke_results = ();
405
406	local $override;
407
408	for (@$callbacks) {
409	eval { &{$_->[1]} };
410
411	if ($@) {
412	warn "$@";
413	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
414	override;
415	}
416
417	return 1 if $override;
418	}
419
420	0	485	}
421	}
422		486
423	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	487	=item $attachable->valid
424
425	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
426
427	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
428
429	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
430
431	Generate a global/object/player/map-specific event with the given arguments.
432
433	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
434	removed in future versions), and there is no public API to access override
435	results (if you must, access C<@cf::invoke_results> directly).
436
437	=back
438
439	=cut
440
441	#############################################################################
442
443	=head2 METHODS VALID FOR ALL CORE OBJECTS
444
445	=over 4
446
447	=item $object->valid, $player->valid, $map->valid
448		488
449	Just because you have a perl object does not mean that the corresponding	489	Just because you have a perl object does not mean that the corresponding
450	C-level object still exists. If you try to access an object that has no	490	C-level object still exists. If you try to access an object that has no
451	valid C counterpart anymore you get an exception at runtime. This method	491	valid C counterpart anymore you get an exception at runtime. This method
452	can be used to test for existence of the C object part without causing an	492	can be used to test for existence of the C object part without causing an
453	exception.	493	exception.
454		494
		495	=cut
		496
		497	# the following variables are defined in .xs and must not be re-created
		498	our @CB_GLOBAL = (); # registry for all global events
		499	our @CB_ATTACHABLE = (); # registry for all attachables
		500	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		501	our @CB_PLAYER = ();
		502	our @CB_CLIENT = ();
		503	our @CB_TYPE = (); # registry for type (cf-object class) based events
		504	our @CB_MAP = ();
		505
		506	my %attachment;
		507
		508	sub cf::attachable::thawer_merge {
		509	# simply override everything except _meta
		510	local $_[0]{_meta};
		511	%{$_[0]} = %{$_[1]};
		512	}
		513
		514	sub _attach_cb($$$$) {
		515	my ($registry, $event, $prio, $cb) = @_;
		516
		517	use sort 'stable';
		518
		519	$cb = [$prio, $cb];
		520
		521	@{$registry->[$event]} = sort
		522	{ $a->[0] cmp $b->[0] }
		523	@{$registry->[$event] || []}, $cb;
		524	}
		525
		526	# hack
		527	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		528
		529	# attach handles attaching event callbacks
		530	# the only thing the caller has to do is pass the correct
		531	# registry (== where the callback attaches to).
		532	sub _attach {
		533	my ($registry, $klass, @arg) = @_;
		534
		535	my $object_type;
		536	my $prio = 0;
		537	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		538
		539	#TODO: get rid of this hack
		540	if ($attachable_klass{$klass}) {
		541	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		542	}
		543
		544	while (@arg) {
		545	my $type = shift @arg;
		546
		547	if ($type eq "prio") {
		548	$prio = shift @arg;
		549
		550	} elsif ($type eq "type") {
		551	$object_type = shift @arg;
		552	$registry = $CB_TYPE[$object_type] ||= [];
		553
		554	} elsif ($type eq "subtype") {
		555	defined $object_type or Carp::croak "subtype specified without type";
		556	my $object_subtype = shift @arg;
		557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		558
		559	} elsif ($type eq "package") {
		560	my $pkg = shift @arg;
		561
		562	while (my ($name, $id) = each %cb_id) {
		563	if (my $cb = $pkg->can ($name)) {
		564	_attach_cb $registry, $id, $prio, $cb;
		565	}
		566	}
		567
		568	} elsif (exists $cb_id{$type}) {
		569	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		570
		571	} elsif (ref $type) {
		572	warn "attaching objects not supported, ignoring.\n";
		573
		574	} else {
		575	shift @arg;
		576	warn "attach argument '$type' not supported, ignoring.\n";
		577	}
		578	}
		579	}
		580
		581	sub _object_attach {
		582	my ($obj, $name, %arg) = @_;
		583
		584	return if exists $obj->{_attachment}{$name};
		585
		586	if (my $attach = $attachment{$name}) {
		587	my $registry = $obj->registry;
		588
		589	for (@$attach) {
		590	my ($klass, @attach) = @$_;
		591	_attach $registry, $klass, @attach;
		592	}
		593
		594	$obj->{$name} = \%arg;
		595	} else {
		596	warn "object uses attachment '$name' that is not available, postponing.\n";
		597	}
		598
		599	$obj->{_attachment}{$name} = undef;
		600	}
		601
		602	sub cf::attachable::attach {
		603	if (ref $_[0]) {
		604	_object_attach @_;
		605	} else {
		606	_attach shift->_attach_registry, @_;
		607	}
		608	};
		609
		610	# all those should be optimised
		611	sub cf::attachable::detach {
		612	my ($obj, $name) = @_;
		613
		614	if (ref $obj) {
		615	delete $obj->{_attachment}{$name};
		616	reattach ($obj);
		617	} else {
		618	Carp::croak "cannot, currently, detach class attachments";
		619	}
		620	};
		621
		622	sub cf::attachable::attached {
		623	my ($obj, $name) = @_;
		624
		625	exists $obj->{_attachment}{$name}
		626	}
		627
		628	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		629	eval "#line " . __LINE__ . " 'cf.pm'
		630	sub cf::\L$klass\E::_attach_registry {
		631	(\\\@CB_$klass, KLASS_$klass)
		632	}
		633
		634	sub cf::\L$klass\E::attachment {
		635	my \$name = shift;
		636
		637	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		638	}
		639	";
		640	die if $@;
		641	}
		642
		643	our $override;
		644	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		645
		646	sub override {
		647	$override = 1;
		648	@invoke_results = ();
		649	}
		650
		651	sub do_invoke {
		652	my $event = shift;
		653	my $callbacks = shift;
		654
		655	@invoke_results = ();
		656
		657	local $override;
		658
		659	for (@$callbacks) {
		660	eval { &{$_->[1]} };
		661
		662	if ($@) {
		663	warn "$@";
		664	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		665	override;
		666	}
		667
		668	return 1 if $override;
		669	}
		670
		671	0
		672	}
		673
		674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		675
		676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		677
		678	Generate an object-specific event with the given arguments.
		679
		680	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		681	removed in future versions), and there is no public API to access override
		682	results (if you must, access C<@cf::invoke_results> directly).
		683
455	=back	684	=back
456		685
457	=cut	686	=cut
458
459	*cf::object::valid =
460	*cf::player::valid =
461	*cf::map::valid = \&cf::_valid;
462		687
463	#############################################################################	688	#############################################################################
464	# object support	689	# object support
465		690
466	sub instantiate {
467	my ($obj, $data) = @_;
468
469	$data = from_json $data;
470
471	for (@$data) {
472	my ($name, $args) = @$_;
473
474	$obj->attach ($name, %{$args || {} });
475	}
476	}
477
478	# basically do the same as instantiate, without calling instantiate
479	sub reattach {	691	sub reattach {
		692	# basically do the same as instantiate, without calling instantiate
480	my ($obj) = @_;	693	my ($obj) = @_;
		694
		695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		696
481	my $registry = $obj->registry;	697	my $registry = $obj->registry;
482		698
483	@$registry = ();	699	@$registry = ();
484		700
485	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	701	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
486		702
487	for my $name (keys %{ $obj->{_attachment} || {} }) {	703	for my $name (keys %{ $obj->{_attachment} || {} }) {
488	if (my $attach = $attachment{$name}) {	704	if (my $attach = $attachment{$name}) {
489	for (@$attach) {	705	for (@$attach) {
490	my ($klass, @attach) = @$_;	706	my ($klass, @attach) = @$_;
491	_attach @$registry, $klass, @attach;	707	_attach $registry, $klass, @attach;
492	}	708	}
493	} else {	709	} else {
494	warn "object uses attachment '$name' that is not available, postponing.\n";	710	warn "object uses attachment '$name' that is not available, postponing.\n";
495	}	711	}
496	}	712	}
497	}	713	}
498		714
499	sub object_freezer_save {	715	cf::attachable->attach (
500	my ($filename, $rdata, $objs) = @_;
501
502	if (length $$rdata) {
503	warn sprintf "saving %s (%d,%d)\n",
504	$filename, length $$rdata, scalar @$objs;
505
506	if (open my $fh, ">:raw", "$filename~") {
507	chmod SAVE_MODE, $fh;
508	syswrite $fh, $$rdata;
509	close $fh;
510
511	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
512	chmod SAVE_MODE, $fh;
513	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
514	close $fh;
515	rename "$filename.pst~", "$filename.pst";
516	} else {
517	unlink "$filename.pst";
518	}
519
520	rename "$filename~", $filename;
521	} else {
522	warn "FATAL: $filename~: $!\n";
523	}
524	} else {
525	unlink $filename;
526	unlink "$filename.pst";
527	}
528	}
529
530	sub object_freezer_as_string {
531	my ($rdata, $objs) = @_;
532
533	use Data::Dumper;
534
535	$$rdata . Dumper $objs
536	}
537
538	sub object_thawer_load {
539	my ($filename) = @_;
540
541	local $/;
542
543	my $av;
544
545	#TODO: use sysread etc.
546	if (open my $data, "<:raw:perlio", $filename) {
547	$data = <$data>;
548	if (open my $pst, "<:raw:perlio", "$filename.pst") {
549	$av = eval { (Storable::thaw <$pst>)->{objs} };
550	}
551	return ($data, $av);
552	}
553
554	()
555	}
556
557	attach_to_objects
558	prio => -1000000,	716	prio => -1000000,
		717	on_instantiate => sub {
		718	my ($obj, $data) = @_;
		719
		720	$data = from_json $data;
		721
		722	for (@$data) {
		723	my ($name, $args) = @$_;
		724
		725	$obj->attach ($name, %{$args || {} });
		726	}
		727	},
		728	on_reattach => \&reattach,
559	on_clone => sub {	729	on_clone => sub {
560	my ($src, $dst) = @_;	730	my ($src, $dst) = @_;
561		731
562	@{$dst->registry} = @{$src->registry};	732	@{$dst->registry} = @{$src->registry};
563		733
564	%$dst = %$src;	734	%$dst = %$src;
565		735
566	%{$dst->{_attachment}} = %{$src->{_attachment}}	736	%{$dst->{_attachment}} = %{$src->{_attachment}}
567	if exists $src->{_attachment};	737	if exists $src->{_attachment};
568	},	738	},
569	;	739	);
		740
		741	sub object_freezer_save {
		742	my ($filename, $rdata, $objs) = @_;
		743
		744	sync_job {
		745	if (length $$rdata) {
		746	warn sprintf "saving %s (%d,%d)\n",
		747	$filename, length $$rdata, scalar @$objs;
		748
		749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		750	chmod SAVE_MODE, $fh;
		751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		752	aio_fsync $fh;
		753	close $fh;
		754
		755	if (@$objs) {
		756	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		757	chmod SAVE_MODE, $fh;
		758	my $data = Storable::nfreeze { version => 1, objs => $objs };
		759	aio_write $fh, 0, (length $data), $data, 0;
		760	aio_fsync $fh;
		761	close $fh;
		762	aio_rename "$filename.pst~", "$filename.pst";
		763	}
		764	} else {
		765	aio_unlink "$filename.pst";
		766	}
		767
		768	aio_rename "$filename~", $filename;
		769	} else {
		770	warn "FATAL: $filename~: $!\n";
		771	}
		772	} else {
		773	aio_unlink $filename;
		774	aio_unlink "$filename.pst";
		775	}
		776	}
		777	}
		778
		779	sub object_freezer_as_string {
		780	my ($rdata, $objs) = @_;
		781
		782	use Data::Dumper;
		783
		784	$$rdata . Dumper $objs
		785	}
		786
		787	sub object_thawer_load {
		788	my ($filename) = @_;
		789
		790	my ($data, $av);
		791
		792	(aio_load $filename, $data) >= 0
		793	or return;
		794
		795	unless (aio_stat "$filename.pst") {
		796	(aio_load "$filename.pst", $av) >= 0
		797	or return;
		798	$av = eval { (Storable::thaw $av)->{objs} };
		799	}
		800
		801	warn sprintf "loading %s (%d)\n",
		802	$filename, length $data, scalar @{$av || []};#d#
		803	return ($data, $av);
		804	}
570		805
571	#############################################################################	806	#############################################################################
572	# old plug-in events	807	# command handling &c
573		808
574	sub inject_event {	809	=item cf::register_command $name => \&callback($ob,$args);
575	my $extension = shift;
576	my $event_code = shift;
577		810
578	my $cb = $hook[$event_code]{$extension}	811	Register a callback for execution when the client sends the user command
579	or return;	812	$name.
580		813
581	&$cb	814	=cut
582	}
583
584	sub inject_global_event {
585	my $event = shift;
586
587	my $cb = $hook[$event]
588	or return;
589
590	List::Util::max map &$_, values %$cb
591	}
592
593	sub inject_command {
594	my ($name, $obj, $params) = @_;
595
596	for my $cmd (@{ $command{$name} }) {
597	$cmd->[1]->($obj, $params);
598	}
599
600	-1
601	}
602		815
603	sub register_command {	816	sub register_command {
604	my ($name, $time, $cb) = @_;	817	my ($name, $cb) = @_;
605		818
606	my $caller = caller;	819	my $caller = caller;
607	#warn "registering command '$name/$time' to '$caller'";	820	#warn "registering command '$name/$time' to '$caller'";
608		821
609	push @{ $command{$name} }, [$time, $cb, $caller];	822	push @{ $COMMAND{$name} }, [$caller, $cb];
610	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
611	}	823	}
		824
		825	=item cf::register_extcmd $name => \&callback($pl,$packet);
		826
		827	Register a callbackf ro execution when the client sends an extcmd packet.
		828
		829	If the callback returns something, it is sent back as if reply was being
		830	called.
		831
		832	=cut
612		833
613	sub register_extcmd {	834	sub register_extcmd {
614	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
615		836
616	my $caller = caller;	837	$EXTCMD{$name} = $cb;
617	#warn "registering extcmd '$name' to '$caller'";
618
619	$extcmd{$name} = [$cb, $caller];
620	}	838	}
621		839
622	sub register {	840	cf::player->attach (
623	my ($base, $pkg) = @_;	841	on_command => sub {
		842	my ($pl, $name, $params) = @_;
624		843
625	#TODO	844	my $cb = $COMMAND{$name}
626	}	845	or return;
		846
		847	for my $cmd (@$cb) {
		848	$cmd->[1]->($pl->ob, $params);
		849	}
		850
		851	cf::override;
		852	},
		853	on_extcmd => sub {
		854	my ($pl, $buf) = @_;
		855
		856	my $msg = eval { from_json $buf };
		857
		858	if (ref $msg) {
		859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		860	if (my %reply = $cb->($pl, $msg)) {
		861	$pl->ext_reply ($msg->{msgid}, %reply);
		862	}
		863	}
		864	} else {
		865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		866	}
		867
		868	cf::override;
		869	},
		870	);
627		871
628	sub load_extension {	872	sub load_extension {
629	my ($path) = @_;	873	my ($path) = @_;
630		874
631	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
632	my $base = $1;	876	my $base = $1;
633	my $pkg = $1;	877	my $pkg = $1;
634	$pkg =~ s/[^[:word:]]/_/g;	878	$pkg =~ s/[^[:word:]]/_/g;
635	$pkg = "ext::$pkg";	879	$pkg = "ext::$pkg";
636		880
637	warn "loading '$path' into '$pkg'\n";	881	warn "... loading '$path' into '$pkg'\n";
638		882
639	open my $fh, "<:utf8", $path	883	open my $fh, "<:utf8", $path
640	or die "$path: $!";	884	or die "$path: $!";
641		885
642	my $source =	886	my $source =
643	"package $pkg; use strict; use utf8;\n"	887	"package $pkg; use strict; use utf8;\n"
644	. "#line 1 \"$path\"\n{\n"	888	. "#line 1 \"$path\"\n{\n"
645	. (do { local $/; <$fh> })	889	. (do { local $/; <$fh> })
646	. "\n};\n1";	890	. "\n};\n1";
647		891
648	eval $source	892	unless (eval $source) {
649	or die $@ ? "$path: $@\n"	893	my $msg = $@ ? "$path: $@\n"
650	: "extension disabled.\n";	894	: "extension disabled.\n";
651		895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
652	push @exts, $pkg;	896	warn $@;
653	$ext_pkg{$base} = $pkg;	897	warn "mandatory extension failed to load, exiting.\n";
654		898	exit 1;
655	# no strict 'refs';	899	}
656	# @{"$pkg\::ISA"} = ext::;	900	die $@;
657
658	register $base, $pkg;
659	}
660
661	sub unload_extension {
662	my ($pkg) = @_;
663
664	warn "removing extension $pkg\n";
665
666	# remove hooks
667	#TODO
668	# for my $idx (0 .. $#PLUGIN_EVENT) {
669	# delete $hook[$idx]{$pkg};
670	# }	901	}
671		902
672	# remove commands	903	push @EXTS, $pkg;
673	for my $name (keys %command) {
674	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
675
676	if (@cb) {
677	$command{$name} = \@cb;
678	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
679	} else {
680	delete $command{$name};
681	delete $COMMAND{"$name\000"};
682	}
683	}
684
685	# remove extcmds
686	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
687	delete $extcmd{$name};
688	}
689
690	if (my $cb = $pkg->can ("unload")) {
691	eval {
692	$cb->($pkg);
693	1
694	} or warn "$pkg unloaded, but with errors: $@";
695	}
696
697	Symbol::delete_package $pkg;
698	}	904	}
699		905
700	sub load_extensions {	906	sub load_extensions {
701	my $LIBDIR = maps_directory "perl";
702
703	for my $ext (<$LIBDIR/*.ext>) {	907	for my $ext (<$LIBDIR/*.ext>) {
704	next unless -r $ext;	908	next unless -r $ext;
705	eval {	909	eval {
706	load_extension $ext;	910	load_extension $ext;
707	1	911	1
708	} or warn "$ext not loaded: $@";	912	} or warn "$ext not loaded: $@";
709	}	913	}
710	}	914	}
711		915
712	#############################################################################	916	#############################################################################
713	# extcmd framework, basically convert ext <msg>
714	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
715		917
716	attach_to_players	918	=head2 CORE EXTENSIONS
717	on_extcmd => sub {
718	my ($pl, $buf) = @_;
719		919
720	my $msg = eval { from_json $buf };	920	Functions and methods that extend core crossfire objects.
721		921
722	if (ref $msg) {	922	=cut
723	if (my $cb = $extcmd{$msg->{msgtype}}) {	923
724	if (my %reply = $cb->[0]->($pl, $msg)) {	924	package cf::player;
725	$pl->ext_reply ($msg->{msgid}, %reply);	925
726	}	926	use Coro::AIO;
		927
		928	=head3 cf::player
		929
		930	=over 4
		931
		932	=item cf::player::find $login
		933
		934	Returns the given player object, loading it if necessary (might block).
		935
		936	=cut
		937
		938	sub playerdir($) {
		939	cf::localdir
		940	. "/"
		941	. cf::playerdir
		942	. "/"
		943	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		944	}
		945
		946	sub path($) {
		947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		948
		949	(playerdir $login) . "/$login.pl"
		950	}
		951
		952	sub find_active($) {
		953	$cf::PLAYER{$_[0]}
		954	and $cf::PLAYER{$_[0]}->active
		955	and $cf::PLAYER{$_[0]}
		956	}
		957
		958	sub exists($) {
		959	my ($login) = @_;
		960
		961	$cf::PLAYER{$login}
		962	or cf::sync_job { !aio_stat $login }
		963	}
		964
		965	sub find($) {
		966	return $cf::PLAYER{$_[0]} || do {
		967	my $login = $_[0];
		968
		969	my $guard = cf::lock_acquire "user_find:$login";
		970
		971	$cf::PLAYER{$_[0]} || do {
		972	my $pl = load_pl path $login
		973	or return;
		974	$cf::PLAYER{$login} = $pl
727	}	975	}
728	} else {
729	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
730	}
731
732	cf::override;
733	},	976	}
734	;	977	}
735		978
736	#############################################################################	979	sub save($) {
737	# load/save/clean perl data associated with a map	980	my ($pl) = @_;
738		981
739	*cf::mapsupport::on_clean = sub {	982	return if $pl->{deny_save};
		983
		984	my $path = path $pl;
		985	my $guard = cf::lock_acquire "user_save:$path";
		986
		987	return if $pl->{deny_save};
		988
		989	aio_mkdir playerdir $pl, 0770;
		990	$pl->{last_save} = $cf::RUNTIME;
		991
		992	$pl->save_pl ($path);
		993	Coro::cede;
		994	}
		995
		996	sub new($) {
		997	my ($login) = @_;
		998
		999	my $self = create;
		1000
		1001	$self->ob->name ($login);
		1002	$self->{deny_save} = 1;
		1003
		1004	$cf::PLAYER{$login} = $self;
		1005
		1006	$self
		1007	}
		1008
		1009	=item $pl->quit_character
		1010
		1011	Nukes the player without looking back. If logged in, the connection will
		1012	be destroyed. May block for a long time.
		1013
		1014	=cut
		1015
		1016	sub quit_character {
		1017	my ($pl) = @_;
		1018
		1019	$pl->{deny_save} = 1;
		1020	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1021
		1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1023	$pl->deactivate;
		1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1025	$pl->ns->destroy if $pl->ns;
		1026
		1027	my $path = playerdir $pl;
		1028	my $temp = "$path~$cf::RUNTIME~deleting~";
		1029	aio_rename $path, $temp;
		1030	delete $cf::PLAYER{$pl->ob->name};
		1031	$pl->destroy;
		1032	IO::AIO::aio_rmtree $temp;
		1033	}
		1034
		1035	=item cf::player::list_logins
		1036
		1037	Returns am arrayref of all valid playernames in the system, can take a
		1038	while and may block, so not sync_job-capable, ever.
		1039
		1040	=cut
		1041
		1042	sub list_logins {
		1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1044	or return [];
		1045
		1046	my @logins;
		1047
		1048	for my $login (@$dirs) {
		1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1050	aio_read $fh, 0, 512, my $buf, 0 or next;
		1051	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1052
		1053	utf8::decode $login;
		1054	push @logins, $login;
		1055	}
		1056
		1057	\@logins
		1058	}
		1059
		1060	=item $player->maps
		1061
		1062	Returns an arrayref of map paths that are private for this
		1063	player. May block.
		1064
		1065	=cut
		1066
		1067	sub maps($) {
		1068	my ($pl) = @_;
		1069
		1070	my $files = aio_readdir playerdir $pl
		1071	or return;
		1072
		1073	my @paths;
		1074
		1075	for (@$files) {
		1076	utf8::decode $_;
		1077	next if /\.(?:pl|pst)$/;
		1078	next unless /^$PATH_SEP/o;
		1079
		1080	s/\.map$//;
		1081	push @paths, "~" . $pl->ob->name . "/" . $_;
		1082	}
		1083
		1084	\@paths
		1085	}
		1086
		1087	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1088
		1089	Sends an ext reply to the player.
		1090
		1091	=cut
		1092
		1093	sub ext_reply($$$%) {
		1094	my ($self, $id, %msg) = @_;
		1095
		1096	$msg{msgid} = $id;
		1097
		1098	$self->send ("ext " . cf::to_json \%msg);
		1099	}
		1100
		1101	package cf;
		1102
		1103	=back
		1104
		1105
		1106	=head3 cf::map
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	package cf::map;
		1113
		1114	use Fcntl;
		1115	use Coro::AIO;
		1116
		1117	use overload
		1118	'""' => \&as_string;
		1119
		1120	our $MAX_RESET = 3600;
		1121	our $DEFAULT_RESET = 3000;
		1122
		1123	sub generate_random_map {
		1124	my ($self, $rmp) = @_;
		1125
		1126	# mit "rum" bekleckern, nicht
		1127	$self->_create_random_map (
		1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1131	$rmp->{exit_on_final_map},
		1132	$rmp->{xsize}, $rmp->{ysize},
		1133	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1134	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1135	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1136	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1138	(cf::region::find $rmp->{region}), $rmp->{custom}
		1139	)
		1140	}
		1141
		1142	sub register {
		1143	my (undef, $regex) = @_;
		1144	my $pkg = caller;
		1145
		1146	no strict;
		1147	push @{"$pkg\::ISA"}, __PACKAGE__;
		1148
		1149	$EXT_MAP{$pkg} = qr<$regex>;
		1150	}
		1151
		1152	# also paths starting with '/'
		1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};
		1154
		1155	sub thawer_merge {
		1156	# we have to keep some variables in memory intact
		1157	local $_[0]{path};
		1158	local $_[0]{deny_save};
		1159	local $_[0]{deny_reset};
		1160
		1161	$_[0]->SUPER::thawer_merge ($_[1]);
		1162	}
		1163
		1164	sub normalise {
		1165	my ($path, $base) = @_;
		1166
		1167	# map plan:
		1168	#
		1169	# /! non-realised random map exit (special hack!)
		1170	# {... are special paths that are not being touched
		1171	# ?xxx/... are special absolute paths
		1172	# ?random/... random maps
		1173	# /... normal maps
		1174	# ~user/... per-player map of a specific user
		1175
		1176	$path =~ s/$PATH_SEP/\//go;
		1177
		1178	# treat it as relative path if it starts with
		1179	# something that looks reasonable
		1180	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1181	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1182
		1183	$base =~ s{[^/]+/?$}{};
		1184	$path = "$base/$path";
		1185	}
		1186
		1187	for ($path) {
		1188	redo if s{//}{/};
		1189	redo if s{/\.?/}{/};
		1190	redo if s{/[^/]+/\.\./}{/};
		1191	}
		1192
		1193	$path
		1194	}
		1195
		1196	sub new_from_path {
		1197	my (undef, $path, $base) = @_;
		1198
		1199	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1200
		1201	$path = normalise $path, $base;
		1202
		1203	for my $pkg (keys %EXT_MAP) {
		1204	if ($path =~ $EXT_MAP{$pkg}) {
		1205	my $self = bless cf::map::new, $pkg;
		1206	$self->{path} = $path; $self->path ($path);
		1207	$self->init; # pass $1 etc.
		1208	return $self;
		1209	}
		1210	}
		1211
		1212	Carp::carp "unable to resolve path '$path'.";
		1213	()
		1214	}
		1215
		1216	sub init {
		1217	my ($self) = @_;
		1218
		1219	$self
		1220	}
		1221
		1222	sub as_string {
		1223	my ($self) = @_;
		1224
		1225	"$self->{path}"
		1226	}
		1227
		1228	# the displayed name, this is a one way mapping
		1229	sub visible_name {
		1230	&as_string
		1231	}
		1232
		1233	# the original (read-only) location
		1234	sub load_path {
		1235	my ($self) = @_;
		1236
		1237	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1238	}
		1239
		1240	# the temporary/swap location
		1241	sub save_path {
		1242	my ($self) = @_;
		1243
		1244	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1245	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1246	}
		1247
		1248	# the unique path, undef == no special unique path
		1249	sub uniq_path {
		1250	my ($self) = @_;
		1251
		1252	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1253	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1254	}
		1255
		1256	# and all this just because we cannot iterate over
		1257	# all maps in C++...
		1258	sub change_all_map_light {
		1259	my ($change) = @_;
		1260
		1261	$_->change_map_light ($change)
		1262	for grep $_->outdoor, values %cf::MAP;
		1263	}
		1264
		1265	sub unlink_save {
		1266	my ($self) = @_;
		1267
		1268	utf8::encode (my $save = $self->save_path);
		1269	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1270	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1271	}
		1272
		1273	sub load_header_from($) {
		1274	my ($self, $path) = @_;
		1275
		1276	utf8::encode $path;
		1277	aio_open $path, O_RDONLY, 0
		1278	or return;
		1279
		1280	$self->_load_header ($path)
		1281	or return;
		1282
		1283	$self->{load_path} = $path;
		1284
		1285	1
		1286	}
		1287
		1288	sub load_orig {
		1289	my ($self) = @_;
		1290
		1291	$self->load_header_from ($self->load_path)
		1292	}
		1293
		1294	sub load_temp {
		1295	my ($self) = @_;
		1296
		1297	$self->load_header_from ($self->save_path)
		1298	}
		1299
		1300	sub load_header {
		1301	my ($self) = @_;
		1302
		1303	if ($self->load_temp) {
		1304	$self->last_access ((delete $self->{last_access})
		1305	|| $cf::RUNTIME); #d#
		1306	# safety
		1307	$self->{instantiate_time} = $cf::RUNTIME
		1308	if $self->{instantiate_time} > $cf::RUNTIME;
		1309	} else {
		1310	$self->load_orig
		1311	or return;
		1312
		1313	$self->{load_original} = 1;
		1314	$self->{instantiate_time} = $cf::RUNTIME;
		1315	$self->last_access ($cf::RUNTIME);
		1316	$self->instantiate;
		1317	}
		1318
		1319	1
		1320	}
		1321
		1322	sub find;
		1323	sub find {
		1324	my ($path, $origin) = @_;
		1325
		1326	$path = normalise $path, $origin && $origin->path;
		1327
		1328	cf::lock_wait "map_find:$path";
		1329
		1330	$cf::MAP{$path} || do {
		1331	my $guard = cf::lock_acquire "map_find:$path";
		1332	my $map = new_from_path cf::map $path
		1333	or return;
		1334
		1335	$map->{last_save} = $cf::RUNTIME;
		1336
		1337	$map->load_header
		1338	or return;
		1339
		1340	if ($map->should_reset) {
		1341	$map->reset;
		1342	undef $guard;
		1343	$map = find $path
		1344	or return;
		1345	}
		1346
		1347	$cf::MAP{$path} = $map
		1348	}
		1349	}
		1350
		1351	sub load {
		1352	my ($self) = @_;
		1353
		1354	my $path = $self->{path};
		1355	my $guard = cf::lock_acquire "map_load:$path";
		1356
		1357	return if $self->in_memory != cf::MAP_SWAPPED;
		1358
		1359	$self->in_memory (cf::MAP_LOADING);
		1360
		1361	$self->alloc;
		1362	$self->_load_objects ($self->{load_path}, 1)
		1363	or return;
		1364
		1365	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1366	if delete $self->{load_original};
		1367
		1368	if (my $uniq = $self->uniq_path) {
		1369	utf8::encode $uniq;
		1370	if (aio_open $uniq, O_RDONLY, 0) {
		1371	$self->clear_unique_items;
		1372	$self->_load_objects ($uniq, 0);
		1373	}
		1374	}
		1375
		1376	Coro::cede;
		1377
		1378	# now do the right thing for maps
		1379	$self->link_multipart_objects;
		1380
		1381	unless ($self->{deny_activate}) {
		1382	$self->decay_objects;
		1383	$self->fix_auto_apply;
		1384	$self->update_buttons;
		1385	Coro::cede;
		1386	$self->set_darkness_map;
		1387	$self->difficulty ($self->estimate_difficulty)
		1388	unless $self->difficulty;
		1389	Coro::cede;
		1390	$self->activate;
		1391	}
		1392
		1393	$self->in_memory (cf::MAP_IN_MEMORY);
		1394	}
		1395
		1396	sub customise_for {
		1397	my ($self, $ob) = @_;
		1398
		1399	return find "~" . $ob->name . "/" . $self->{path}
		1400	if $self->per_player;
		1401
		1402	$self
		1403	}
		1404
		1405	# find and load all maps in the 3x3 area around a map
		1406	sub load_diag {
740	my ($map) = @_;	1407	my ($map) = @_;
741		1408
742	my $path = $map->tmpname;	1409	my @diag; # diagonal neighbours
743	defined $path or return;
744		1410
745	unlink "$path.pst";	1411	for (0 .. 3) {
		1412	my $neigh = $map->tile_path ($_)
		1413	or next;
		1414	$neigh = find $neigh, $map
		1415	or next;
		1416	$neigh->load;
		1417
		1418	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1419	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1420	}
		1421
		1422	for (@diag) {
		1423	my $neigh = find @$_
		1424	or next;
		1425	$neigh->load;
		1426	}
		1427	}
		1428
		1429	sub find_sync {
		1430	my ($path, $origin) = @_;
		1431
		1432	cf::sync_job { find $path, $origin }
		1433	}
		1434
		1435	sub do_load_sync {
		1436	my ($map) = @_;
		1437
		1438	cf::sync_job { $map->load };
		1439	}
		1440
		1441	our %MAP_PREFETCH;
		1442	our $MAP_PREFETCHER = Coro::async {
		1443	while () {
		1444	for my $path (keys %MAP_PREFETCH) {
		1445	my $map = find $path
		1446	or next;
		1447	$map->load;
		1448
		1449	delete $MAP_PREFETCH{$path};
		1450	}
		1451	Coro::schedule;
		1452	}
746	};	1453	};
747		1454
748	attach_to_maps prio => -10000, package => cf::mapsupport::;	1455	sub find_async {
		1456	my ($path, $origin) = @_;
749		1457
750	#############################################################################	1458	$path = normalise $path, $origin && $origin->{path};
751	# load/save perl data associated with player->ob objects
752		1459
753	sub all_objects(@) {	1460	if (my $map = $cf::MAP{$path}) {
754	@_, map all_objects ($_->inv), @_	1461	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
755	}
756
757	# TODO: compatibility cruft, remove when no longer needed
758	attach_to_players
759	on_load => sub {
760	my ($pl, $path) = @_;
761
762	for my $o (all_objects $pl->ob) {
763	if (my $value = $o->get_ob_key_value ("_perl_data")) {
764	$o->set_ob_key_value ("_perl_data");
765
766	%$o = %{ Storable::thaw pack "H*", $value };
767	}
768	}
769	},	1462	}
770	;
771		1463
772	#############################################################################	1464	$MAP_PREFETCH{$path} = 0;
		1465	$MAP_PREFETCHER->ready;
773		1466
774	=head2 CORE EXTENSIONS	1467	()
		1468	}
775		1469
776	Functions and methods that extend core crossfire objects.	1470	sub save {
		1471	my ($self) = @_;
		1472
		1473	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1474
		1475	$self->{last_save} = $cf::RUNTIME;
		1476
		1477	return unless $self->dirty;
		1478
		1479	my $save = $self->save_path; utf8::encode $save;
		1480	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1481
		1482	$self->{load_path} = $save;
		1483
		1484	return if $self->{deny_save};
		1485
		1486	local $self->{last_access} = $self->last_access;#d#
		1487
		1488	cf::async {
		1489	$_->contr->save for $self->players;
		1490	};
		1491
		1492	if ($uniq) {
		1493	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1494	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1495	} else {
		1496	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1497	}
		1498	}
		1499
		1500	sub swap_out {
		1501	my ($self) = @_;
		1502
		1503	# save first because save cedes
		1504	$self->save;
		1505
		1506	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1507
		1508	return if $self->players;
		1509	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1510	return if $self->{deny_save};
		1511
		1512	$self->clear;
		1513	$self->in_memory (cf::MAP_SWAPPED);
		1514	}
		1515
		1516	sub reset_at {
		1517	my ($self) = @_;
		1518
		1519	# TODO: safety, remove and allow resettable per-player maps
		1520	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1521	return 1e99 if $self->{deny_reset};
		1522
		1523	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1524	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1525
		1526	$time + $to
		1527	}
		1528
		1529	sub should_reset {
		1530	my ($self) = @_;
		1531
		1532	$self->reset_at <= $cf::RUNTIME
		1533	}
		1534
		1535	sub rename {
		1536	my ($self, $new_path) = @_;
		1537
		1538	normalise $new_path;
		1539
		1540	$self->unlink_save;
		1541
		1542	delete $cf::MAP{$self->path};
		1543	$self->{path} = $new_path; $self->path ($self->{path});
		1544	$cf::MAP{$self->path} = $self;
		1545
		1546	$self->save;
		1547	}
		1548
		1549	sub reset {
		1550	my ($self) = @_;
		1551
		1552	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1553
		1554	return if $self->players;
		1555	return if $self->isa ("ext::map_per_player");#d#
		1556
		1557	warn "resetting map ", $self->path;#d#
		1558
		1559	delete $cf::MAP{$self->path};
		1560
		1561	$self->in_memory (cf::MAP_SWAPPED);
		1562	$self->clear;
		1563
		1564	$_->clear_links_to ($self) for values %cf::MAP;
		1565
		1566	$self->unlink_save;
		1567	$self->destroy;
		1568	}
		1569
		1570	my $nuke_counter = "aaaa";
		1571
		1572	sub nuke {
		1573	my ($self) = @_;
		1574
		1575	$self->{deny_save} = 1;
		1576	$self->reset_timeout (1);
		1577	$self->rename ("{nuke}/" . ($nuke_counter++));
		1578	$self->reset; # polite request, might not happen
		1579	}
		1580
		1581	=item cf::map::unique_maps
		1582
		1583	Returns an arrayref of paths of all shared maps that have
		1584	instantiated unique items. May block.
		1585
		1586	=cut
		1587
		1588	sub unique_maps() {
		1589	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1590	or return;
		1591
		1592	my @paths;
		1593
		1594	for (@$files) {
		1595	utf8::decode $_;
		1596	next if /\.pst$/;
		1597	next unless /^$PATH_SEP/o;
		1598
		1599	s/\.map$//;
		1600	push @paths, $_;
		1601	}
		1602
		1603	\@paths
		1604	}
		1605
		1606	package cf;
		1607
		1608	=back
		1609
		1610	=head3 cf::object
		1611
		1612	=cut
		1613
		1614	package cf::object;
777		1615
778	=over 4	1616	=over 4
779		1617
780	=item cf::player::exists $login	1618	=item $ob->inv_recursive
781		1619
782	Returns true when the given account exists.	1620	Returns the inventory of the object _and_ their inventories, recursively.
783		1621
784	=cut	1622	=cut
785		1623
786	sub cf::player::exists($) {	1624	sub inv_recursive_;
787	cf::player::find $_[0]	1625	sub inv_recursive_ {
788	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1626	map { $_, inv_recursive_ $_->inv } @_
789	}	1627	}
		1628
		1629	sub inv_recursive {
		1630	inv_recursive_ inv $_[0]
		1631	}
		1632
		1633	package cf;
		1634
		1635	=back
		1636
		1637	=head3 cf::object::player
		1638
		1639	=over 4
790		1640
791	=item $player_object->reply ($npc, $msg[, $flags])	1641	=item $player_object->reply ($npc, $msg[, $flags])
792		1642
793	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1643	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
794	can be C<undef>. Does the right thing when the player is currently in a	1644	can be C<undef>. Does the right thing when the player is currently in a
…		…
796		1646
797	=cut	1647	=cut
798		1648
799	# rough implementation of a future "reply" method that works	1649	# rough implementation of a future "reply" method that works
800	# with dialog boxes.	1650	# with dialog boxes.
		1651	#TODO: the first argument must go, split into a $npc->reply_to ( method
801	sub cf::object::player::reply($$$;$) {	1652	sub cf::object::player::reply($$$;$) {
802	my ($self, $npc, $msg, $flags) = @_;	1653	my ($self, $npc, $msg, $flags) = @_;
803		1654
804	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1655	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
805		1656
…		…
809	$msg = $npc->name . " says: $msg" if $npc;	1660	$msg = $npc->name . " says: $msg" if $npc;
810	$self->message ($msg, $flags);	1661	$self->message ($msg, $flags);
811	}	1662	}
812	}	1663	}
813		1664
814	=item $player->ext_reply ($msgid, $msgtype, %msg)
815
816	Sends an ext reply to the player.
817
818	=cut
819
820	sub cf::player::ext_reply($$$%) {
821	my ($self, $id, %msg) = @_;
822
823	$msg{msgid} = $id;
824
825	$self->send ("ext " . to_json \%msg);
826	}
827
828	=item $player_object->may ("access")	1665	=item $player_object->may ("access")
829		1666
830	Returns wether the given player is authorized to access resource "access"	1667	Returns wether the given player is authorized to access resource "access"
831	(e.g. "command_wizcast").	1668	(e.g. "command_wizcast").
832		1669
…		…
839	(ref $cf::CFG{"may_$access"}	1676	(ref $cf::CFG{"may_$access"}
840	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1677	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841	: $cf::CFG{"may_$access"})	1678	: $cf::CFG{"may_$access"})
842	}	1679	}
843		1680
844	=cut	1681	=item $player_object->enter_link
845		1682
846	#############################################################################	1683	Freezes the player and moves him/her to a special map (C<{link}>).
		1684
		1685	The player should be reasonably safe there for short amounts of time. You
		1686	I<MUST> call C<leave_link> as soon as possible, though.
		1687
		1688	Will never block.
		1689
		1690	=item $player_object->leave_link ($map, $x, $y)
		1691
		1692	Moves the player out of the special C<{link}> map onto the specified
		1693	map. If the map is not valid (or omitted), the player will be moved back
		1694	to the location he/she was before the call to C<enter_link>, or, if that
		1695	fails, to the emergency map position.
		1696
		1697	Might block.
		1698
		1699	=cut
		1700
		1701	sub link_map {
		1702	unless ($LINK_MAP) {
		1703	$LINK_MAP = cf::map::find "{link}"
		1704	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1705	$LINK_MAP->load;
		1706	}
		1707
		1708	$LINK_MAP
		1709	}
		1710
		1711	sub cf::object::player::enter_link {
		1712	my ($self) = @_;
		1713
		1714	$self->deactivate_recursive;
		1715
		1716	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1717
		1718	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1719	if $self->map;
		1720
		1721	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1722	}
		1723
		1724	sub cf::object::player::leave_link {
		1725	my ($self, $map, $x, $y) = @_;
		1726
		1727	my $link_pos = delete $self->{_link_pos};
		1728
		1729	unless ($map) {
		1730	# restore original map position
		1731	($map, $x, $y) = @{ $link_pos || [] };
		1732	$map = cf::map::find $map;
		1733
		1734	unless ($map) {
		1735	($map, $x, $y) = @$EMERGENCY_POSITION;
		1736	$map = cf::map::find $map
		1737	or die "FATAL: cannot load emergency map\n";
		1738	}
		1739	}
		1740
		1741	($x, $y) = (-1, -1)
		1742	unless (defined $x) && (defined $y);
		1743
		1744	# use -1 or undef as default coordinates, not 0, 0
		1745	($x, $y) = ($map->enter_x, $map->enter_y)
		1746	if $x <=0 && $y <= 0;
		1747
		1748	$map->load;
		1749	$map->load_diag;
		1750
		1751	return unless $self->contr->active;
		1752	$self->activate_recursive;
		1753	$self->enter_map ($map, $x, $y);
		1754	}
		1755
		1756	cf::player->attach (
		1757	on_logout => sub {
		1758	my ($pl) = @_;
		1759
		1760	# abort map switching before logout
		1761	if ($pl->ob->{_link_pos}) {
		1762	cf::sync_job {
		1763	$pl->ob->leave_link
		1764	};
		1765	}
		1766	},
		1767	on_login => sub {
		1768	my ($pl) = @_;
		1769
		1770	# try to abort aborted map switching on player login :)
		1771	# should happen only on crashes
		1772	if ($pl->ob->{_link_pos}) {
		1773	$pl->ob->enter_link;
		1774	(async {
		1775	# we need this sleep as the login has a concurrent enter_exit running
		1776	# and this sleep increases chances of the player not ending up in scorn
		1777	$pl->ob->reply (undef,
		1778	"There was an internal problem at your last logout, "
		1779	. "the server will try to bring you to your intended destination in a second.",
		1780	cf::NDI_RED);
		1781	Coro::Timer::sleep 1;
		1782	$pl->ob->leave_link;
		1783	})->prio (2);
		1784	}
		1785	},
		1786	);
		1787
		1788	=item $player_object->goto ($path, $x, $y)
		1789
		1790	=cut
		1791
		1792	sub cf::object::player::goto {
		1793	my ($self, $path, $x, $y) = @_;
		1794
		1795	$self->enter_link;
		1796
		1797	(async {
		1798	my $map = cf::map::find $path;
		1799	$map = $map->customise_for ($self) if $map;
		1800
		1801	# warn "entering ", $map->path, " at ($x, $y)\n"
		1802	# if $map;
		1803
		1804	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1805
		1806	$self->leave_link ($map, $x, $y);
		1807	})->prio (1);
		1808	}
		1809
		1810	=item $player_object->enter_exit ($exit_object)
		1811
		1812	=cut
		1813
		1814	sub parse_random_map_params {
		1815	my ($spec) = @_;
		1816
		1817	my $rmp = { # defaults
		1818	xsize => 10,
		1819	ysize => 10,
		1820	};
		1821
		1822	for (split /\n/, $spec) {
		1823	my ($k, $v) = split /\s+/, $_, 2;
		1824
		1825	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1826	}
		1827
		1828	$rmp
		1829	}
		1830
		1831	sub prepare_random_map {
		1832	my ($exit) = @_;
		1833
		1834	# all this does is basically replace the /! path by
		1835	# a new random map path (?random/...) with a seed
		1836	# that depends on the exit object
		1837
		1838	my $rmp = parse_random_map_params $exit->msg;
		1839
		1840	if ($exit->map) {
		1841	$rmp->{region} = $exit->map->region_name;
		1842	$rmp->{origin_map} = $exit->map->path;
		1843	$rmp->{origin_x} = $exit->x;
		1844	$rmp->{origin_y} = $exit->y;
		1845	}
		1846
		1847	$rmp->{random_seed} ||= $exit->random_seed;
		1848
		1849	my $data = cf::to_json $rmp;
		1850	my $md5 = Digest::MD5::md5_hex $data;
		1851
		1852	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1853	aio_write $fh, 0, (length $data), $data, 0;
		1854
		1855	$exit->slaying ("?random/$md5");
		1856	$exit->msg (undef);
		1857	}
		1858	}
		1859
		1860	sub cf::object::player::enter_exit {
		1861	my ($self, $exit) = @_;
		1862
		1863	return unless $self->type == cf::PLAYER;
		1864
		1865	$self->enter_link;
		1866
		1867	(async {
		1868	$self->deactivate_recursive; # just to be sure
		1869	unless (eval {
		1870	prepare_random_map $exit
		1871	if $exit->slaying eq "/!";
		1872
		1873	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1874	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1875
		1876	1;
		1877	}) {
		1878	$self->message ("Something went wrong deep within the crossfire server. "
		1879	. "I'll try to bring you back to the map you were before. "
		1880	. "Please report this to the dungeon master!",
		1881	cf::NDI_UNIQUE | cf::NDI_RED);
		1882
		1883	warn "ERROR in enter_exit: $@";
		1884	$self->leave_link;
		1885	}
		1886	})->prio (1);
		1887	}
		1888
		1889	=head3 cf::client
		1890
		1891	=over 4
		1892
		1893	=item $client->send_drawinfo ($text, $flags)
		1894
		1895	Sends a drawinfo packet to the client. Circumvents output buffering so
		1896	should not be used under normal circumstances.
		1897
		1898	=cut
		1899
		1900	sub cf::client::send_drawinfo {
		1901	my ($self, $text, $flags) = @_;
		1902
		1903	utf8::encode $text;
		1904	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1905	}
		1906
		1907
		1908	=item $success = $client->query ($flags, "text", \&cb)
		1909
		1910	Queues a query to the client, calling the given callback with
		1911	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1912	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1913
		1914	Queries can fail, so check the return code. Or don't, as queries will become
		1915	reliable at some point in the future.
		1916
		1917	=cut
		1918
		1919	sub cf::client::query {
		1920	my ($self, $flags, $text, $cb) = @_;
		1921
		1922	return unless $self->state == ST_PLAYING
		1923	|| $self->state == ST_SETUP
		1924	|| $self->state == ST_CUSTOM;
		1925
		1926	$self->state (ST_CUSTOM);
		1927
		1928	utf8::encode $text;
		1929	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1930
		1931	$self->send_packet ($self->{query_queue}[0][0])
		1932	if @{ $self->{query_queue} } == 1;
		1933	}
		1934
		1935	cf::client->attach (
		1936	on_reply => sub {
		1937	my ($ns, $msg) = @_;
		1938
		1939	# this weird shuffling is so that direct followup queries
		1940	# get handled first
		1941	my $queue = delete $ns->{query_queue}
		1942	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1943
		1944	(shift @$queue)->[1]->($msg);
		1945
		1946	push @{ $ns->{query_queue} }, @$queue;
		1947
		1948	if (@{ $ns->{query_queue} } == @$queue) {
		1949	if (@$queue) {
		1950	$ns->send_packet ($ns->{query_queue}[0][0]);
		1951	} else {
		1952	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1953	}
		1954	}
		1955	},
		1956	);
		1957
		1958	=item $client->async (\&cb)
		1959
		1960	Create a new coroutine, running the specified callback. The coroutine will
		1961	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1962	or loss of connection).
		1963
		1964	=cut
		1965
		1966	sub cf::client::async {
		1967	my ($self, $cb) = @_;
		1968
		1969	my $coro = &Coro::async ($cb);
		1970
		1971	$coro->on_destroy (sub {
		1972	delete $self->{_coro}{$coro+0};
		1973	});
		1974
		1975	$self->{_coro}{$coro+0} = $coro;
		1976
		1977	$coro
		1978	}
		1979
		1980	cf::client->attach (
		1981	on_destroy => sub {
		1982	my ($ns) = @_;
		1983
		1984	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1985	},
		1986	);
		1987
		1988	=back
		1989
847		1990
848	=head2 SAFE SCRIPTING	1991	=head2 SAFE SCRIPTING
849		1992
850	Functions that provide a safe environment to compile and execute	1993	Functions that provide a safe environment to compile and execute
851	snippets of perl code without them endangering the safety of the server	1994	snippets of perl code without them endangering the safety of the server
…		…
866		2009
867	=pod	2010	=pod
868		2011
869	The following fucntions and emthods are available within a safe environment:	2012	The following fucntions and emthods are available within a safe environment:
870		2013
871	cf::object contr pay_amount pay_player	2014	cf::object contr pay_amount pay_player map
872	cf::object::player player	2015	cf::object::player player
873	cf::player peaceful	2016	cf::player peaceful
		2017	cf::map trigger
874		2018
875	=cut	2019	=cut
876		2020
877	for (	2021	for (
878	["cf::object" => qw(contr pay_amount pay_player)],	2022	["cf::object" => qw(contr pay_amount pay_player map)],
879	["cf::object::player" => qw(player)],	2023	["cf::object::player" => qw(player)],
880	["cf::player" => qw(peaceful)],	2024	["cf::player" => qw(peaceful)],
		2025	["cf::map" => qw(trigger)],
881	) {	2026	) {
882	no strict 'refs';	2027	no strict 'refs';
883	my ($pkg, @funs) = @$_;	2028	my ($pkg, @funs) = @$_;
884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2029	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
885	for @funs;	2030	for @funs;
…		…
1001		2146
1002	{	2147	{
1003	my $path = cf::localdir . "/database.pst";	2148	my $path = cf::localdir . "/database.pst";
1004		2149
1005	sub db_load() {	2150	sub db_load() {
1006	warn "loading database $path\n";#d# remove later
1007	$DB = stat $path ? Storable::retrieve $path : { };	2151	$DB = stat $path ? Storable::retrieve $path : { };
1008	}	2152	}
1009		2153
1010	my $pid;	2154	my $pid;
1011		2155
1012	sub db_save() {	2156	sub db_save() {
1013	warn "saving database $path\n";#d# remove later
1014	waitpid $pid, 0 if $pid;	2157	waitpid $pid, 0 if $pid;
1015	if (0 == ($pid = fork)) {	2158	if (0 == ($pid = fork)) {
1016	$DB->{_meta}{version} = 1;	2159	$DB->{_meta}{version} = 1;
1017	Storable::nstore $DB, "$path~";	2160	Storable::nstore $DB, "$path~";
1018	rename "$path~", $path;	2161	rename "$path~", $path;
…		…
1025	sub db_sync() {	2168	sub db_sync() {
1026	db_save if $dirty;	2169	db_save if $dirty;
1027	undef $dirty;	2170	undef $dirty;
1028	}	2171	}
1029		2172
1030	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2173	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1031	db_sync;	2174	db_sync;
1032	});	2175	});
1033		2176
1034	sub db_dirty() {	2177	sub db_dirty() {
1035	$dirty = 1;	2178	$dirty = 1;
…		…
1049	$DB->{$_[0]} = $_[1];	2192	$DB->{$_[0]} = $_[1];
1050	}	2193	}
1051	db_dirty;	2194	db_dirty;
1052	}	2195	}
1053		2196
1054	attach_global	2197	cf::global->attach (
1055	prio => 10000,	2198	prio => 10000,
1056	on_cleanup => sub {	2199	on_cleanup => sub {
1057	db_sync;	2200	db_sync;
1058	},	2201	},
1059	;	2202	);
1060	}	2203	}
1061		2204
1062	#############################################################################	2205	#############################################################################
1063	# the server's main()	2206	# the server's main()
1064		2207
…		…
1066	open my $fh, "<:utf8", cf::confdir . "/config"	2209	open my $fh, "<:utf8", cf::confdir . "/config"
1067	or return;	2210	or return;
1068		2211
1069	local $/;	2212	local $/;
1070	*CFG = YAML::Syck::Load <$fh>;	2213	*CFG = YAML::Syck::Load <$fh>;
		2214
		2215	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2216
		2217	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2218	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2219
		2220	if (exists $CFG{mlockall}) {
		2221	eval {
		2222	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2223	and die "WARNING: m(un)lockall failed: $!\n";
		2224	};
		2225	warn $@ if $@;
		2226	}
1071	}	2227	}
1072		2228
1073	sub main {	2229	sub main {
		2230	# we must not ever block the main coroutine
		2231	local $Coro::idle = sub {
		2232	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2233	async { Event::one_event };
		2234	};
		2235
1074	cfg_load;	2236	cfg_load;
1075	db_load;	2237	db_load;
1076	load_extensions;	2238	load_extensions;
1077	Event::loop;	2239	Event::loop;
1078	}	2240	}
1079		2241
1080	#############################################################################	2242	#############################################################################
1081	# initialisation	2243	# initialisation and cleanup
1082		2244
		2245	# install some emergency cleanup handlers
		2246	BEGIN {
		2247	for my $signal (qw(INT HUP TERM)) {
		2248	Event->signal (
		2249	data => WF_AUTOCANCEL,
		2250	signal => $signal,
		2251	cb => sub {
		2252	cf::cleanup "SIG$signal";
		2253	},
		2254	);
		2255	}
		2256	}
		2257
		2258	sub emergency_save() {
		2259	my $freeze_guard = cf::freeze_mainloop;
		2260
		2261	warn "enter emergency perl save\n";
		2262
		2263	cf::sync_job {
		2264	# use a peculiar iteration method to avoid tripping on perl
		2265	# refcount bugs in for. also avoids problems with players
		2266	# and maps saved/destroyed asynchronously.
		2267	warn "begin emergency player save\n";
		2268	for my $login (keys %cf::PLAYER) {
		2269	my $pl = $cf::PLAYER{$login} or next;
		2270	$pl->valid or next;
		2271	$pl->save;
		2272	}
		2273	warn "end emergency player save\n";
		2274
		2275	warn "begin emergency map save\n";
		2276	for my $path (keys %cf::MAP) {
		2277	my $map = $cf::MAP{$path} or next;
		2278	$map->valid or next;
		2279	$map->save;
		2280	}
		2281	warn "end emergency map save\n";
		2282	};
		2283
		2284	warn "leave emergency perl save\n";
		2285	}
		2286
1083	sub _perl_reload(&) {	2287	sub reload() {
1084	my ($msg) = @_;	2288	# can/must only be called in main
		2289	if ($Coro::current != $Coro::main) {
		2290	warn "can only reload from main coroutine\n";
		2291	return;
		2292	}
1085		2293
1086	$msg->("reloading...");	2294	warn "reloading...";
		2295
		2296	warn "freezing server";
		2297	my $guard = freeze_mainloop;
		2298	cf::emergency_save;
		2299
		2300	warn "sync database to disk";
		2301	cf::db_sync;
		2302	IO::AIO::flush;
1087		2303
1088	eval {	2304	eval {
		2305	# if anything goes wrong in here, we should simply crash as we already saved
		2306
1089	# cancel all watchers	2307	warn "cancel all watchers";
1090	$_->cancel for Event::all_watchers;	2308	for (Event::all_watchers) {
		2309	$_->cancel if $_->data & WF_AUTOCANCEL;
		2310	}
1091		2311
		2312	warn "cancel all extension coros";
		2313	$_->cancel for values %EXT_CORO;
		2314	%EXT_CORO = ();
		2315
		2316	warn "remove commands";
		2317	%COMMAND = ();
		2318
		2319	warn "remove ext commands";
		2320	%EXTCMD = ();
		2321
1092	# unload all extensions	2322	warn "unload/nuke all extensions";
1093	for (@exts) {	2323	for my $pkg (@EXTS) {
1094	$msg->("unloading <$_>");	2324	warn "... unloading $pkg";
1095	unload_extension $_;	2325
		2326	if (my $cb = $pkg->can ("unload")) {
		2327	eval {
		2328	$cb->($pkg);
		2329	1
		2330	} or warn "$pkg unloaded, but with errors: $@";
1096	}	2331	}
1097		2332
		2333	warn "... nuking $pkg";
		2334	Symbol::delete_package $pkg;
		2335	}
		2336
1098	# unload all modules loaded from $LIBDIR	2337	warn "unload all perl modules loaded from $LIBDIR";
1099	while (my ($k, $v) = each %INC) {	2338	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2339	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		2340
1102	$msg->("removing <$k>");	2341	warn "removing <$k>";
1103	delete $INC{$k};	2342	delete $INC{$k};
1104		2343
1105	$k =~ s/\.pm$//;	2344	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	2345	$k =~ s/\//::/g;
1107		2346
…		…
1110	}	2349	}
1111		2350
1112	Symbol::delete_package $k;	2351	Symbol::delete_package $k;
1113	}	2352	}
1114		2353
1115	# sync database to disk
1116	cf::db_sync;
1117
1118	# get rid of safe::, as good as possible	2354	warn "get rid of safe::, as good as possible";
1119	Symbol::delete_package "safe::$_"	2355	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2356	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		2357
1122	# remove register_script_function callbacks
1123	# TODO
1124
1125	# unload cf.pm "a bit"	2358	warn "unload cf.pm \"a bit\"";
1126	delete $INC{"cf.pm"};	2359	delete $INC{"cf.pm"};
1127		2360
1128	# don't, removes xs symbols, too,	2361	# don't, removes xs symbols, too,
1129	# and global variables created in xs	2362	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	2363	#Symbol::delete_package __PACKAGE__;
1131		2364
1132	# reload cf.pm
1133	$msg->("reloading cf.pm");	2365	warn "reloading cf.pm";
1134	require cf;	2366	require cf;
		2367	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		2368
1136	# load config and database again	2369	warn "load config and database again";
1137	cf::cfg_load;	2370	cf::cfg_load;
1138	cf::db_load;	2371	cf::db_load;
1139		2372
1140	# load extensions	2373	warn "load extensions";
1141	$msg->("load extensions");
1142	cf::load_extensions;	2374	cf::load_extensions;
1143		2375
1144	# reattach attachments to objects	2376	warn "reattach attachments to objects/players";
1145	$msg->("reattach");
1146	_global_reattach;	2377	_global_reattach;
		2378	warn "reattach attachments to maps";
		2379	reattach $_ for values %MAP;
1147	};	2380	};
1148	$msg->($@) if $@;
1149		2381
1150	$msg->("reloaded");	2382	if ($@) {
		2383	warn $@;
		2384	warn "error while reloading, exiting.";
		2385	exit 1;
		2386	}
		2387
		2388	warn "reloaded";
1151	};	2389	};
1152		2390
1153	sub perl_reload() {
1154	_perl_reload {
1155	warn $_[0];
1156	print "$_[0]\n";
1157	};
1158	}
1159
1160	register_command "perl-reload", 0, sub {	2391	register_command "reload" => sub {
1161	my ($who, $arg) = @_;	2392	my ($who, $arg) = @_;
1162		2393
1163	if ($who->flag (FLAG_WIZ)) {	2394	if ($who->flag (FLAG_WIZ)) {
1164	_perl_reload {	2395	$who->message ("start of reload.");
1165	warn $_[0];	2396	reload;
1166	$who->message ($_[0]);	2397	$who->message ("end of reload.");
1167	};
1168	}	2398	}
1169	};	2399	};
1170		2400
1171	register "<global>", __PACKAGE__;
1172
1173	unshift @INC, $LIBDIR;	2401	unshift @INC, $LIBDIR;
1174		2402
1175	$TICK_WATCHER = Event->timer (	2403	$TICK_WATCHER = Event->timer (
		2404	reentrant => 0,
1176	prio => 1,	2405	prio => 0,
1177	async => 1,
1178	at => $NEXT_TICK || 1,	2406	at => $NEXT_TICK || $TICK,
		2407	data => WF_AUTOCANCEL,
1179	cb => sub {	2408	cb => sub {
		2409	$NOW = Event::time;
		2410
1180	cf::server_tick; # one server iteration	2411	cf::server_tick; # one server iteration
1181		2412	$RUNTIME += $TICK;
1182	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	2413	$NEXT_TICK += $TICK;
1184		2414
		2415	$WAIT_FOR_TICK->broadcast;
		2416	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2417
1185	# if we are delayed by four ticks or more, skip them all	2418	# if we are delayed by four ticks or more, skip them all
1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2419	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1187		2420
1188	$TICK_WATCHER->at ($NEXT_TICK);	2421	$TICK_WATCHER->at ($NEXT_TICK);
1189	$TICK_WATCHER->start;	2422	$TICK_WATCHER->start;
1190	},	2423	},
1191	);	2424	);
1192		2425
1193	IO::AIO::max_poll_time $TICK * 0.2;	2426	IO::AIO::max_poll_time $TICK * 0.2;
1194		2427
		2428	$AIO_POLL_WATCHER = Event->io (
1195	Event->io (fd => IO::AIO::poll_fileno,	2429	fd => IO::AIO::poll_fileno,
1196	poll => 'r',	2430	poll => 'r',
1197	prio => 5,	2431	prio => 5,
		2432	data => WF_AUTOCANCEL,
1198	cb => \&IO::AIO::poll_cb);	2433	cb => \&IO::AIO::poll_cb,
		2434	);
		2435
		2436	$WRITE_RUNTIME_WATCHER = Event->timer (
		2437	data => WF_AUTOCANCEL,
		2438	after => 0,
		2439	interval => 10,
		2440	cb => sub {
		2441	(Coro::unblock_sub {
		2442	write_runtime
		2443	or warn "ERROR: unable to write runtime file: $!";
		2444	})->();
		2445	},
		2446	);
		2447
		2448	END { cf::emergency_save }
1199		2449
1200	1	2450	1
1201		2451

Diff Legend

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