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.46 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.174 by root, Sun Jan 14 19:55: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;
		23	use IO::AIO 2.32 ();
		24	use YAML::Syck ();
10	use Time::HiRes;	25	use Time::HiRes;
11	use Event;	26
12	$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
13		28
14	use strict;	29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
		31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		32	$YAML::Syck::ImplicitUnicode = 1;
		33
		34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		35
16	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
17	our @EVENT;	44	our @EVENT;
18	our %PROP_TYPE;	45	our $LIBDIR = datadir . "/ext";
19	our %PROP_IDX;
20	our $LIBDIR = maps_directory "perl";
21		46
22	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	48	our $TICK_WATCHER;
		49	our $AIO_POLL_WATCHER;
		50	our $WRITE_RUNTIME_WATCHER;
24	our $NEXT_TICK;	51	our $NEXT_TICK;
		52	our $NOW;
		53
		54	our %CFG;
		55
		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;
		87
		88	#############################################################################
		89
		90	=head2 GLOBAL VARIABLES
		91
		92	=over 4
		93
		94	=item $cf::UPTIME
		95
		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.
		102
		103	=item $cf::LIBDIR
		104
		105	The perl library directory, where extensions and cf-specific modules can
		106	be found. It will be added to C<@INC> automatically.
		107
		108	=item $cf::NOW
		109
		110	The time of the last (current) server tick.
		111
		112	=item $cf::TICK
		113
		114	The interval between server ticks, in seconds.
		115
		116	=item %cf::CFG
		117
		118	Configuration for the server, loaded from C</etc/crossfire/config>, or
		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.
		127
		128	=back
		129
		130	=cut
25		131
26	BEGIN {	132	BEGIN {
27	*CORE::GLOBAL::warn = sub {	133	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	134	my $msg = join "", @_;
		135	utf8::encode $msg;
		136
29	$msg .= "\n"	137	$msg .= "\n"
30	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
31		139
32	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
34	};	141	};
35	}	142	}
36		143
37	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
38		145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
39	# generate property mutators	146	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
40	sub prop_gen {	147	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
41	my ($prefix, $class) = @_;	148	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
42
43	no strict 'refs';
44
45	for my $prop (keys %PROP_TYPE) {
46	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
47	my $sub = lc $1;
48
49	my $type = $PROP_TYPE{$prop};
50	my $idx = $PROP_IDX {$prop};
51
52	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
53	$_[0]->get_property ($type, $idx)
54	};
55
56	*{"$class\::set_$sub"} = sub {
57	$_[0]->set_property ($type, $idx, $_[1]);
58	} unless $ignore_set{$prop};
59	}
60	}
61
62	# auto-generate most of the API
63
64	prop_gen OBJECT_PROP => "cf::object";
65	# CFAPI_OBJECT_ANIMATION?
66	prop_gen PLAYER_PROP => "cf::object::player";
67
68	prop_gen MAP_PROP => "cf::map";
69	prop_gen ARCH_PROP => "cf::arch";
70
71	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		150
73	# 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
74	# within the Safe compartment.	152	# within the Safe compartment.
75	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	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	)) {
76	no strict 'refs';	160	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	162	}
79		163
80	$Event::DIED = sub {	164	$Event::DIED = sub {
81	warn "error in event callback: @_";	165	warn "error in event callback: @_";
82	};	166	};
83		167
84	my %ext_pkg;	168	=head2 UTILITY FUNCTIONS
85	my @exts;
86	my @hook;
87	my %command;
88	my %extcmd;
89		169
90	#############################################################################	170	=over 4
91	# utility functions	171
		172	=item dumpval $ref
		173
		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	}
92		194
93	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
		196
		197	=item $ref = cf::from_json $json
		198
		199	Converts a JSON string into the corresponding perl data structure.
		200
		201	=cut
94		202
95	sub from_json($) {	203	sub from_json($) {
96	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	204	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
97	JSON::Syck::Load $_[0]	205	JSON::Syck::Load $_[0]
98	}	206	}
99		207
		208	=item $json = cf::to_json $ref
		209
		210	Converts a perl data structure into its JSON representation.
		211
		212	=cut
		213
100	sub to_json($) {	214	sub to_json($) {
101	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
102	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
103	}	217	}
104		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
		370	=back
		371
		372	=cut
		373
105	#############################################################################	374	#############################################################################
106	# "new" plug-in system
107		375
108	=item $object->attach ($attachment, ...)	376	=head2 ATTACHABLE OBJECTS
109		377
110	Attach a pre-registered attachment to an object.	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.
111		381
112	=item $player->attach ($attachment, ...)	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+).
113		385
114	Attach a pre-registered attachment to a player.	386	=over 4
115		387
116	=item $map->attach ($attachment, ...) # not yet persistent	388	=item $attachable->attach ($attachment, key => $value...)
117		389
118	Attach a pre-registered attachment to a map.	390	=item $attachable->detach ($attachment)
119		391
120	=item cf::attach_global ...	392	Attach/detach a pre-registered attachment to a specific object and give it
		393	the specified key/value pairs as arguments.
121		394
122	Attach handlers for global events.	395	Example, attach a minesweeper attachment to the given object, making it a
		396	10x10 minesweeper game:
123		397
124	This and all following C<attach_*>-functions expect any number of the	398	$obj->attach (minesweeper => width => 10, height => 10);
125	following handler/hook descriptions:	399
		400	=item $bool = $attachable->attached ($name)
		401
		402	Checks wether the named attachment is currently attached to the object.
		403
		404	=item cf::CLASS->attach ...
		405
		406	=item cf::CLASS->detach ...
		407
		408	Define an anonymous attachment and attach it to all objects of the given
		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:
126		442
127	=over 4	443	=over 4
128		444
129	=item prio => $number	445	=item prio => $number
130		446
…		…
132	by another C<prio> setting). Lower priority handlers get executed	448	by another C<prio> setting). Lower priority handlers get executed
133	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
134	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
135	unless you know what you are doing.	451	unless you know what you are doing.
136		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
137	=item on_I<event> => \&cb	459	=item on_I<event> => \&cb
138		460
139	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
140	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
141	handlers are recognised generally depends on the type of object these	463	handlers are recognised generally depends on the type of object these
…		…
150	package and register them. Only handlers for eevents supported by the	472	package and register them. Only handlers for eevents supported by the
151	object/class are recognised.	473	object/class are recognised.
152		474
153	=back	475	=back
154		476
155	=item cf::attach_to_type $object_type, ...	477	Example, define an attachment called "sockpuppet" that calls the given
		478	event handler when a monster attacks:
156		479
157	Attach handlers for a specific object type (e.g. TRANSPORT).	480	cf::object::attachment sockpuppet =>
		481	on_skill_attack => sub {
		482	my ($self, $victim) = @_;
		483	...
		484	}
		485	}
158		486
159	=item cf::attach_to_objects ...	487	=item $attachable->valid
160		488
161	Attach handlers to all objects. Do not use this except for debugging or	489	Just because you have a perl object does not mean that the corresponding
162	very rare events, as handlers are (obviously) called for I<all> objects in	490	C-level object still exists. If you try to access an object that has no
163	the game.	491	valid C counterpart anymore you get an exception at runtime. This method
164		492	can be used to test for existence of the C object part without causing an
165	=item cf::attach_to_players ...	493	exception.
166
167	Attach handlers to all players.
168
169	=item cf::attach_to_maps ...
170
171	Attach handlers to all maps.
172
173	=item cf:register_attachment $name, ...
174		494
175	=cut	495	=cut
176		496
177	# the following variables are defined in .xs and must not be re-created	497	# the following variables are defined in .xs and must not be re-created
178	our @CB_GLOBAL = (); # registry for all global events	498	our @CB_GLOBAL = (); # registry for all global events
		499	our @CB_ATTACHABLE = (); # registry for all attachables
179	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	500	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
180	our @CB_PLAYER = ();	501	our @CB_PLAYER = ();
		502	our @CB_CLIENT = ();
181	our @CB_TYPE = (); # registry for type (cf-object class) based events	503	our @CB_TYPE = (); # registry for type (cf-object class) based events
182	our @CB_MAP = ();	504	our @CB_MAP = ();
183		505
184	my %attachment;	506	my %attachment;
185		507
		508	sub cf::attachable::thawer_merge {
		509	# simply override everything except _meta
		510	local $_[0]{_meta};
		511	%{$_[0]} = %{$_[1]};
		512	}
		513
186	sub _attach_cb($\%$$$) {	514	sub _attach_cb($$$$) {
187	my ($registry, $undo, $event, $prio, $cb) = @_;	515	my ($registry, $event, $prio, $cb) = @_;
188		516
189	use sort 'stable';	517	use sort 'stable';
190		518
191	$cb = [$prio, $cb];	519	$cb = [$prio, $cb];
192		520
193	@{$registry->[$event]} = sort	521	@{$registry->[$event]} = sort
194	{ $a->[0] cmp $b->[0] }	522	{ $a->[0] cmp $b->[0] }
195	@{$registry->[$event] || []}, $cb;	523	@{$registry->[$event] || []}, $cb;
196
197	push @{$undo->{cb}}, [$event, $cb];
198	}	524	}
		525
		526	# hack
		527	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
199		528
200	# attach handles attaching event callbacks	529	# attach handles attaching event callbacks
201	# the only thing the caller has to do is pass the correct	530	# the only thing the caller has to do is pass the correct
202	# registry (== where the callback attaches to).	531	# registry (== where the callback attaches to).
203	sub _attach(\@$@) {	532	sub _attach {
204	my ($registry, $klass, @arg) = @_;	533	my ($registry, $klass, @arg) = @_;
205		534
		535	my $object_type;
206	my $prio = 0;	536	my $prio = 0;
207
208	my %undo = (
209	registry => $registry,
210	cb => [],
211	);
212
213	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	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	}
214		543
215	while (@arg) {	544	while (@arg) {
216	my $type = shift @arg;	545	my $type = shift @arg;
217		546
218	if ($type eq "prio") {	547	if ($type eq "prio") {
219	$prio = shift @arg;	548	$prio = shift @arg;
220		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
221	} elsif ($type eq "package") {	559	} elsif ($type eq "package") {
222	my $pkg = shift @arg;	560	my $pkg = shift @arg;
223		561
224	while (my ($name, $id) = each %cb_id) {	562	while (my ($name, $id) = each %cb_id) {
225	if (my $cb = $pkg->can ($name)) {	563	if (my $cb = $pkg->can ($name)) {
226	_attach_cb $registry, %undo, $id, $prio, $cb;	564	_attach_cb $registry, $id, $prio, $cb;
227	}	565	}
228	}	566	}
229		567
230	} elsif (exists $cb_id{$type}) {	568	} elsif (exists $cb_id{$type}) {
231	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	569	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
232		570
233	} elsif (ref $type) {	571	} elsif (ref $type) {
234	warn "attaching objects not supported, ignoring.\n";	572	warn "attaching objects not supported, ignoring.\n";
235		573
236	} else {	574	} else {
237	shift @arg;	575	shift @arg;
238	warn "attach argument '$type' not supported, ignoring.\n";	576	warn "attach argument '$type' not supported, ignoring.\n";
239	}	577	}
240	}	578	}
241
242	\%undo
243	}	579	}
244		580
245	sub _attach_attachment {	581	sub _object_attach {
246	my ($klass, $obj, $name, @args) = q_;	582	my ($obj, $name, %arg) = @_;
247		583
248	my $res;	584	return if exists $obj->{_attachment}{$name};
249		585
250	if (my $attach = $attachment{$name}) {	586	if (my $attach = $attachment{$name}) {
251	my $registry = $obj->registry;	587	my $registry = $obj->registry;
252		588
		589	for (@$attach) {
		590	my ($klass, @attach) = @$_;
253	$res = _attach @$registry, $klass, @$attach;	591	_attach $registry, $klass, @attach;
254
255	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
256	for (@$cb) {
257	eval { $_->[1]->($obj, @args); };
258	if ($@) {
259	warn "$@";
260	warn "... while processing '$name' instantiate with args <@args>.\n";
261	}
262	}	592	}
263	}	593
		594	$obj->{$name} = \%arg;
264	} else {	595	} else {
265	warn "object uses attachment '$name' that is not available, postponing.\n";	596	warn "object uses attachment '$name' that is not available, postponing.\n";
266	}	597	}
267		598
268	push @{$obj->{_attachment}}, $name;	599	$obj->{_attachment}{$name} = undef;
269
270	$res->{attachment} = $name;
271	$res
272	}	600	}
273		601
274	sub cf::object::attach {	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 {
275	my ($obj, $name, @args) = @_;	612	my ($obj, $name) = @_;
276		613
277	_attach_attachment KLASS_OBJECT, $obj, $name, @args;	614	if (ref $obj) {
278	}	615	delete $obj->{_attachment}{$name};
		616	reattach ($obj);
		617	} else {
		618	Carp::croak "cannot, currently, detach class attachments";
		619	}
		620	};
279		621
280	sub cf::player::attach {	622	sub cf::attachable::attached {
281	my ($obj, $name, @args) = @_;	623	my ($obj, $name) = @_;
282		624
283	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	625	exists $obj->{_attachment}{$name}
284	}	626	}
285		627
286	sub cf::map::attach {	628	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
287	my ($obj, $name, @args) = @_;	629	eval "#line " . __LINE__ . " 'cf.pm'
		630	sub cf::\L$klass\E::_attach_registry {
		631	(\\\@CB_$klass, KLASS_$klass)
		632	}
288		633
289	_attach_attachment KLASS_MAP, $obj, $name, @args;	634	sub cf::\L$klass\E::attachment {
290	}
291
292	sub attach_global {
293	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
294	}
295
296	sub attach_to_type {
297	my $type = shift;
298
299	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	635	my \$name = shift;
316		636
317	$attachment{$name} = [@_];	637	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		638	}
		639	";
		640	die if $@;
318	}	641	}
319		642
320	our $override;	643	our $override;
321	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	644	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322		645
…		…
336	for (@$callbacks) {	659	for (@$callbacks) {
337	eval { &{$_->[1]} };	660	eval { &{$_->[1]} };
338		661
339	if ($@) {	662	if ($@) {
340	warn "$@";	663	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	664	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	665	override;
343	}	666	}
344		667
345	return 1 if $override;	668	return 1 if $override;
346	}	669	}
347		670
348	0	671	0
349	}	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
		684	=back
		685
		686	=cut
350		687
351	#############################################################################	688	#############################################################################
352	# object support	689	# object support
353		690
354	sub instantiate {
355	my ($obj, $data) = @_;
356
357	$data = from_json $data;
358
359	for (@$data) {
360	my ($name, $args) = @$_;
361	attach $obj, $name, @{$args || [] };
362	}
363	}
364
365	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	691	sub reattach {
367	warn "reattach<@_>\n";#d#	692	# basically do the same as instantiate, without calling instantiate
368	my ($obj) = @_;	693	my ($obj) = @_;
		694
		695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		696
369	my $registry = $obj->registry;	697	my $registry = $obj->registry;
370		698
		699	@$registry = ();
		700
		701	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		702
371	for my $name (@{ $obj->{_attachment} }) {	703	for my $name (keys %{ $obj->{_attachment} || {} }) {
372	if (my $attach = $attachment{$name}) {	704	if (my $attach = $attachment{$name}) {
		705	for (@$attach) {
		706	my ($klass, @attach) = @$_;
373	_attach @$registry, KLASS_OBJECT, @$attach;	707	_attach $registry, $klass, @attach;
		708	}
374	} else {	709	} else {
375	warn "object uses attachment '$name' that is not available, postponing.\n";	710	warn "object uses attachment '$name' that is not available, postponing.\n";
376	}	711	}
377	}	712	}
378
379	warn "reattach<@_, $_>\n";
380	}	713	}
		714
		715	cf::attachable->attach (
		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,
		729	on_clone => sub {
		730	my ($src, $dst) = @_;
		731
		732	@{$dst->registry} = @{$src->registry};
		733
		734	%$dst = %$src;
		735
		736	%{$dst->{_attachment}} = %{$src->{_attachment}}
		737	if exists $src->{_attachment};
		738	},
		739	);
381		740
382	sub object_freezer_save {	741	sub object_freezer_save {
383	my ($filename, $objs) = @_;	742	my ($filename, $rdata, $objs) = @_;
384	warn "freeze $filename\n";#d#
385	use Data::Dumper; print Dumper $objs;
386		743
387	$filename .= ".pst";	744	sync_job {
		745	if (length $$rdata) {
		746	warn sprintf "saving %s (%d,%d)\n",
		747	$filename, length $$rdata, scalar @$objs;
388		748
389	if (@$objs) {	749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
390	open my $fh, ">:raw", "$filename~";	750	chmod SAVE_MODE, $fh;
391	chmod $fh, SAVE_MODE;	751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	752	aio_fsync $fh;
393	close $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
394	rename "$filename~", $filename;	768	aio_rename "$filename~", $filename;
		769	} else {
		770	warn "FATAL: $filename~: $!\n";
		771	}
395	} else {	772	} else {
396	unlink $filename;	773	aio_unlink $filename;
		774	aio_unlink "$filename.pst";
		775	}
397	}	776	}
		777	}
		778
		779	sub object_freezer_as_string {
		780	my ($rdata, $objs) = @_;
		781
		782	use Data::Dumper;
		783
		784	$$rdata . Dumper $objs
398	}	785	}
399		786
400	sub object_thawer_load {	787	sub object_thawer_load {
401	my ($filename) = @_;	788	my ($filename) = @_;
402		789
403	warn "thaw $filename\n";#d#	790	my ($data, $av);
404		791
405	open my $fh, "<:raw:perlio", "$filename.pst"	792	(aio_load $filename, $data) >= 0
406	or return;	793	or return;
407		794
408	eval { local $/; (Storable::thaw <$fh>)->{objs} }	795	unless (aio_stat "$filename.pst") {
409	}	796	(aio_load "$filename.pst", $av) >= 0
410		797	or return;
411	attach_to_objects	798	$av = eval { (Storable::thaw $av)->{objs} };
412	prio => -1000000,
413	on_clone => sub {
414	my ($src, $dst) = @_;
415
416	@{$dst->registry} = @{$src->registry};
417	warn "registry clone ", join ":", @{$src->registry};#d#
418
419	%$dst = %$src;
420
421	$dst->{_attachment} = [@{ $src->{_attachment} }]
422	if exists $src->{_attachment};
423
424	warn "clone<@_>\n";#d#
425	},	799	}
426	;	800
		801	warn sprintf "loading %s (%d)\n",
		802	$filename, length $data, scalar @{$av || []};#d#
		803	return ($data, $av);
		804	}
427		805
428	#############################################################################	806	#############################################################################
429	# old plug-in events	807	# command handling &c
430		808
431	sub inject_event {	809	=item cf::register_command $name => \&callback($ob,$args);
432	my $extension = shift;
433	my $event_code = shift;
434		810
435	my $cb = $hook[$event_code]{$extension}	811	Register a callback for execution when the client sends the user command
436	or return;	812	$name.
437		813
438	&$cb	814	=cut
439	}
440
441	sub inject_global_event {
442	my $event = shift;
443
444	my $cb = $hook[$event]
445	or return;
446
447	List::Util::max map &$_, values %$cb
448	}
449
450	sub inject_command {
451	my ($name, $obj, $params) = @_;
452
453	for my $cmd (@{ $command{$name} }) {
454	$cmd->[1]->($obj, $params);
455	}
456
457	-1
458	}
459		815
460	sub register_command {	816	sub register_command {
461	my ($name, $time, $cb) = @_;	817	my ($name, $cb) = @_;
462		818
463	my $caller = caller;	819	my $caller = caller;
464	#warn "registering command '$name/$time' to '$caller'";	820	#warn "registering command '$name/$time' to '$caller'";
465		821
466	push @{ $command{$name} }, [$time, $cb, $caller];	822	push @{ $COMMAND{$name} }, [$caller, $cb];
467	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
468	}	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
469		833
470	sub register_extcmd {	834	sub register_extcmd {
471	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
472		836
473	my $caller = caller;	837	$EXTCMD{$name} = $cb;
474	#warn "registering extcmd '$name' to '$caller'";
475
476	$extcmd{$name} = [$cb, $caller];
477	}	838	}
478		839
479	sub register {	840	cf::player->attach (
480	my ($base, $pkg) = @_;	841	on_command => sub {
		842	my ($pl, $name, $params) = @_;
481		843
482	#TODO	844	my $cb = $COMMAND{$name}
483	}	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	);
484		871
485	sub load_extension {	872	sub load_extension {
486	my ($path) = @_;	873	my ($path) = @_;
487		874
488	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
489	my $base = $1;	876	my $base = $1;
490	my $pkg = $1;	877	my $pkg = $1;
491	$pkg =~ s/[^[:word:]]/_/g;	878	$pkg =~ s/[^[:word:]]/_/g;
492	$pkg = "ext::$pkg";	879	$pkg = "ext::$pkg";
493		880
494	warn "loading '$path' into '$pkg'\n";	881	warn "... loading '$path' into '$pkg'\n";
495		882
496	open my $fh, "<:utf8", $path	883	open my $fh, "<:utf8", $path
497	or die "$path: $!";	884	or die "$path: $!";
498		885
499	my $source =	886	my $source =
500	"package $pkg; use strict; use utf8;\n"	887	"package $pkg; use strict; use utf8;\n"
501	. "#line 1 \"$path\"\n{\n"	888	. "#line 1 \"$path\"\n{\n"
502	. (do { local $/; <$fh> })	889	. (do { local $/; <$fh> })
503	. "\n};\n1";	890	. "\n};\n1";
504		891
505	eval $source	892	unless (eval $source) {
506	or die "$path: $@";	893	my $msg = $@ ? "$path: $@\n"
507		894	: "extension disabled.\n";
508	push @exts, $pkg;	895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
509	$ext_pkg{$base} = $pkg;	896	warn $@;
510		897	warn "mandatory extension failed to load, exiting.\n";
511	# no strict 'refs';	898	exit 1;
512	# @{"$pkg\::ISA"} = ext::;	899	}
513		900	die $@;
514	register $base, $pkg;
515	}
516
517	sub unload_extension {
518	my ($pkg) = @_;
519
520	warn "removing extension $pkg\n";
521
522	# remove hooks
523	#TODO
524	# for my $idx (0 .. $#PLUGIN_EVENT) {
525	# delete $hook[$idx]{$pkg};
526	# }	901	}
527		902
528	# remove commands	903	push @EXTS, $pkg;
529	for my $name (keys %command) {
530	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
531
532	if (@cb) {
533	$command{$name} = \@cb;
534	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
535	} else {
536	delete $command{$name};
537	delete $COMMAND{"$name\000"};
538	}
539	}
540
541	# remove extcmds
542	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
543	delete $extcmd{$name};
544	}
545
546	if (my $cb = $pkg->can ("unload")) {
547	eval {
548	$cb->($pkg);
549	1
550	} or warn "$pkg unloaded, but with errors: $@";
551	}
552
553	Symbol::delete_package $pkg;
554	}	904	}
555		905
556	sub load_extensions {	906	sub load_extensions {
557	my $LIBDIR = maps_directory "perl";
558
559	for my $ext (<$LIBDIR/*.ext>) {	907	for my $ext (<$LIBDIR/*.ext>) {
560	next unless -r $ext;	908	next unless -r $ext;
561	eval {	909	eval {
562	load_extension $ext;	910	load_extension $ext;
563	1	911	1
564	} or warn "$ext not loaded: $@";	912	} or warn "$ext not loaded: $@";
565	}	913	}
566	}	914	}
567		915
568	sub _perl_reload(&) {	916	#############################################################################
		917
		918	=head2 CORE EXTENSIONS
		919
		920	Functions and methods that extend core crossfire objects.
		921
		922	=cut
		923
		924	package cf::player;
		925
		926	use Coro::AIO;
		927
		928	=head3 cf::player
		929
		930	=over 4
		931
		932	=item cf::player::find $login
		933
		934	Returns the given player object, loading it if necessary (might block).
		935
		936	=cut
		937
		938	sub playerdir($) {
		939	cf::localdir
		940	. "/"
		941	. cf::playerdir
		942	. "/"
		943	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		944	}
		945
		946	sub path($) {
		947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		948
		949	(playerdir $login) . "/$login.pl"
		950	}
		951
		952	sub find_active($) {
		953	$cf::PLAYER{$_[0]}
		954	and $cf::PLAYER{$_[0]}->active
		955	and $cf::PLAYER{$_[0]}
		956	}
		957
		958	sub exists($) {
569	my ($msg) = @_;	959	my ($login) = @_;
570		960
571	$msg->("reloading...");	961	$cf::PLAYER{$login}
		962	or cf::sync_job { !aio_stat $login }
		963	}
572		964
573	eval {	965	sub find($) {
574	# 1. cancel all watchers	966	return $cf::PLAYER{$_[0]} || do {
575	$_->cancel for Event::all_watchers;	967	my $login = $_[0];
576		968
577	# 2. unload all extensions	969	my $guard = cf::lock_acquire "user_find:$login";
578	for (@exts) {
579	$msg->("unloading <$_>");
580	unload_extension $_;
581	}
582		970
583	# 3. unload all modules loaded from $LIBDIR	971	$cf::PLAYER{$_[0]} || do {
584	while (my ($k, $v) = each %INC) {	972	my $pl = load_pl path $login
585	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	973	or return;
586		974	$cf::PLAYER{$login} = $pl
587	$msg->("removing <$k>");
588	delete $INC{$k};
589
590	$k =~ s/\.pm$//;
591	$k =~ s/\//::/g;
592
593	if (my $cb = $k->can ("unload_module")) {
594	$cb->();
595	}
596
597	Symbol::delete_package $k;
598	}
599
600	# 4. get rid of safe::, as good as possible
601	Symbol::delete_package "safe::$_"
602	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
603
604	# 5. remove register_script_function callbacks
605	# TODO
606		975	}
607	# 6. unload cf.pm "a bit"	976	}
608	delete $INC{"cf.pm"};	977	}
609		978
610	# don't, removes xs symbols, too,	979	sub save($) {
611	# and global variables created in xs	980	my ($pl) = @_;
612	#Symbol::delete_package __PACKAGE__;
613		981
614	# 7. reload cf.pm	982	return if $pl->{deny_save};
615	$msg->("reloading cf.pm");	983
616	require cf;	984	my $path = path $pl;
		985	my $guard = cf::lock_acquire "user_save:$path";
		986
		987	return if $pl->{deny_save};
		988
		989	aio_mkdir playerdir $pl, 0770;
		990	$pl->{last_save} = $cf::RUNTIME;
		991
		992	$pl->save_pl ($path);
		993	Coro::cede;
		994	}
		995
		996	sub new($) {
		997	my ($login) = @_;
		998
		999	my $self = create;
		1000
		1001	$self->ob->name ($login);
		1002	$self->{deny_save} = 1;
		1003
		1004	$cf::PLAYER{$login} = $self;
		1005
		1006	$self
		1007	}
		1008
		1009	=item $pl->quit_character
		1010
		1011	Nukes the player without looking back. If logged in, the connection will
		1012	be destroyed. May block for a long time.
		1013
		1014	=cut
		1015
		1016	sub quit_character {
		1017	my ($pl) = @_;
		1018
		1019	$pl->{deny_save} = 1;
		1020	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1021
		1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1023	$pl->deactivate;
		1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1025	$pl->ns->destroy if $pl->ns;
		1026
		1027	my $path = playerdir $pl;
		1028	my $temp = "$path~$cf::RUNTIME~deleting~";
		1029	aio_rename $path, $temp;
		1030	delete $cf::PLAYER{$pl->ob->name};
		1031	$pl->destroy;
		1032	IO::AIO::aio_rmtree $temp;
		1033	}
		1034
		1035	=item cf::player::list_logins
		1036
		1037	Returns am arrayref of all valid playernames in the system, can take a
		1038	while and may block, so not sync_job-capable, ever.
		1039
		1040	=cut
		1041
		1042	sub list_logins {
		1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1044	or return [];
		1045
		1046	my @logins;
		1047
		1048	for my $login (@$dirs) {
		1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1050	aio_read $fh, 0, 512, my $buf, 0 or next;
		1051	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1052
		1053	utf8::decode $login;
		1054	push @logins, $login;
		1055	}
		1056
		1057	\@logins
		1058	}
		1059
		1060	=item $player->maps
		1061
		1062	Returns an arrayref of map paths that are private for this
		1063	player. May block.
		1064
		1065	=cut
		1066
		1067	sub maps($) {
		1068	my ($pl) = @_;
		1069
		1070	my $files = aio_readdir playerdir $pl
		1071	or return;
		1072
		1073	my @paths;
		1074
		1075	for (@$files) {
		1076	utf8::decode $_;
		1077	next if /\.(?:pl|pst)$/;
		1078	next unless /^$PATH_SEP/o;
		1079
		1080	s/\.map$//;
		1081	push @paths, "~" . $pl->ob->name . "/" . $_;
		1082	}
		1083
		1084	\@paths
		1085	}
		1086
		1087	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1088
		1089	Sends an ext reply to the player.
		1090
		1091	=cut
		1092
		1093	sub ext_reply($$$%) {
		1094	my ($self, $id, %msg) = @_;
		1095
		1096	$msg{msgid} = $id;
		1097
		1098	$self->send ("ext " . cf::to_json \%msg);
		1099	}
		1100
		1101	package cf;
		1102
		1103	=back
		1104
		1105
		1106	=head3 cf::map
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	package cf::map;
		1113
		1114	use Fcntl;
		1115	use Coro::AIO;
		1116
		1117	use overload
		1118	'""' => \&as_string,
		1119	fallback => 1;
		1120
		1121	our $MAX_RESET = 3600;
		1122	our $DEFAULT_RESET = 3000;
		1123
		1124	sub generate_random_map {
		1125	my ($self, $rmp) = @_;
		1126
		1127	# mit "rum" bekleckern, nicht
		1128	$self->_create_random_map (
		1129	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1130	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1131	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1132	$rmp->{exit_on_final_map},
		1133	$rmp->{xsize}, $rmp->{ysize},
		1134	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1135	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1136	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1137	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1138	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1139	(cf::region::find $rmp->{region}), $rmp->{custom}
		1140	)
		1141	}
		1142
		1143	sub register {
		1144	my (undef, $regex) = @_;
		1145	my $pkg = caller;
		1146
		1147	no strict;
		1148	push @{"$pkg\::ISA"}, __PACKAGE__;
		1149
		1150	$EXT_MAP{$pkg} = qr<$regex>;
		1151	}
		1152
		1153	# also paths starting with '/'
		1154	$EXT_MAP{"cf::map"} = qr{^(?=/)};
		1155
		1156	sub thawer_merge {
		1157	my ($self, $merge) = @_;
		1158
		1159	# we have to keep some variables in memory intact
		1160	local $self->{path};
		1161	local $self->{load_path};
		1162	local $self->{deny_save};
		1163	local $self->{deny_reset};
		1164
		1165	$self->SUPER::thawer_merge ($merge);
		1166	}
		1167
		1168	sub normalise {
		1169	my ($path, $base) = @_;
		1170
		1171	# map plan:
		1172	#
		1173	# /! non-realised random map exit (special hack!)
		1174	# {... are special paths that are not being touched
		1175	# ?xxx/... are special absolute paths
		1176	# ?random/... random maps
		1177	# /... normal maps
		1178	# ~user/... per-player map of a specific user
		1179
		1180	$path =~ s/$PATH_SEP/\//go;
		1181
		1182	# treat it as relative path if it starts with
		1183	# something that looks reasonable
		1184	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1185	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1186
		1187	$base =~ s{[^/]+/?$}{};
		1188	$path = "$base/$path";
		1189	}
		1190
		1191	for ($path) {
		1192	redo if s{//}{/};
		1193	redo if s{/\.?/}{/};
		1194	redo if s{/[^/]+/\.\./}{/};
		1195	}
		1196
		1197	$path
		1198	}
		1199
		1200	sub new_from_path {
		1201	my (undef, $path, $base) = @_;
		1202
		1203	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1204
		1205	$path = normalise $path, $base;
		1206
		1207	for my $pkg (keys %EXT_MAP) {
		1208	if ($path =~ $EXT_MAP{$pkg}) {
		1209	my $self = bless cf::map::new, $pkg;
		1210	$self->{path} = $path; $self->path ($path);
		1211	$self->init; # pass $1 etc.
		1212	return $self;
		1213	}
		1214	}
		1215
		1216	Carp::carp "unable to resolve path '$path'.";
		1217	()
		1218	}
		1219
		1220	sub init {
		1221	my ($self) = @_;
		1222
		1223	$self
		1224	}
		1225
		1226	sub as_string {
		1227	my ($self) = @_;
		1228
		1229	"$self->{path}"
		1230	}
		1231
		1232	# the displayed name, this is a one way mapping
		1233	sub visible_name {
		1234	&as_string
		1235	}
		1236
		1237	# the original (read-only) location
		1238	sub load_path {
		1239	my ($self) = @_;
		1240
		1241	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1242	}
		1243
		1244	# the temporary/swap location
		1245	sub save_path {
		1246	my ($self) = @_;
		1247
		1248	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1249	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1250	}
		1251
		1252	# the unique path, undef == no special unique path
		1253	sub uniq_path {
		1254	my ($self) = @_;
		1255
		1256	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1257	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1258	}
		1259
		1260	# and all this just because we cannot iterate over
		1261	# all maps in C++...
		1262	sub change_all_map_light {
		1263	my ($change) = @_;
		1264
		1265	$_->change_map_light ($change)
		1266	for grep $_->outdoor, values %cf::MAP;
		1267	}
		1268
		1269	sub unlink_save {
		1270	my ($self) = @_;
		1271
		1272	utf8::encode (my $save = $self->save_path);
		1273	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1274	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1275	}
		1276
		1277	sub load_header_from($) {
		1278	my ($self, $path) = @_;
		1279
		1280	utf8::encode $path;
		1281	aio_open $path, O_RDONLY, 0
		1282	or return;
		1283
		1284	$self->_load_header ($path)
		1285	or return;
		1286
		1287	$self->{load_path} = $path;
		1288
		1289	1
		1290	}
		1291
		1292	sub load_orig {
		1293	my ($self) = @_;
		1294
		1295	$self->load_header_from ($self->load_path)
		1296	}
		1297
		1298	sub load_temp {
		1299	my ($self) = @_;
		1300
		1301	$self->load_header_from ($self->save_path)
		1302	}
		1303
		1304	sub load_header {
		1305	my ($self) = @_;
		1306
		1307	if ($self->load_temp) {
		1308	$self->last_access ((delete $self->{last_access})
		1309	|| $cf::RUNTIME); #d#
		1310	# safety
		1311	$self->{instantiate_time} = $cf::RUNTIME
		1312	if $self->{instantiate_time} > $cf::RUNTIME;
		1313	} else {
		1314	$self->load_orig
		1315	or return;
		1316
		1317	$self->{load_original} = 1;
		1318	$self->{instantiate_time} = $cf::RUNTIME;
		1319	$self->last_access ($cf::RUNTIME);
		1320	$self->instantiate;
		1321	}
		1322
		1323	1
		1324	}
		1325
		1326	sub find;
		1327	sub find {
		1328	my ($path, $origin) = @_;
		1329
		1330	$path = normalise $path, $origin && $origin->path;
		1331
		1332	cf::lock_wait "map_find:$path";
		1333
		1334	$cf::MAP{$path} || do {
		1335	my $guard = cf::lock_acquire "map_find:$path";
		1336	my $map = new_from_path cf::map $path
		1337	or return;
		1338
		1339	$map->{last_save} = $cf::RUNTIME;
		1340
		1341	$map->load_header
		1342	or return;
		1343
		1344	if ($map->should_reset) {
		1345	$cf::WAIT_FOR_TICK->wait;
		1346	$map->reset;
		1347	undef $guard;
		1348	$map = find $path
		1349	or return;
		1350	}
		1351
		1352	$cf::MAP{$path} = $map
		1353	}
		1354	}
		1355
		1356	sub load {
		1357	my ($self) = @_;
		1358
		1359	my $path = $self->{path};
		1360	my $guard = cf::lock_acquire "map_load:$path";
		1361
		1362	return if $self->in_memory != cf::MAP_SWAPPED;
		1363
		1364	$self->in_memory (cf::MAP_LOADING);
		1365
		1366	$self->alloc;
		1367	$self->_load_objects ($self->{load_path}, 1)
		1368	or return;
		1369
		1370	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1371	if delete $self->{load_original};
		1372
		1373	if (my $uniq = $self->uniq_path) {
		1374	utf8::encode $uniq;
		1375	if (aio_open $uniq, O_RDONLY, 0) {
		1376	$self->clear_unique_items;
		1377	$self->_load_objects ($uniq, 0);
		1378	}
		1379	}
		1380
		1381	Coro::cede;
		1382
		1383	# now do the right thing for maps
		1384	$self->link_multipart_objects;
		1385
		1386	unless ($self->{deny_activate}) {
		1387	$self->decay_objects;
		1388	$self->fix_auto_apply;
		1389	$self->update_buttons;
		1390	Coro::cede;
		1391	$self->set_darkness_map;
		1392	$self->difficulty ($self->estimate_difficulty)
		1393	unless $self->difficulty;
		1394	Coro::cede;
		1395	$self->activate;
		1396	}
		1397
		1398	$self->in_memory (cf::MAP_IN_MEMORY);
		1399	}
		1400
		1401	sub customise_for {
		1402	my ($self, $ob) = @_;
		1403
		1404	return find "~" . $ob->name . "/" . $self->{path}
		1405	if $self->per_player;
		1406
		1407	$self
		1408	}
		1409
		1410	# find and load all maps in the 3x3 area around a map
		1411	sub load_diag {
		1412	my ($map) = @_;
		1413
		1414	my @diag; # diagonal neighbours
		1415
		1416	for (0 .. 3) {
		1417	my $neigh = $map->tile_path ($_)
		1418	or next;
		1419	$neigh = find $neigh, $map
		1420	or next;
		1421	$neigh->load;
		1422
		1423	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1424	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1425	}
		1426
		1427	for (@diag) {
		1428	my $neigh = find @$_
		1429	or next;
		1430	$neigh->load;
		1431	}
		1432	}
		1433
		1434	sub find_sync {
		1435	my ($path, $origin) = @_;
		1436
		1437	cf::sync_job { find $path, $origin }
		1438	}
		1439
		1440	sub do_load_sync {
		1441	my ($map) = @_;
		1442
		1443	cf::sync_job { $map->load };
		1444	}
		1445
		1446	our %MAP_PREFETCH;
		1447	our $MAP_PREFETCHER = Coro::async {
		1448	while () {
		1449	for my $path (keys %MAP_PREFETCH) {
		1450	my $map = find $path
		1451	or next;
		1452	$map->load;
		1453
		1454	delete $MAP_PREFETCH{$path};
		1455	}
		1456	Coro::schedule;
		1457	}
		1458	};
		1459
		1460	sub find_async {
		1461	my ($path, $origin) = @_;
		1462
		1463	$path = normalise $path, $origin && $origin->{path};
		1464
		1465	if (my $map = $cf::MAP{$path}) {
		1466	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1467	}
		1468
		1469	$MAP_PREFETCH{$path} = 0;
		1470	$MAP_PREFETCHER->ready;
		1471
		1472	()
		1473	}
		1474
		1475	sub save {
		1476	my ($self) = @_;
		1477
		1478	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1479
		1480	$self->{last_save} = $cf::RUNTIME;
		1481
		1482	return unless $self->dirty;
		1483
		1484	my $save = $self->save_path; utf8::encode $save;
		1485	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1486
		1487	$self->{load_path} = $save;
		1488
		1489	return if $self->{deny_save};
		1490
		1491	local $self->{last_access} = $self->last_access;#d#
		1492
		1493	cf::async {
		1494	$_->contr->save for $self->players;
617	};	1495	};
618	$msg->($@) if $@;
619		1496
620	$msg->("reloaded");	1497	if ($uniq) {
621	};	1498	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
622		1499	$self->_save_objects ($uniq, cf::IO_UNIQUES);
623	sub perl_reload() {	1500	} else {
624	_perl_reload {	1501	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
625	warn $_[0];
626	print "$_[0]\n";
627	};	1502	}
628	}	1503	}
629		1504
630	register_command "perl-reload", 0, sub {	1505	sub swap_out {
631	my ($who, $arg) = @_;
632
633	if ($who->flag (FLAG_WIZ)) {
634	_perl_reload {
635	warn $_[0];
636	$who->message ($_[0]);
637	};
638	}
639	};
640
641	#############################################################################
642	# extcmd framework, basically convert ext <msg>
643	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
644
645	attach_to_players
646	on_extcmd => sub {
647	my ($pl, $buf) = @_;	1506	my ($self) = @_;
648		1507
649	my $msg = eval { from_json $buf };	1508	# save first because save cedes
		1509	$self->save;
650		1510
651	if (ref $msg) {	1511	my $lock = cf::lock_acquire "map_data:" . $self->path;
652	if (my $cb = $extcmd{$msg->{msgtype}}) {
653	if (my %reply = $cb->[0]->($pl, $msg)) {
654	$pl->ext_reply ($msg->{msgid}, %reply);
655	}
656	}
657	} else {
658	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
659	}
660		1512
661	cf::override;	1513	return if $self->players;
		1514	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1515	return if $self->{deny_save};
		1516
		1517	$self->clear;
		1518	$self->in_memory (cf::MAP_SWAPPED);
		1519	}
		1520
		1521	sub reset_at {
		1522	my ($self) = @_;
		1523
		1524	# TODO: safety, remove and allow resettable per-player maps
		1525	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1526	return 1e99 if $self->{deny_reset};
		1527
		1528	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1529	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1530
		1531	$time + $to
		1532	}
		1533
		1534	sub should_reset {
		1535	my ($self) = @_;
		1536
		1537	$self->reset_at <= $cf::RUNTIME
		1538	}
		1539
		1540	sub reset {
		1541	my ($self) = @_;
		1542
		1543	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1544
		1545	return if $self->players;
		1546	return if $self->isa ("ext::map_per_player");#d#
		1547
		1548	warn "resetting map ", $self->path;#d#
		1549
		1550	delete $cf::MAP{$self->path};
		1551
		1552	$self->in_memory (cf::MAP_SWAPPED);
		1553	$self->clear;
		1554
		1555	$_->clear_links_to ($self) for values %cf::MAP;
		1556
		1557	$self->unlink_save;
		1558	$self->destroy;
		1559	}
		1560
		1561	my $nuke_counter = "aaaa";
		1562
		1563	sub nuke {
		1564	my ($self) = @_;
		1565
		1566	delete $cf::MAP{$self->path};
		1567
		1568	$self->unlink_save;
		1569
		1570	bless $self, "cf::map";
		1571	delete $self->{deny_reset};
		1572	$self->{deny_save} = 1;
		1573	$self->reset_timeout (1);
		1574	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1575
		1576	$cf::MAP{$self->path} = $self;
		1577
		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, $_;
662	},	1601	}
663	;
664		1602
665	#############################################################################	1603	\@paths
666	# load/save/clean perl data associated with a map
667
668	*cf::mapsupport::on_clean = sub {
669	my ($map) = @_;
670
671	my $path = $map->tmpname;
672	defined $path or return;
673
674	unlink "$path.cfperl";
675	unlink "$path.pst";
676	};
677
678	*cf::mapsupport::on_swapin =
679	*cf::mapsupport::on_load = sub {
680	my ($map) = @_;
681
682	my $path = $map->tmpname;
683	$path = $map->path unless defined $path;
684
685	open my $fh, "<:raw", "$path.cfperl"
686	or return; # no perl data
687
688	my $data = Storable::thaw do { local $/; <$fh> };
689
690	$data->{version} <= 1
691	or return; # too new
692
693	$map->_set_obs ($data->{obs});
694	};
695
696	attach_to_maps prio => -10000, package => cf::mapsupport::;
697
698	#############################################################################
699	# load/save perl data associated with player->ob objects
700
701	sub all_objects(@) {
702	@_, map all_objects ($_->inv), @_
703	}	1604	}
704		1605
705	attach_to_players	1606	package cf;
706	on_load => sub {
707	my ($pl, $path) = @_;
708		1607
709	for my $o (all_objects $pl->ob) {	1608	=back
710	if (my $value = $o->get_ob_key_value ("_perl_data")) {
711	$o->set_ob_key_value ("_perl_data");
712		1609
713	%$o = %{ Storable::thaw pack "H*", $value };	1610	=head3 cf::object
714	}
715	}
716	},
717	;
718		1611
719	#############################################################################
720	# core extensions - in perl
721
722	=item cf::player::exists $login
723
724	Returns true when the given account exists.
725
726	=cut	1612	=cut
727		1613
728	sub cf::player::exists($) {	1614	package cf::object;
729	cf::player::find $_[0]
730	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
731	}
732		1615
		1616	=over 4
		1617
		1618	=item $ob->inv_recursive
		1619
		1620	Returns the inventory of the object _and_ their inventories, recursively.
		1621
		1622	=cut
		1623
		1624	sub inv_recursive_;
		1625	sub inv_recursive_ {
		1626	map { $_, inv_recursive_ $_->inv } @_
		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
		1640
733	=item $player->reply ($npc, $msg[, $flags])	1641	=item $player_object->reply ($npc, $msg[, $flags])
734		1642
735	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>
736	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
737	dialogue with the given NPC character.	1645	dialogue with the given NPC character.
738		1646
739	=cut	1647	=cut
740		1648
741	# rough implementation of a future "reply" method that works	1649	# rough implementation of a future "reply" method that works
742	# with dialog boxes.	1650	# with dialog boxes.
		1651	#TODO: the first argument must go, split into a $npc->reply_to ( method
743	sub cf::object::player::reply($$$;$) {	1652	sub cf::object::player::reply($$$;$) {
744	my ($self, $npc, $msg, $flags) = @_;	1653	my ($self, $npc, $msg, $flags) = @_;
745		1654
746	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1655	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
747		1656
…		…
751	$msg = $npc->name . " says: $msg" if $npc;	1660	$msg = $npc->name . " says: $msg" if $npc;
752	$self->message ($msg, $flags);	1661	$self->message ($msg, $flags);
753	}	1662	}
754	}	1663	}
755		1664
756	=item $player->ext_reply ($msgid, $msgtype, %msg)	1665	=item $player_object->may ("access")
757		1666
758	Sends an ext reply to the player.	1667	Returns wether the given player is authorized to access resource "access"
		1668	(e.g. "command_wizcast").
759		1669
760	=cut	1670	=cut
761		1671
762	sub cf::player::ext_reply($$$%) {	1672	sub cf::object::player::may {
		1673	my ($self, $access) = @_;
		1674
		1675	$self->flag (cf::FLAG_WIZ) ||
		1676	(ref $cf::CFG{"may_$access"}
		1677	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1678	: $cf::CFG{"may_$access"})
		1679	}
		1680
		1681	=item $player_object->enter_link
		1682
		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 {
763	my ($self, $id, %msg) = @_;	1861	my ($self, $exit) = @_;
764		1862
765	$msg{msgid} = $id;	1863	return unless $self->type == cf::PLAYER;
766		1864
767	$self->send ("ext " . to_json \%msg);	1865	$self->enter_link;
768	}
769		1866
770	#############################################################################	1867	(async {
771	# map scripting support	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
		1990
		1991	=head2 SAFE SCRIPTING
		1992
		1993	Functions that provide a safe environment to compile and execute
		1994	snippets of perl code without them endangering the safety of the server
		1995	itself. Looping constructs, I/O operators and other built-in functionality
		1996	is not available in the safe scripting environment, and the number of
		1997	functions and methods that can be called is greatly reduced.
		1998
		1999	=cut
772		2000
773	our $safe = new Safe "safe";	2001	our $safe = new Safe "safe";
774	our $safe_hole = new Safe::Hole;	2002	our $safe_hole = new Safe::Hole;
775		2003
776	$SIG{FPE} = 'IGNORE';	2004	$SIG{FPE} = 'IGNORE';
777		2005
778	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2006	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
779		2007
780	# here we export the classes and methods available to script code	2008	# here we export the classes and methods available to script code
781		2009
		2010	=pod
		2011
		2012	The following fucntions and emthods are available within a safe environment:
		2013
		2014	cf::object contr pay_amount pay_player map
		2015	cf::object::player player
		2016	cf::player peaceful
		2017	cf::map trigger
		2018
		2019	=cut
		2020
782	for (	2021	for (
783	["cf::object" => qw(contr pay_amount pay_player)],	2022	["cf::object" => qw(contr pay_amount pay_player map)],
784	["cf::object::player" => qw(player)],	2023	["cf::object::player" => qw(player)],
785	["cf::player" => qw(peaceful)],	2024	["cf::player" => qw(peaceful)],
		2025	["cf::map" => qw(trigger)],
786	) {	2026	) {
787	no strict 'refs';	2027	no strict 'refs';
788	my ($pkg, @funs) = @$_;	2028	my ($pkg, @funs) = @$_;
789	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2029	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
790	for @funs;	2030	for @funs;
791	}	2031	}
		2032
		2033	=over 4
		2034
		2035	=item @retval = safe_eval $code, [var => value, ...]
		2036
		2037	Compiled and executes the given perl code snippet. additional var/value
		2038	pairs result in temporary local (my) scalar variables of the given name
		2039	that are available in the code snippet. Example:
		2040
		2041	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2042
		2043	=cut
792		2044
793	sub safe_eval($;@) {	2045	sub safe_eval($;@) {
794	my ($code, %vars) = @_;	2046	my ($code, %vars) = @_;
795		2047
796	my $qcode = $code;	2048	my $qcode = $code;
…		…
819	}	2071	}
820		2072
821	wantarray ? @res : $res[0]	2073	wantarray ? @res : $res[0]
822	}	2074	}
823		2075
		2076	=item cf::register_script_function $function => $cb
		2077
		2078	Register a function that can be called from within map/npc scripts. The
		2079	function should be reasonably secure and should be put into a package name
		2080	like the extension.
		2081
		2082	Example: register a function that gets called whenever a map script calls
		2083	C<rent::overview>, as used by the C<rent> extension.
		2084
		2085	cf::register_script_function "rent::overview" => sub {
		2086	...
		2087	};
		2088
		2089	=cut
		2090
824	sub register_script_function {	2091	sub register_script_function {
825	my ($fun, $cb) = @_;	2092	my ($fun, $cb) = @_;
826		2093
827	no strict 'refs';	2094	no strict 'refs';
828	*{"safe::$fun"} = $safe_hole->wrap ($cb);	2095	*{"safe::$fun"} = $safe_hole->wrap ($cb);
829	}	2096	}
830		2097
		2098	=back
		2099
		2100	=cut
		2101
		2102	#############################################################################
		2103
		2104	=head2 EXTENSION DATABASE SUPPORT
		2105
		2106	Crossfire maintains a very simple database for extension use. It can
		2107	currently store anything that can be serialised using Storable, which
		2108	excludes objects.
		2109
		2110	The parameter C<$family> should best start with the name of the extension
		2111	using it, it should be unique.
		2112
		2113	=over 4
		2114
		2115	=item $hashref = cf::db_get $family
		2116
		2117	Return a hashref for use by the extension C<$family>, which can be
		2118	modified. After modifications, you have to call C<cf::db_dirty> or
		2119	C<cf::db_sync>.
		2120
		2121	=item $value = cf::db_get $family => $key
		2122
		2123	Returns a single value from the database
		2124
		2125	=item cf::db_put $family => $hashref
		2126
		2127	Stores the given family hashref into the database. Updates are delayed, if
		2128	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		2129
		2130	=item cf::db_put $family => $key => $value
		2131
		2132	Stores the given C<$value> in the family hash. Updates are delayed, if you
		2133	want the data to be synced to disk immediately, use C<cf::db_sync>.
		2134
		2135	=item cf::db_dirty
		2136
		2137	Marks the database as dirty, to be updated at a later time.
		2138
		2139	=item cf::db_sync
		2140
		2141	Immediately write the database to disk I<if it is dirty>.
		2142
		2143	=cut
		2144
		2145	our $DB;
		2146
		2147	{
		2148	my $path = cf::localdir . "/database.pst";
		2149
		2150	sub db_load() {
		2151	$DB = stat $path ? Storable::retrieve $path : { };
		2152	}
		2153
		2154	my $pid;
		2155
		2156	sub db_save() {
		2157	waitpid $pid, 0 if $pid;
		2158	if (0 == ($pid = fork)) {
		2159	$DB->{_meta}{version} = 1;
		2160	Storable::nstore $DB, "$path~";
		2161	rename "$path~", $path;
		2162	cf::_exit 0 if defined $pid;
		2163	}
		2164	}
		2165
		2166	my $dirty;
		2167
		2168	sub db_sync() {
		2169	db_save if $dirty;
		2170	undef $dirty;
		2171	}
		2172
		2173	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		2174	db_sync;
		2175	});
		2176
		2177	sub db_dirty() {
		2178	$dirty = 1;
		2179	$idle->start;
		2180	}
		2181
		2182	sub db_get($;$) {
		2183	@_ >= 2
		2184	? $DB->{$_[0]}{$_[1]}
		2185	: ($DB->{$_[0]} ||= { })
		2186	}
		2187
		2188	sub db_put($$;$) {
		2189	if (@_ >= 3) {
		2190	$DB->{$_[0]}{$_[1]} = $_[2];
		2191	} else {
		2192	$DB->{$_[0]} = $_[1];
		2193	}
		2194	db_dirty;
		2195	}
		2196
		2197	cf::global->attach (
		2198	prio => 10000,
		2199	on_cleanup => sub {
		2200	db_sync;
		2201	},
		2202	);
		2203	}
		2204
831	#############################################################################	2205	#############################################################################
832	# the server's main()	2206	# the server's main()
833		2207
		2208	sub cfg_load {
		2209	open my $fh, "<:utf8", cf::confdir . "/config"
		2210	or return;
		2211
		2212	local $/;
		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	}
		2227	}
		2228
834	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
		2236	cfg_load;
		2237	db_load;
		2238	load_extensions;
835	Event::loop;	2239	Event::loop;
836	}	2240	}
837		2241
838	#############################################################################	2242	#############################################################################
839	# initialisation	2243	# initialisation and cleanup
840		2244
841	register "<global>", __PACKAGE__;	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
		2287	sub reload() {
		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	}
		2293
		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;
		2303
		2304	eval {
		2305	# if anything goes wrong in here, we should simply crash as we already saved
		2306
		2307	warn "cancel all watchers";
		2308	for (Event::all_watchers) {
		2309	$_->cancel if $_->data & WF_AUTOCANCEL;
		2310	}
		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
		2322	warn "unload/nuke all extensions";
		2323	for my $pkg (@EXTS) {
		2324	warn "... unloading $pkg";
		2325
		2326	if (my $cb = $pkg->can ("unload")) {
		2327	eval {
		2328	$cb->($pkg);
		2329	1
		2330	} or warn "$pkg unloaded, but with errors: $@";
		2331	}
		2332
		2333	warn "... nuking $pkg";
		2334	Symbol::delete_package $pkg;
		2335	}
		2336
		2337	warn "unload all perl modules loaded from $LIBDIR";
		2338	while (my ($k, $v) = each %INC) {
		2339	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2340
		2341	warn "removing <$k>";
		2342	delete $INC{$k};
		2343
		2344	$k =~ s/\.pm$//;
		2345	$k =~ s/\//::/g;
		2346
		2347	if (my $cb = $k->can ("unload_module")) {
		2348	$cb->();
		2349	}
		2350
		2351	Symbol::delete_package $k;
		2352	}
		2353
		2354	warn "get rid of safe::, as good as possible";
		2355	Symbol::delete_package "safe::$_"
		2356	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2357
		2358	warn "unload cf.pm \"a bit\"";
		2359	delete $INC{"cf.pm"};
		2360
		2361	# don't, removes xs symbols, too,
		2362	# and global variables created in xs
		2363	#Symbol::delete_package __PACKAGE__;
		2364
		2365	warn "reloading cf.pm";
		2366	require cf;
		2367	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2368
		2369	warn "load config and database again";
		2370	cf::cfg_load;
		2371	cf::db_load;
		2372
		2373	warn "load extensions";
		2374	cf::load_extensions;
		2375
		2376	warn "reattach attachments to objects/players";
		2377	_global_reattach;
		2378	warn "reattach attachments to maps";
		2379	reattach $_ for values %MAP;
		2380	};
		2381
		2382	if ($@) {
		2383	warn $@;
		2384	warn "error while reloading, exiting.";
		2385	exit 1;
		2386	}
		2387
		2388	warn "reloaded";
		2389	};
		2390
		2391	register_command "reload" => sub {
		2392	my ($who, $arg) = @_;
		2393
		2394	if ($who->flag (FLAG_WIZ)) {
		2395	$who->message ("start of reload.");
		2396	reload;
		2397	$who->message ("end of reload.");
		2398	}
		2399	};
842		2400
843	unshift @INC, $LIBDIR;	2401	unshift @INC, $LIBDIR;
844		2402
845	load_extensions;
846
847	$TICK_WATCHER = Event->timer (	2403	$TICK_WATCHER = Event->timer (
		2404	reentrant => 0,
848	prio => 1,	2405	prio => 0,
849	at => $NEXT_TICK || 1,	2406	at => $NEXT_TICK || $TICK,
		2407	data => WF_AUTOCANCEL,
850	cb => sub {	2408	cb => sub {
		2409	$NOW = Event::time;
		2410
851	cf::server_tick; # one server iteration	2411	cf::server_tick; # one server iteration
852		2412	$RUNTIME += $TICK;
853	my $NOW = Event::time;
854	$NEXT_TICK += $TICK;	2413	$NEXT_TICK += $TICK;
855		2414
		2415	$WAIT_FOR_TICK->broadcast;
		2416	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2417
856	# if we are delayed by four ticks, skip them all	2418	# if we are delayed by four ticks or more, skip them all
857	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2419	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
858		2420
859	$TICK_WATCHER->at ($NEXT_TICK);	2421	$TICK_WATCHER->at ($NEXT_TICK);
860	$TICK_WATCHER->start;	2422	$TICK_WATCHER->start;
861	},	2423	},
862	);	2424	);
863		2425
		2426	IO::AIO::max_poll_time $TICK * 0.2;
		2427
		2428	$AIO_POLL_WATCHER = Event->io (
		2429	fd => IO::AIO::poll_fileno,
		2430	poll => 'r',
		2431	prio => 5,
		2432	data => WF_AUTOCANCEL,
		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 }
		2449
864	1	2450	1
865		2451

Diff Legend

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