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.60 by root, Thu Aug 31 06:23:19 2006 UTC vs.
Revision 1.115 by root, Mon Jan 1 16:50:10 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 Digest::MD5;
		21	use Fcntl;
		22	use IO::AIO 2.31 ();
		23	use YAML::Syck ();
10	use Time::HiRes;	24	use Time::HiRes;
11	use Event;	25
12	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
13		27
14	use strict;	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		29	$YAML::Syck::ImplicitUnicode = 1;
15		30
16	_reload_1;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		34
18	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
19	our @EVENT;	39	our @EVENT;
20	our %PROP_TYPE;	40	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		41
24	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	43	our $TICK_WATCHER;
26	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
		46
		47	our %CFG;
		48
		49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
		76
		77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		78
		79	#############################################################################
		80
		81	=head2 GLOBAL VARIABLES
		82
		83	=over 4
		84
		85	=item $cf::UPTIME
		86
		87	The timestamp of the server start (so not actually an uptime).
		88
		89	=item $cf::RUNTIME
		90
		91	The time this server has run, starts at 0 and is increased by $cf::TICK on
		92	every server tick.
		93
		94	=item $cf::LIBDIR
		95
		96	The perl library directory, where extensions and cf-specific modules can
		97	be found. It will be added to C<@INC> automatically.
		98
		99	=item $cf::NOW
		100
		101	The time of the last (current) server tick.
		102
		103	=item $cf::TICK
		104
		105	The interval between server ticks, in seconds.
		106
		107	=item %cf::CFG
		108
		109	Configuration for the server, loaded from C</etc/crossfire/config>, or
		110	from wherever your confdir points to.
		111
		112	=back
		113
		114	=cut
27		115
28	BEGIN {	116	BEGIN {
29	*CORE::GLOBAL::warn = sub {	117	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	118	my $msg = join "", @_;
		119	utf8::encode $msg;
		120
31	$msg .= "\n"	121	$msg .= "\n"
32	unless $msg =~ /\n$/;	122	unless $msg =~ /\n$/;
33		123
34	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	124	LOG llevError, "cfperl: $msg";
36	};	125	};
37	}	126	}
38		127
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40		129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41	# generate property mutators	130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42	sub prop_gen {	131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43	my ($prefix, $class) = @_;	132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		134
75	# we bless all objects into (empty) derived classes to force a method lookup	135	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	136	# within the Safe compartment.
77	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	137	for my $pkg (qw(
		138	cf::global cf::attachable
		139	cf::object cf::object::player
		140	cf::client cf::player
		141	cf::arch cf::living
		142	cf::map cf::party cf::region
		143	)) {
78	no strict 'refs';	144	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	146	}
81		147
82	$Event::DIED = sub {	148	$Event::DIED = sub {
…		…
84	};	150	};
85		151
86	my %ext_pkg;	152	my %ext_pkg;
87	my @exts;	153	my @exts;
88	my @hook;	154	my @hook;
89	my %command;
90	my %extcmd;
91		155
92	#############################################################################	156	=head2 UTILITY FUNCTIONS
93	# utility functions	157
		158	=over 4
		159
		160	=cut
94		161
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	162	use JSON::Syck (); # TODO# replace by JSON::PC once working
		163
		164	=item $ref = cf::from_json $json
		165
		166	Converts a JSON string into the corresponding perl data structure.
		167
		168	=cut
96		169
97	sub from_json($) {	170	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	172	JSON::Syck::Load $_[0]
100	}	173	}
101		174
		175	=item $json = cf::to_json $ref
		176
		177	Converts a perl data structure into its JSON representation.
		178
		179	=cut
		180
102	sub to_json($) {	181	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
105	}	184	}
106		185
		186	=item cf::sync_job { BLOCK }
		187
		188	The design of crossfire+ requires that the main coro ($Coro::main) is
		189	always able to handle events or runnable, as crossfire+ is only partly
		190	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		191
		192	If it must be done, put the blocking parts into C<sync_job>. This will run
		193	the given BLOCK in another coroutine while waiting for the result. The
		194	server will be frozen during this time, so the block should either finish
		195	fast or be very important.
		196
		197	=cut
		198
		199	sub sync_job(&) {
		200	my ($job) = @_;
		201
		202	if ($Coro::current == $Coro::main) {
		203	# this is the main coro, too bad, we have to block
		204	# till the operation succeeds, freezing the server :/
		205
		206	# TODO: use suspend/resume instead
		207	# (but this is cancel-safe)
		208	local $FREEZE = 1;
		209
		210	my $busy = 1;
		211	my @res;
		212
		213	(Coro::async {
		214	@res = eval { $job->() };
		215	warn $@ if $@;
		216	undef $busy;
		217	})->prio (Coro::PRIO_MAX);
		218
		219	while ($busy) {
		220	Coro::cede_notself;
		221	Event::one_event unless Coro::nready;
		222	}
		223
		224	wantarray ? @res : $res[0]
		225	} else {
		226	# we are in another coroutine, how wonderful, everything just works
		227
		228	$job->()
		229	}
		230	}
		231
		232	=item $coro = cf::coro { BLOCK }
		233
		234	Creates and returns a new coro. This coro is automcatially being canceled
		235	when the extension calling this is being unloaded.
		236
		237	=cut
		238
		239	sub coro(&) {
		240	my $cb = shift;
		241
		242	my $coro; $coro = async {
		243	eval {
		244	$cb->();
		245	};
		246	warn $@ if $@;
		247	};
		248
		249	$coro->on_destroy (sub {
		250	delete $EXT_CORO{$coro+0};
		251	});
		252	$EXT_CORO{$coro+0} = $coro;
		253
		254	$coro
		255	}
		256
		257	sub write_runtime {
		258	my $runtime = cf::localdir . "/runtime";
		259
		260	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		261	or return;
		262
		263	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		264	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		265	and return;
		266
		267	aio_fsync $fh
		268	and return;
		269
		270	close $fh
		271	or return;
		272
		273	aio_rename "$runtime~", $runtime
		274	and return;
		275
		276	1
		277	}
		278
		279	=back
		280
		281	=cut
		282
107	#############################################################################	283	#############################################################################
108	# "new" plug-in system
109		284
110	=head3 EVENTS AND OBJECT ATTACHMENTS	285	package cf::path;
		286
		287	sub new {
		288	my ($class, $path, $base) = @_;
		289
		290	$path = $path->as_string if ref $path;
		291
		292	my $self = bless { }, $class;
		293
		294	# {... are special paths that are not touched
		295	# ?xxx/... are special absolute paths
		296	# ?random/... random maps
		297	# /! non-realised random map exit
		298	# /... normal maps
		299	# ~/... per-player maps without a specific player (DO NOT USE)
		300	# ~user/... per-player map of a specific user
		301
		302	if ($path =~ /^{/) {
		303	# fine as it is
		304	} elsif ($path =~ s{^\?random/}{}) {
		305	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		306	$self->{random} = cf::from_json $data;
		307	} else {
		308	if ($path =~ s{^~([^/]+)?}{}) {
		309	$self->{user_rel} = 1;
		310
		311	if (defined $1) {
		312	$self->{user} = $1;
		313	} elsif ($base =~ m{^~([^/]+)/}) {
		314	$self->{user} = $1;
		315	} else {
		316	warn "cannot resolve user-relative path without user <$path,$base>\n";
		317	}
		318	} elsif ($path =~ /^\//) {
		319	# already absolute
		320	} else {
		321	$base =~ s{[^/]+/?$}{};
		322	return $class->new ("$base/$path");
		323	}
		324
		325	for ($path) {
		326	redo if s{/\.?/}{/};
		327	redo if s{/[^/]+/\.\./}{/};
		328	}
		329	}
		330
		331	$self->{path} = $path;
		332
		333	$self
		334	}
		335
		336	# the name / primary key / in-game path
		337	sub as_string {
		338	my ($self) = @_;
		339
		340	$self->{user_rel} ? "~$self->{user}$self->{path}"
		341	: $self->{random} ? "?random/$self->{path}"
		342	: $self->{path}
		343	}
		344
		345	# the displayed name, this is a one way mapping
		346	sub visible_name {
		347	my ($self) = @_;
		348
		349	# if (my $rmp = $self->{random}) {
		350	# # todo: be more intelligent about this
		351	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		352	# } else {
		353	$self->as_string
		354	# }
		355	}
		356
		357	# escape the /'s in the path
		358	sub _escaped_path {
		359	# ∕ is U+2215
		360	(my $path = $_[0]{path}) =~ s/\//∕/g;
		361	$path
		362	}
		363
		364	# the original (read-only) location
		365	sub load_path {
		366	my ($self) = @_;
		367
		368	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		369	}
		370
		371	# the temporary/swap location
		372	sub save_path {
		373	my ($self) = @_;
		374
		375	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		376	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		377	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		378	}
		379
		380	# the unique path, might be eq to save_path
		381	sub uniq_path {
		382	my ($self) = @_;
		383
		384	$self->{user_rel} || $self->{random}
		385	? undef
		386	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		387	}
		388
		389	# return random map parameters, or undef
		390	sub random_map_params {
		391	my ($self) = @_;
		392
		393	$self->{random}
		394	}
		395
		396	# this is somewhat ugly, but style maps do need special treatment
		397	sub is_style_map {
		398	$_[0]{path} =~ m{^/styles/}
		399	}
		400
		401	package cf;
		402
		403	#############################################################################
		404
		405	=head2 ATTACHABLE OBJECTS
		406
		407	Many objects in crossfire are so-called attachable objects. That means you can
		408	attach callbacks/event handlers (a collection of which is called an "attachment")
		409	to it. All such attachable objects support the following methods.
		410
		411	In the following description, CLASS can be any of C<global>, C<object>
		412	C<player>, C<client> or C<map> (i.e. the attachable objects in
		413	crossfire+).
111		414
112	=over 4	415	=over 4
113		416
114	=item $object->attach ($attachment, key => $value...)
115
116	=item $object->detach ($attachment)
117
118	Attach/detach a pre-registered attachment to an object.
119
120	=item $player->attach ($attachment, key => $value...)
121
122	=item $player->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to a player.
125
126	=item $map->attach ($attachment, key => $value...)	417	=item $attachable->attach ($attachment, key => $value...)
127		418
128	=item $map->detach ($attachment)	419	=item $attachable->detach ($attachment)
129		420
130	Attach/detach a pre-registered attachment to a map.	421	Attach/detach a pre-registered attachment to a specific object and give it
		422	the specified key/value pairs as arguments.
131		423
132	=item $bool = $object->attached ($name)	424	Example, attach a minesweeper attachment to the given object, making it a
		425	10x10 minesweeper game:
133		426
134	=item $bool = $player->attached ($name)	427	$obj->attach (minesweeper => width => 10, height => 10);
135		428
136	=item $bool = $map->attached ($name)	429	=item $bool = $attachable->attached ($name)
137		430
138	Checks wether the named attachment is currently attached to the object.	431	Checks wether the named attachment is currently attached to the object.
139		432
140	=item cf::attach_global ...	433	=item cf::CLASS->attach ...
141		434
142	Attach handlers for global events.	435	=item cf::CLASS->detach ...
143		436
144	This and all following C<attach_*>-functions expect any number of the	437	Define an anonymous attachment and attach it to all objects of the given
145	following handler/hook descriptions:	438	CLASS. See the next function for an explanation of its arguments.
		439
		440	You can attach to global events by using the C<cf::global> class.
		441
		442	Example, log all player logins:
		443
		444	cf::player->attach (
		445	on_login => sub {
		446	my ($pl) = @_;
		447	...
		448	},
		449	);
		450
		451	Example, attach to the jeweler skill:
		452
		453	cf::object->attach (
		454	type => cf::SKILL,
		455	subtype => cf::SK_JEWELER,
		456	on_use_skill => sub {
		457	my ($sk, $ob, $part, $dir, $msg) = @_;
		458	...
		459	},
		460	);
		461
		462	=item cf::CLASS::attachment $name, ...
		463
		464	Register an attachment by C<$name> through which attachable objects of the
		465	given CLASS can refer to this attachment.
		466
		467	Some classes such as crossfire maps and objects can specify attachments
		468	that are attached at load/instantiate time, thus the need for a name.
		469
		470	These calls expect any number of the following handler/hook descriptions:
146		471
147	=over 4	472	=over 4
148		473
149	=item prio => $number	474	=item prio => $number
150		475
…		…
152	by another C<prio> setting). Lower priority handlers get executed	477	by another C<prio> setting). Lower priority handlers get executed
153	earlier. The default priority is C<0>, and many built-in handlers are	478	earlier. The default priority is C<0>, and many built-in handlers are
154	registered at priority C<-1000>, so lower priorities should not be used	479	registered at priority C<-1000>, so lower priorities should not be used
155	unless you know what you are doing.	480	unless you know what you are doing.
156		481
		482	=item type => $type
		483
		484	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		485	given type of objects only (the additional parameter C<subtype> can be
		486	used to further limit to the given subtype).
		487
157	=item on_I<event> => \&cb	488	=item on_I<event> => \&cb
158		489
159	Call the given code reference whenever the named event happens (event is	490	Call the given code reference whenever the named event happens (event is
160	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	491	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
161	handlers are recognised generally depends on the type of object these	492	handlers are recognised generally depends on the type of object these
…		…
170	package and register them. Only handlers for eevents supported by the	501	package and register them. Only handlers for eevents supported by the
171	object/class are recognised.	502	object/class are recognised.
172		503
173	=back	504	=back
174		505
175	=item cf::attach_to_type $object_type, $subtype, ...	506	Example, define an attachment called "sockpuppet" that calls the given
		507	event handler when a monster attacks:
176		508
177	Attach handlers for a specific object type (e.g. TRANSPORT) and	509	cf::object::attachment sockpuppet =>
178	subtype. If C<$subtype> is zero or undef, matches all objects of the given	510	on_skill_attack => sub {
179	type.	511	my ($self, $victim) = @_;
180		512	...
181	=item cf::attach_to_objects ...
182
183	Attach handlers to all objects. Do not use this except for debugging or
184	very rare events, as handlers are (obviously) called for I<all> objects in
185	the game.
186
187	=item cf::attach_to_players ...
188
189	Attach handlers to all players.
190
191	=item cf::attach_to_maps ...
192
193	Attach handlers to all maps.
194
195	=item cf:register_attachment $name, ...
196
197	Register an attachment by name through which objects can refer to this
198	attachment.
199
200	=item cf:register_player_attachment $name, ...
201
202	Register an attachment by name through which players can refer to this
203	attachment.
204
205	=item cf:register_map_attachment $name, ...
206
207	Register an attachment by name through which maps can refer to this
208	attachment.
209
210	=cut
211
212	# the following variables are defined in .xs and must not be re-created
213	our @CB_GLOBAL = (); # registry for all global events
214	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215	our @CB_PLAYER = ();
216	our @CB_TYPE = (); # registry for type (cf-object class) based events
217	our @CB_MAP = ();
218
219	my %attachment;
220
221	sub _attach_cb($\%$$$) {
222	my ($registry, $undo, $event, $prio, $cb) = @_;
223
224	use sort 'stable';
225
226	$cb = [$prio, $cb];
227
228	@{$registry->[$event]} = sort
229	{ $a->[0] cmp $b->[0] }
230	@{$registry->[$event] || []}, $cb;
231
232	push @{$undo->{cb}}, [$event, $cb];
233	}
234
235	# attach handles attaching event callbacks
236	# the only thing the caller has to do is pass the correct
237	# registry (== where the callback attaches to).
238	sub _attach(\@$@) {
239	my ($registry, $klass, @arg) = @_;
240
241	my $prio = 0;
242
243	my %undo = (
244	registry => $registry,
245	cb => [],
246	);
247
248	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
249
250	while (@arg) {
251	my $type = shift @arg;
252
253	if ($type eq "prio") {
254	$prio = shift @arg;
255
256	} elsif ($type eq "package") {
257	my $pkg = shift @arg;
258
259	while (my ($name, $id) = each %cb_id) {
260	if (my $cb = $pkg->can ($name)) {
261	_attach_cb $registry, %undo, $id, $prio, $cb;
262	}
263	}	513	}
264
265	} elsif (exists $cb_id{$type}) {
266	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
267
268	} elsif (ref $type) {
269	warn "attaching objects not supported, ignoring.\n";
270
271	} else {
272	shift @arg;
273	warn "attach argument '$type' not supported, ignoring.\n";
274	}
275	}
276
277	\%undo
278	}
279
280	sub _attach_attachment {
281	my ($obj, $name, %arg) = @_;
282
283	return if exists $obj->{_attachment}{$name};
284
285	my $res;
286
287	if (my $attach = $attachment{$name}) {
288	my $registry = $obj->registry;
289
290	for (@$attach) {
291	my ($klass, @attach) = @$_;
292	$res = _attach @$registry, $klass, @attach;
293	}
294
295	$obj->{$name} = \%arg;
296	} else {
297	warn "object uses attachment '$name' that is not available, postponing.\n";
298	}
299
300	$obj->{_attachment}{$name} = undef;
301
302	$res->{attachment} = $name;
303	$res
304	}
305
306	*cf::object::attach =
307	*cf::player::attach =
308	*cf::map::attach = sub {
309	my ($obj, $name, %arg) = @_;
310
311	_attach_attachment $obj, $name, %arg;
312	};
313
314	# all those should be optimised
315	*cf::object::detach =
316	*cf::player::detach =
317	*cf::map::detach = sub {
318	my ($obj, $name) = @_;
319
320	delete $obj->{_attachment}{$name};
321	reattach ($obj);
322	};
323
324	*cf::object::attached =
325	*cf::player::attached =
326	*cf::map::attached = sub {
327	my ($obj, $name) = @_;
328
329	exists $obj->{_attachment}{$name}
330	};
331
332	sub attach_global {
333	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
334	}
335
336	sub attach_to_type {
337	my $type = shift;
338	my $subtype = shift;
339
340	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
341	}
342
343	sub attach_to_objects {
344	_attach @CB_OBJECT, KLASS_OBJECT, @_
345	}
346
347	sub attach_to_players {
348	_attach @CB_PLAYER, KLASS_PLAYER, @_
349	}
350
351	sub attach_to_maps {
352	_attach @CB_MAP, KLASS_MAP, @_
353	}
354
355	sub register_attachment {
356	my $name = shift;
357
358	$attachment{$name} = [[KLASS_OBJECT, @_]];
359	}
360
361	sub register_player_attachment {
362	my $name = shift;
363
364	$attachment{$name} = [[KLASS_PLAYER, @_]];
365	}
366
367	sub register_map_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_MAP, @_]];
371	}
372
373	our $override;
374	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
375
376	sub override {
377	$override = 1;
378	@invoke_results = ();
379	}
380
381	sub do_invoke {
382	my $event = shift;
383	my $callbacks = shift;
384
385	@invoke_results = ();
386
387	local $override;
388
389	for (@$callbacks) {
390	eval { &{$_->[1]} };
391
392	if ($@) {
393	warn "$@";
394	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
395	override;
396	}
397
398	return 1 if $override;
399	}
400
401	0	514	}
402	}
403		515
404	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	516	=item $attachable->valid
405
406	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407
408	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
409
410	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411
412	Generate a global/object/player/map-specific event with the given arguments.
413
414	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
415	removed in future versions), and there is no public API to access override
416	results (if you must, access C<@cf::invoke_results> directly).
417
418	=back
419
420	=head2 methods valid for all pointers
421
422	=over 4
423
424	=item $object->valid
425
426	=item $player->valid
427
428	=item $map->valid
429		517
430	Just because you have a perl object does not mean that the corresponding	518	Just because you have a perl object does not mean that the corresponding
431	C-level object still exists. If you try to access an object that has no	519	C-level object still exists. If you try to access an object that has no
432	valid C counterpart anymore you get an exception at runtime. This method	520	valid C counterpart anymore you get an exception at runtime. This method
433	can be used to test for existence of the C object part without causing an	521	can be used to test for existence of the C object part without causing an
434	exception.	522	exception.
435		523
		524	=cut
		525
		526	# the following variables are defined in .xs and must not be re-created
		527	our @CB_GLOBAL = (); # registry for all global events
		528	our @CB_ATTACHABLE = (); # registry for all attachables
		529	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		530	our @CB_PLAYER = ();
		531	our @CB_CLIENT = ();
		532	our @CB_TYPE = (); # registry for type (cf-object class) based events
		533	our @CB_MAP = ();
		534
		535	my %attachment;
		536
		537	sub _attach_cb($$$$) {
		538	my ($registry, $event, $prio, $cb) = @_;
		539
		540	use sort 'stable';
		541
		542	$cb = [$prio, $cb];
		543
		544	@{$registry->[$event]} = sort
		545	{ $a->[0] cmp $b->[0] }
		546	@{$registry->[$event] || []}, $cb;
		547	}
		548
		549	# hack
		550	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		551
		552	# attach handles attaching event callbacks
		553	# the only thing the caller has to do is pass the correct
		554	# registry (== where the callback attaches to).
		555	sub _attach {
		556	my ($registry, $klass, @arg) = @_;
		557
		558	my $object_type;
		559	my $prio = 0;
		560	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		561
		562	#TODO: get rid of this hack
		563	if ($attachable_klass{$klass}) {
		564	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		565	}
		566
		567	while (@arg) {
		568	my $type = shift @arg;
		569
		570	if ($type eq "prio") {
		571	$prio = shift @arg;
		572
		573	} elsif ($type eq "type") {
		574	$object_type = shift @arg;
		575	$registry = $CB_TYPE[$object_type] ||= [];
		576
		577	} elsif ($type eq "subtype") {
		578	defined $object_type or Carp::croak "subtype specified without type";
		579	my $object_subtype = shift @arg;
		580	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		581
		582	} elsif ($type eq "package") {
		583	my $pkg = shift @arg;
		584
		585	while (my ($name, $id) = each %cb_id) {
		586	if (my $cb = $pkg->can ($name)) {
		587	_attach_cb $registry, $id, $prio, $cb;
		588	}
		589	}
		590
		591	} elsif (exists $cb_id{$type}) {
		592	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		593
		594	} elsif (ref $type) {
		595	warn "attaching objects not supported, ignoring.\n";
		596
		597	} else {
		598	shift @arg;
		599	warn "attach argument '$type' not supported, ignoring.\n";
		600	}
		601	}
		602	}
		603
		604	sub _object_attach {
		605	my ($obj, $name, %arg) = @_;
		606
		607	return if exists $obj->{_attachment}{$name};
		608
		609	if (my $attach = $attachment{$name}) {
		610	my $registry = $obj->registry;
		611
		612	for (@$attach) {
		613	my ($klass, @attach) = @$_;
		614	_attach $registry, $klass, @attach;
		615	}
		616
		617	$obj->{$name} = \%arg;
		618	} else {
		619	warn "object uses attachment '$name' that is not available, postponing.\n";
		620	}
		621
		622	$obj->{_attachment}{$name} = undef;
		623	}
		624
		625	sub cf::attachable::attach {
		626	if (ref $_[0]) {
		627	_object_attach @_;
		628	} else {
		629	_attach shift->_attach_registry, @_;
		630	}
		631	};
		632
		633	# all those should be optimised
		634	sub cf::attachable::detach {
		635	my ($obj, $name) = @_;
		636
		637	if (ref $obj) {
		638	delete $obj->{_attachment}{$name};
		639	reattach ($obj);
		640	} else {
		641	Carp::croak "cannot, currently, detach class attachments";
		642	}
		643	};
		644
		645	sub cf::attachable::attached {
		646	my ($obj, $name) = @_;
		647
		648	exists $obj->{_attachment}{$name}
		649	}
		650
		651	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		652	eval "#line " . __LINE__ . " 'cf.pm'
		653	sub cf::\L$klass\E::_attach_registry {
		654	(\\\@CB_$klass, KLASS_$klass)
		655	}
		656
		657	sub cf::\L$klass\E::attachment {
		658	my \$name = shift;
		659
		660	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		661	}
		662	";
		663	die if $@;
		664	}
		665
		666	our $override;
		667	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		668
		669	sub override {
		670	$override = 1;
		671	@invoke_results = ();
		672	}
		673
		674	sub do_invoke {
		675	my $event = shift;
		676	my $callbacks = shift;
		677
		678	@invoke_results = ();
		679
		680	local $override;
		681
		682	for (@$callbacks) {
		683	eval { &{$_->[1]} };
		684
		685	if ($@) {
		686	warn "$@";
		687	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		688	override;
		689	}
		690
		691	return 1 if $override;
		692	}
		693
		694	0
		695	}
		696
		697	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		698
		699	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		700
		701	Generate an object-specific event with the given arguments.
		702
		703	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		704	removed in future versions), and there is no public API to access override
		705	results (if you must, access C<@cf::invoke_results> directly).
		706
436	=back	707	=back
437		708
438	=cut	709	=cut
439
440	*cf::object::valid =
441	*cf::player::valid =
442	*cf::map::valid = \&cf::_valid;
443		710
444	#############################################################################	711	#############################################################################
445	# object support	712	# object support
446		713
447	sub instantiate {
448	my ($obj, $data) = @_;
449
450	$data = from_json $data;
451
452	for (@$data) {
453	my ($name, $args) = @$_;
454
455	$obj->attach ($name, %{$args || {} });
456	}
457	}
458
459	# basically do the same as instantiate, without calling instantiate
460	sub reattach {	714	sub reattach {
		715	# basically do the same as instantiate, without calling instantiate
461	my ($obj) = @_;	716	my ($obj) = @_;
		717
462	my $registry = $obj->registry;	718	my $registry = $obj->registry;
463		719
464	@$registry = ();	720	@$registry = ();
465		721
466	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	722	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
467		723
468	for my $name (keys %{ $obj->{_attachment} || {} }) {	724	for my $name (keys %{ $obj->{_attachment} || {} }) {
469	if (my $attach = $attachment{$name}) {	725	if (my $attach = $attachment{$name}) {
470	for (@$attach) {	726	for (@$attach) {
471	my ($klass, @attach) = @$_;	727	my ($klass, @attach) = @$_;
472	_attach @$registry, $klass, @attach;	728	_attach $registry, $klass, @attach;
473	}	729	}
474	} else {	730	} else {
475	warn "object uses attachment '$name' that is not available, postponing.\n";	731	warn "object uses attachment '$name' that is not available, postponing.\n";
476	}	732	}
477	}	733	}
478	}	734	}
479		735
480	sub object_freezer_save {	736	cf::attachable->attach (
481	my ($filename, $rdata, $objs) = @_;
482
483	if (length $$rdata) {
484	warn sprintf "saving %s (%d,%d)\n",
485	$filename, length $$rdata, scalar @$objs;
486
487	if (open my $fh, ">:raw", "$filename~") {
488	chmod SAVE_MODE, $fh;
489	syswrite $fh, $$rdata;
490	close $fh;
491
492	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
493	chmod SAVE_MODE, $fh;
494	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
495	close $fh;
496	rename "$filename.pst~", "$filename.pst";
497	} else {
498	unlink "$filename.pst";
499	}
500
501	rename "$filename~", $filename;
502	} else {
503	warn "FATAL: $filename~: $!\n";
504	}
505	} else {
506	unlink $filename;
507	unlink "$filename.pst";
508	}
509	}
510
511	sub object_thawer_load {
512	my ($filename) = @_;
513
514	open my $fh, "<:raw:perlio", "$filename.pst"
515	or return;
516
517	eval { local $/; (Storable::thaw <$fh>)->{objs} }
518	}
519
520	attach_to_objects
521	prio => -1000000,	737	prio => -1000000,
		738	on_instantiate => sub {
		739	my ($obj, $data) = @_;
		740
		741	$data = from_json $data;
		742
		743	for (@$data) {
		744	my ($name, $args) = @$_;
		745
		746	$obj->attach ($name, %{$args || {} });
		747	}
		748	},
		749	on_reattach => \&reattach,
522	on_clone => sub {	750	on_clone => sub {
523	my ($src, $dst) = @_;	751	my ($src, $dst) = @_;
524		752
525	@{$dst->registry} = @{$src->registry};	753	@{$dst->registry} = @{$src->registry};
526		754
527	%$dst = %$src;	755	%$dst = %$src;
528		756
529	%{$dst->{_attachment}} = %{$src->{_attachment}}	757	%{$dst->{_attachment}} = %{$src->{_attachment}}
530	if exists $src->{_attachment};	758	if exists $src->{_attachment};
531	},	759	},
532	;	760	);
		761
		762	sub object_freezer_save {
		763	my ($filename, $rdata, $objs) = @_;
		764
		765	sync_job {
		766	if (length $$rdata) {
		767	warn sprintf "saving %s (%d,%d)\n",
		768	$filename, length $$rdata, scalar @$objs;
		769
		770	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		771	chmod SAVE_MODE, $fh;
		772	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		773	aio_fsync $fh;
		774	close $fh;
		775
		776	if (@$objs) {
		777	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		778	chmod SAVE_MODE, $fh;
		779	my $data = Storable::nfreeze { version => 1, objs => $objs };
		780	aio_write $fh, 0, (length $data), $data, 0;
		781	aio_fsync $fh;
		782	close $fh;
		783	aio_rename "$filename.pst~", "$filename.pst";
		784	}
		785	} else {
		786	aio_unlink "$filename.pst";
		787	}
		788
		789	aio_rename "$filename~", $filename;
		790	} else {
		791	warn "FATAL: $filename~: $!\n";
		792	}
		793	} else {
		794	aio_unlink $filename;
		795	aio_unlink "$filename.pst";
		796	}
		797	}
		798	}
		799
		800	sub object_freezer_as_string {
		801	my ($rdata, $objs) = @_;
		802
		803	use Data::Dumper;
		804
		805	$$rdata . Dumper $objs
		806	}
		807
		808	sub object_thawer_load {
		809	my ($filename) = @_;
		810
		811	my ($data, $av);
		812
		813	(aio_load $filename, $data) >= 0
		814	or return;
		815
		816	unless (aio_stat "$filename.pst") {
		817	(aio_load "$filename.pst", $av) >= 0
		818	or return;
		819	$av = eval { (Storable::thaw $av)->{objs} };
		820	}
		821
		822	return ($data, $av);
		823	}
533		824
534	#############################################################################	825	#############################################################################
535	# old plug-in events	826	# command handling &c
536		827
537	sub inject_event {	828	=item cf::register_command $name => \&callback($ob,$args);
538	my $extension = shift;
539	my $event_code = shift;
540		829
541	my $cb = $hook[$event_code]{$extension}	830	Register a callback for execution when the client sends the user command
542	or return;	831	$name.
543		832
544	&$cb	833	=cut
545	}
546
547	sub inject_global_event {
548	my $event = shift;
549
550	my $cb = $hook[$event]
551	or return;
552
553	List::Util::max map &$_, values %$cb
554	}
555
556	sub inject_command {
557	my ($name, $obj, $params) = @_;
558
559	for my $cmd (@{ $command{$name} }) {
560	$cmd->[1]->($obj, $params);
561	}
562
563	-1
564	}
565		834
566	sub register_command {	835	sub register_command {
567	my ($name, $time, $cb) = @_;	836	my ($name, $cb) = @_;
568		837
569	my $caller = caller;	838	my $caller = caller;
570	#warn "registering command '$name/$time' to '$caller'";	839	#warn "registering command '$name/$time' to '$caller'";
571		840
572	push @{ $command{$name} }, [$time, $cb, $caller];	841	push @{ $COMMAND{$name} }, [$caller, $cb];
573	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
574	}	842	}
		843
		844	=item cf::register_extcmd $name => \&callback($pl,$packet);
		845
		846	Register a callbackf ro execution when the client sends an extcmd packet.
		847
		848	If the callback returns something, it is sent back as if reply was being
		849	called.
		850
		851	=cut
575		852
576	sub register_extcmd {	853	sub register_extcmd {
577	my ($name, $cb) = @_;	854	my ($name, $cb) = @_;
578		855
579	my $caller = caller;	856	my $caller = caller;
580	#warn "registering extcmd '$name' to '$caller'";	857	#warn "registering extcmd '$name' to '$caller'";
581		858
582	$extcmd{$name} = [$cb, $caller];	859	$EXTCMD{$name} = [$cb, $caller];
583	}	860	}
		861
		862	cf::player->attach (
		863	on_command => sub {
		864	my ($pl, $name, $params) = @_;
		865
		866	my $cb = $COMMAND{$name}
		867	or return;
		868
		869	for my $cmd (@$cb) {
		870	$cmd->[1]->($pl->ob, $params);
		871	}
		872
		873	cf::override;
		874	},
		875	on_extcmd => sub {
		876	my ($pl, $buf) = @_;
		877
		878	my $msg = eval { from_json $buf };
		879
		880	if (ref $msg) {
		881	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		882	if (my %reply = $cb->[0]->($pl, $msg)) {
		883	$pl->ext_reply ($msg->{msgid}, %reply);
		884	}
		885	}
		886	} else {
		887	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		888	}
		889
		890	cf::override;
		891	},
		892	);
584		893
585	sub register {	894	sub register {
586	my ($base, $pkg) = @_;	895	my ($base, $pkg) = @_;
587		896
588	#TODO	897	#TODO
…		…
607	. "#line 1 \"$path\"\n{\n"	916	. "#line 1 \"$path\"\n{\n"
608	. (do { local $/; <$fh> })	917	. (do { local $/; <$fh> })
609	. "\n};\n1";	918	. "\n};\n1";
610		919
611	eval $source	920	eval $source
612	or die "$path: $@";	921	or die $@ ? "$path: $@\n"
		922	: "extension disabled.\n";
613		923
614	push @exts, $pkg;	924	push @exts, $pkg;
615	$ext_pkg{$base} = $pkg;	925	$ext_pkg{$base} = $pkg;
616		926
617	# no strict 'refs';	927	# no strict 'refs';
…		…
630	# for my $idx (0 .. $#PLUGIN_EVENT) {	940	# for my $idx (0 .. $#PLUGIN_EVENT) {
631	# delete $hook[$idx]{$pkg};	941	# delete $hook[$idx]{$pkg};
632	# }	942	# }
633		943
634	# remove commands	944	# remove commands
635	for my $name (keys %command) {	945	for my $name (keys %COMMAND) {
636	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	946	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
637		947
638	if (@cb) {	948	if (@cb) {
639	$command{$name} = \@cb;	949	$COMMAND{$name} = \@cb;
640	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
641	} else {	950	} else {
642	delete $command{$name};
643	delete $COMMAND{"$name\000"};	951	delete $COMMAND{$name};
644	}	952	}
645	}	953	}
646		954
647	# remove extcmds	955	# remove extcmds
648	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	956	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
649	delete $extcmd{$name};	957	delete $EXTCMD{$name};
650	}	958	}
651		959
652	if (my $cb = $pkg->can ("unload")) {	960	if (my $cb = $pkg->can ("unload")) {
653	eval {	961	eval {
654	$cb->($pkg);	962	$cb->($pkg);
…		…
658		966
659	Symbol::delete_package $pkg;	967	Symbol::delete_package $pkg;
660	}	968	}
661		969
662	sub load_extensions {	970	sub load_extensions {
663	my $LIBDIR = maps_directory "perl";
664
665	for my $ext (<$LIBDIR/*.ext>) {	971	for my $ext (<$LIBDIR/*.ext>) {
666	next unless -r $ext;	972	next unless -r $ext;
667	eval {	973	eval {
668	load_extension $ext;	974	load_extension $ext;
669	1	975	1
670	} or warn "$ext not loaded: $@";	976	} or warn "$ext not loaded: $@";
671	}	977	}
672	}	978	}
673		979
674	sub _perl_reload(&) {
675	my ($msg) = @_;
676
677	$msg->("reloading...");
678
679	eval {
680	# 1. cancel all watchers
681	$_->cancel for Event::all_watchers;
682
683	# 2. unload all extensions
684	for (@exts) {
685	$msg->("unloading <$_>");
686	unload_extension $_;
687	}
688
689	# 3. unload all modules loaded from $LIBDIR
690	while (my ($k, $v) = each %INC) {
691	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
692
693	$msg->("removing <$k>");
694	delete $INC{$k};
695
696	$k =~ s/\.pm$//;
697	$k =~ s/\//::/g;
698
699	if (my $cb = $k->can ("unload_module")) {
700	$cb->();
701	}
702
703	Symbol::delete_package $k;
704	}
705
706	# 4. get rid of safe::, as good as possible
707	Symbol::delete_package "safe::$_"
708	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
709
710	# 5. remove register_script_function callbacks
711	# TODO
712
713	# 6. unload cf.pm "a bit"
714	delete $INC{"cf.pm"};
715
716	# don't, removes xs symbols, too,
717	# and global variables created in xs
718	#Symbol::delete_package __PACKAGE__;
719
720	# 7. reload cf.pm
721	$msg->("reloading cf.pm");
722	require cf;
723	};
724	$msg->($@) if $@;
725
726	$msg->("reloaded");
727	};
728
729	sub perl_reload() {
730	_perl_reload {
731	warn $_[0];
732	print "$_[0]\n";
733	};
734	}
735
736	register_command "perl-reload", 0, sub {
737	my ($who, $arg) = @_;
738
739	if ($who->flag (FLAG_WIZ)) {
740	_perl_reload {
741	warn $_[0];
742	$who->message ($_[0]);
743	};
744	}
745	};
746
747	#############################################################################
748	# extcmd framework, basically convert ext <msg>
749	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
750
751	attach_to_players
752	on_extcmd => sub {
753	my ($pl, $buf) = @_;
754
755	my $msg = eval { from_json $buf };
756
757	if (ref $msg) {
758	if (my $cb = $extcmd{$msg->{msgtype}}) {
759	if (my %reply = $cb->[0]->($pl, $msg)) {
760	$pl->ext_reply ($msg->{msgid}, %reply);
761	}
762	}
763	} else {
764	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
765	}
766
767	cf::override;
768	},
769	;
770
771	#############################################################################	980	#############################################################################
772	# load/save/clean perl data associated with a map	981	# load/save/clean perl data associated with a map
773		982
774	*cf::mapsupport::on_clean = sub {	983	*cf::mapsupport::on_clean = sub {
775	my ($map) = @_;	984	my ($map) = @_;
…		…
778	defined $path or return;	987	defined $path or return;
779		988
780	unlink "$path.pst";	989	unlink "$path.pst";
781	};	990	};
782		991
783	attach_to_maps prio => -10000, package => cf::mapsupport::;	992	cf::map->attach (prio => -10000, package => cf::mapsupport::);
784		993
785	#############################################################################	994	#############################################################################
786	# load/save perl data associated with player->ob objects	995	# load/save perl data associated with player->ob objects
787		996
788	sub all_objects(@) {	997	sub all_objects(@) {
789	@_, map all_objects ($_->inv), @_	998	@_, map all_objects ($_->inv), @_
790	}	999	}
791		1000
792	# TODO: compatibility cruft, remove when no longer needed	1001	# TODO: compatibility cruft, remove when no longer needed
793	attach_to_players	1002	cf::player->attach (
794	on_load => sub {	1003	on_load => sub {
795	my ($pl, $path) = @_;	1004	my ($pl, $path) = @_;
796		1005
797	for my $o (all_objects $pl->ob) {	1006	for my $o (all_objects $pl->ob) {
798	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1007	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
800		1009
801	%$o = %{ Storable::thaw pack "H*", $value };	1010	%$o = %{ Storable::thaw pack "H*", $value };
802	}	1011	}
803	}	1012	}
804	},	1013	},
805	;	1014	);
806		1015
807	#############################################################################	1016	#############################################################################
808	# core extensions - in perl	1017
		1018	=head2 CORE EXTENSIONS
		1019
		1020	Functions and methods that extend core crossfire objects.
		1021
		1022	=head3 cf::player
		1023
		1024	=over 4
809		1025
810	=item cf::player::exists $login	1026	=item cf::player::exists $login
811		1027
812	Returns true when the given account exists.	1028	Returns true when the given account exists.
813		1029
…		…
816	sub cf::player::exists($) {	1032	sub cf::player::exists($) {
817	cf::player::find $_[0]	1033	cf::player::find $_[0]
818	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1034	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
819	}	1035	}
820		1036
		1037	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1038
		1039	Sends an ext reply to the player.
		1040
		1041	=cut
		1042
		1043	sub cf::player::ext_reply($$$%) {
		1044	my ($self, $id, %msg) = @_;
		1045
		1046	$msg{msgid} = $id;
		1047
		1048	$self->send ("ext " . to_json \%msg);
		1049	}
		1050
		1051	=back
		1052
		1053
		1054	=head3 cf::map
		1055
		1056	=over 4
		1057
		1058	=cut
		1059
		1060	package cf::map;
		1061
		1062	use Fcntl;
		1063	use Coro::AIO;
		1064
		1065	our $MAX_RESET = 7200;
		1066	our $DEFAULT_RESET = 3600;
		1067
		1068	sub generate_random_map {
		1069	my ($path, $rmp) = @_;
		1070
		1071	# mit "rum" bekleckern, nicht
		1072	cf::map::_create_random_map
		1073	$path,
		1074	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1075	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1076	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1077	$rmp->{exit_on_final_map},
		1078	$rmp->{xsize}, $rmp->{ysize},
		1079	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1080	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1081	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1082	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1083	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1084	(cf::region::find $rmp->{region})
		1085	}
		1086
		1087	# and all this just because we cannot iterate over
		1088	# all maps in C++...
		1089	sub change_all_map_light {
		1090	my ($change) = @_;
		1091
		1092	$_->change_map_light ($change) for values %cf::MAP;
		1093	}
		1094
		1095	sub try_load_header($) {
		1096	my ($path) = @_;
		1097
		1098	utf8::encode $path;
		1099	aio_open $path, O_RDONLY, 0
		1100	or return;
		1101
		1102	my $map = cf::map::new
		1103	or return;
		1104
		1105	$map->load_header ($path)
		1106	or return;
		1107
		1108	$map->{load_path} = $path;
		1109
		1110	$map
		1111	}
		1112
		1113	sub find_map {
		1114	my ($path, $origin) = @_;
		1115
		1116	#warn "find_map<$path,$origin>\n";#d#
		1117
		1118	$path = new cf::path $path, $origin && $origin->path;
		1119	my $key = $path->as_string;
		1120
		1121	$cf::MAP{$key} || do {
		1122	# do it the slow way
		1123	my $map = try_load_header $path->save_path;
		1124
		1125	if ($map) {
		1126	# safety
		1127	$map->{instantiate_time} = $cf::RUNTIME
		1128	if $map->{instantiate_time} > $cf::RUNTIME;
		1129	} else {
		1130	if (my $rmp = $path->random_map_params) {
		1131	$map = generate_random_map $key, $rmp;
		1132	} else {
		1133	$map = try_load_header $path->load_path;
		1134	}
		1135
		1136	$map or return;
		1137
		1138	$map->{load_original} = 1;
		1139	$map->{instantiate_time} = $cf::RUNTIME;
		1140	$map->instantiate;
		1141
		1142	# per-player maps become, after loading, normal maps
		1143	$map->per_player (0) if $path->{user_rel};
		1144	}
		1145
		1146	$map->path ($key);
		1147	$map->{path} = $path;
		1148	$map->last_access ($cf::RUNTIME);
		1149
		1150	if ($map->should_reset) {
		1151	$map->reset;
		1152	$map = find_map $path;
		1153	}
		1154
		1155	$cf::MAP{$key} = $map
		1156	}
		1157	}
		1158
		1159	sub load {
		1160	my ($self) = @_;
		1161
		1162	return if $self->in_memory != cf::MAP_SWAPPED;
		1163
		1164	$self->in_memory (cf::MAP_LOADING);
		1165
		1166	my $path = $self->{path};
		1167
		1168	$self->alloc;
		1169	$self->load_objects ($self->{load_path}, 1)
		1170	or return;
		1171
		1172	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1173	if delete $self->{load_original};
		1174
		1175	if (my $uniq = $path->uniq_path) {
		1176	utf8::encode $uniq;
		1177	if (aio_open $uniq, O_RDONLY, 0) {
		1178	$self->clear_unique_items;
		1179	$self->load_objects ($uniq, 0);
		1180	}
		1181	}
		1182
		1183	# now do the right thing for maps
		1184	$self->link_multipart_objects;
		1185
		1186	if ($self->{path}->is_style_map) {
		1187	$self->{deny_save} = 1;
		1188	$self->{deny_reset} = 1;
		1189	} else {
		1190	$self->fix_auto_apply;
		1191	$self->decay_objects;
		1192	$self->update_buttons;
		1193	$self->set_darkness_map;
		1194	$self->difficulty ($self->estimate_difficulty)
		1195	unless $self->difficulty;
		1196	$self->activate;
		1197	}
		1198
		1199	$self->in_memory (cf::MAP_IN_MEMORY);
		1200	}
		1201
		1202	sub load_map_sync {
		1203	my ($path, $origin) = @_;
		1204
		1205	#warn "load_map_sync<$path, $origin>\n";#d#
		1206
		1207	cf::sync_job {
		1208	my $map = cf::map::find_map $path, $origin
		1209	or return;
		1210	$map->load;
		1211	$map
		1212	}
		1213	}
		1214
		1215	sub save {
		1216	my ($self) = @_;
		1217
		1218	my $save = $self->{path}->save_path; utf8::encode $save;
		1219	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1220
		1221	$self->{last_save} = $cf::RUNTIME;
		1222
		1223	return unless $self->dirty;
		1224
		1225	$self->{load_path} = $save;
		1226
		1227	return if $self->{deny_save};
		1228
		1229	if ($uniq) {
		1230	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1231	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1232	} else {
		1233	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1234	}
		1235	}
		1236
		1237	sub swap_out {
		1238	my ($self) = @_;
		1239
		1240	return if $self->players;
		1241	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1242	return if $self->{deny_save};
		1243
		1244	$self->save;
		1245	$self->clear;
		1246	$self->in_memory (cf::MAP_SWAPPED);
		1247	}
		1248
		1249	sub reset_at {
		1250	my ($self) = @_;
		1251
		1252	# TODO: safety, remove and allow resettable per-player maps
		1253	return 1e99 if $self->{path}{user_rel};
		1254	return 1e99 if $self->{deny_reset};
		1255
		1256	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1257	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1258
		1259	$time + $to
		1260	}
		1261
		1262	sub should_reset {
		1263	my ($self) = @_;
		1264
		1265	$self->reset_at <= $cf::RUNTIME
		1266	}
		1267
		1268	sub unlink_save {
		1269	my ($self) = @_;
		1270
		1271	utf8::encode (my $save = $self->{path}->save_path);
		1272	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1273	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1274	}
		1275
		1276	sub rename {
		1277	my ($self, $new_path) = @_;
		1278
		1279	$self->unlink_save;
		1280
		1281	delete $cf::MAP{$self->path};
		1282	$self->{path} = new cf::path $new_path;
		1283	$self->path ($self->{path}->as_string);
		1284	$cf::MAP{$self->path} = $self;
		1285
		1286	$self->save;
		1287	}
		1288
		1289	sub reset {
		1290	my ($self) = @_;
		1291
		1292	return if $self->players;
		1293	return if $self->{path}{user_rel};#d#
		1294
		1295	warn "resetting map ", $self->path;#d#
		1296
		1297	delete $cf::MAP{$self->path};
		1298
		1299	$_->clear_links_to ($self) for values %cf::MAP;
		1300
		1301	$self->unlink_save;
		1302	$self->destroy;
		1303	}
		1304
		1305	my $nuke_counter = "aaaa";
		1306
		1307	sub nuke {
		1308	my ($self) = @_;
		1309
		1310	$self->{deny_save} = 1;
		1311	$self->reset_timeout (1);
		1312	$self->rename ("{nuke}/" . ($nuke_counter++));
		1313	$self->reset; # polite request, might not happen
		1314	}
		1315
		1316	sub customise_for {
		1317	my ($map, $ob) = @_;
		1318
		1319	if ($map->per_player) {
		1320	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1321	}
		1322
		1323	$map
		1324	}
		1325
		1326	sub emergency_save {
		1327	local $cf::FREEZE = 1;
		1328
		1329	warn "enter emergency map save\n";
		1330
		1331	cf::sync_job {
		1332	warn "begin emergency map save\n";
		1333	$_->save for values %cf::MAP;
		1334	};
		1335
		1336	warn "end emergency map save\n";
		1337	}
		1338
		1339	package cf;
		1340
		1341	=back
		1342
		1343
		1344	=head3 cf::object::player
		1345
		1346	=over 4
		1347
821	=item $player->reply ($npc, $msg[, $flags])	1348	=item $player_object->reply ($npc, $msg[, $flags])
822		1349
823	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1350	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
824	can be C<undef>. Does the right thing when the player is currently in a	1351	can be C<undef>. Does the right thing when the player is currently in a
825	dialogue with the given NPC character.	1352	dialogue with the given NPC character.
826		1353
827	=cut	1354	=cut
828		1355
829	# rough implementation of a future "reply" method that works	1356	# rough implementation of a future "reply" method that works
830	# with dialog boxes.	1357	# with dialog boxes.
		1358	#TODO: the first argument must go, split into a $npc->reply_to ( method
831	sub cf::object::player::reply($$$;$) {	1359	sub cf::object::player::reply($$$;$) {
832	my ($self, $npc, $msg, $flags) = @_;	1360	my ($self, $npc, $msg, $flags) = @_;
833		1361
834	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1362	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
835		1363
…		…
839	$msg = $npc->name . " says: $msg" if $npc;	1367	$msg = $npc->name . " says: $msg" if $npc;
840	$self->message ($msg, $flags);	1368	$self->message ($msg, $flags);
841	}	1369	}
842	}	1370	}
843		1371
844	=item $player->ext_reply ($msgid, $msgtype, %msg)	1372	=item $player_object->may ("access")
845		1373
846	Sends an ext reply to the player.	1374	Returns wether the given player is authorized to access resource "access"
		1375	(e.g. "command_wizcast").
847		1376
848	=cut	1377	=cut
849		1378
850	sub cf::player::ext_reply($$$%) {	1379	sub cf::object::player::may {
		1380	my ($self, $access) = @_;
		1381
		1382	$self->flag (cf::FLAG_WIZ) ||
		1383	(ref $cf::CFG{"may_$access"}
		1384	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1385	: $cf::CFG{"may_$access"})
		1386	}
		1387
		1388	=item $player_object->enter_link
		1389
		1390	Freezes the player and moves him/her to a special map (C<{link}>).
		1391
		1392	The player should be reaosnably safe there for short amounts of time. You
		1393	I<MUST> call C<leave_link> as soon as possible, though.
		1394
		1395	=item $player_object->leave_link ($map, $x, $y)
		1396
		1397	Moves the player out of the specila link map onto the given map. If the
		1398	map is not valid (or omitted), the player will be moved back to the
		1399	location he/she was before the call to C<enter_link>, or, if that fails,
		1400	to the emergency map position.
		1401
		1402	Might block.
		1403
		1404	=cut
		1405
		1406	sub cf::object::player::enter_link {
		1407	my ($self) = @_;
		1408
		1409	return if $self->map == $LINK_MAP;
		1410
		1411	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
		1412	if $self->map;
		1413
		1414	$self->enter_map ($LINK_MAP, 20, 20);
		1415	$self->deactivate_recursive;
		1416	}
		1417
		1418	sub cf::object::player::leave_link {
		1419	my ($self, $map, $x, $y) = @_;
		1420
		1421	my $link_pos = delete $self->{_link_pos};
		1422
		1423	unless ($map) {
		1424	# restore original map position
		1425	($map, $x, $y) = @{ $link_pos || [] };
		1426	$map = cf::map::find_map $map;
		1427
		1428	unless ($map) {
		1429	($map, $x, $y) = @$EMERGENCY_POSITION;
		1430	$map = cf::map::find_map $map
		1431	or die "FATAL: cannot load emergency map\n";
		1432	}
		1433	}
		1434
		1435	($x, $y) = (-1, -1)
		1436	unless (defined $x) && (defined $y);
		1437
		1438	# use -1 or undef as default coordinates, not 0, 0
		1439	($x, $y) = ($map->enter_x, $map->enter_y)
		1440	if $x <=0 && $y <= 0;
		1441
		1442	$map->load;
		1443
		1444	$self->activate_recursive;
		1445	$self->enter_map ($map, $x, $y);
		1446	}
		1447
		1448	=item $player_object->goto_map ($map, $x, $y)
		1449
		1450	=cut
		1451
		1452	sub cf::object::player::goto_map {
		1453	my ($self, $path, $x, $y) = @_;
		1454
		1455	$self->enter_link;
		1456
		1457	(Coro::async {
		1458	$path = new cf::path $path;
		1459
		1460	my $map = cf::map::find_map $path->as_string;
		1461	$map = $map->customise_for ($self) if $map;
		1462
		1463	warn "entering ", $map->path, " at ($x, $y)\n"
		1464	if $map;
		1465
		1466	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1467
		1468	$self->leave_link ($map, $x, $y);
		1469	})->prio (1);
		1470	}
		1471
		1472	=item $player_object->enter_exit ($exit_object)
		1473
		1474	=cut
		1475
		1476	sub parse_random_map_params {
		1477	my ($spec) = @_;
		1478
		1479	my $rmp = { # defaults
		1480	xsize => 10,
		1481	ysize => 10,
		1482	};
		1483
		1484	for (split /\n/, $spec) {
		1485	my ($k, $v) = split /\s+/, $_, 2;
		1486
		1487	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1488	}
		1489
		1490	$rmp
		1491	}
		1492
		1493	sub prepare_random_map {
		1494	my ($exit) = @_;
		1495
		1496	# all this does is basically replace the /! path by
		1497	# a new random map path (?random/...) with a seed
		1498	# that depends on the exit object
		1499
		1500	my $rmp = parse_random_map_params $exit->msg;
		1501
		1502	if ($exit->map) {
		1503	$rmp->{region} = $exit->map->region_name;
		1504	$rmp->{origin_map} = $exit->map->path;
		1505	$rmp->{origin_x} = $exit->x;
		1506	$rmp->{origin_y} = $exit->y;
		1507	}
		1508
		1509	$rmp->{random_seed} ||= $exit->random_seed;
		1510
		1511	my $data = cf::to_json $rmp;
		1512	my $md5 = Digest::MD5::md5_hex $data;
		1513
		1514	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1515	aio_write $fh, 0, (length $data), $data, 0;
		1516
		1517	$exit->slaying ("?random/$md5");
		1518	$exit->msg (undef);
		1519	}
		1520	}
		1521
		1522	sub cf::object::player::enter_exit {
851	my ($self, $id, %msg) = @_;	1523	my ($self, $exit) = @_;
852		1524
853	$msg{msgid} = $id;	1525	return unless $self->type == cf::PLAYER;
854		1526
855	$self->send ("ext " . to_json \%msg);	1527	$self->enter_link;
856	}
857		1528
858	#############################################################################	1529	(Coro::async {
859	# map scripting support	1530	unless (eval {
		1531
		1532	prepare_random_map $exit
		1533	if $exit->slaying eq "/!";
		1534
		1535	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1536	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1537
		1538	1;
		1539	}) {
		1540	$self->message ("Something went wrong deep within the crossfire server. "
		1541	. "I'll try to bring you back to the map you were before. "
		1542	. "Please report this to the dungeon master",
		1543	cf::NDI_UNIQUE | cf::NDI_RED);
		1544
		1545	warn "ERROR in enter_exit: $@";
		1546	$self->leave_link;
		1547	}
		1548	})->prio (1);
		1549	}
		1550
		1551	=head3 cf::client
		1552
		1553	=over 4
		1554
		1555	=item $client->send_drawinfo ($text, $flags)
		1556
		1557	Sends a drawinfo packet to the client. Circumvents output buffering so
		1558	should not be used under normal circumstances.
		1559
		1560	=cut
		1561
		1562	sub cf::client::send_drawinfo {
		1563	my ($self, $text, $flags) = @_;
		1564
		1565	utf8::encode $text;
		1566	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1567	}
		1568
		1569
		1570	=item $success = $client->query ($flags, "text", \&cb)
		1571
		1572	Queues a query to the client, calling the given callback with
		1573	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1574	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1575
		1576	Queries can fail, so check the return code. Or don't, as queries will become
		1577	reliable at some point in the future.
		1578
		1579	=cut
		1580
		1581	sub cf::client::query {
		1582	my ($self, $flags, $text, $cb) = @_;
		1583
		1584	return unless $self->state == ST_PLAYING
		1585	|| $self->state == ST_SETUP
		1586	|| $self->state == ST_CUSTOM;
		1587
		1588	$self->state (ST_CUSTOM);
		1589
		1590	utf8::encode $text;
		1591	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1592
		1593	$self->send_packet ($self->{query_queue}[0][0])
		1594	if @{ $self->{query_queue} } == 1;
		1595	}
		1596
		1597	cf::client->attach (
		1598	on_reply => sub {
		1599	my ($ns, $msg) = @_;
		1600
		1601	# this weird shuffling is so that direct followup queries
		1602	# get handled first
		1603	my $queue = delete $ns->{query_queue};
		1604
		1605	(shift @$queue)->[1]->($msg);
		1606
		1607	push @{ $ns->{query_queue} }, @$queue;
		1608
		1609	if (@{ $ns->{query_queue} } == @$queue) {
		1610	if (@$queue) {
		1611	$ns->send_packet ($ns->{query_queue}[0][0]);
		1612	} else {
		1613	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1614	}
		1615	}
		1616	},
		1617	);
		1618
		1619	=item $client->coro (\&cb)
		1620
		1621	Create a new coroutine, running the specified callback. The coroutine will
		1622	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1623	or loss of connection).
		1624
		1625	=cut
		1626
		1627	sub cf::client::coro {
		1628	my ($self, $cb) = @_;
		1629
		1630	my $coro; $coro = async {
		1631	eval {
		1632	$cb->();
		1633	};
		1634	warn $@ if $@;
		1635	};
		1636
		1637	$coro->on_destroy (sub {
		1638	delete $self->{_coro}{$coro+0};
		1639	});
		1640
		1641	$self->{_coro}{$coro+0} = $coro;
		1642
		1643	$coro
		1644	}
		1645
		1646	cf::client->attach (
		1647	on_destroy => sub {
		1648	my ($ns) = @_;
		1649
		1650	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1651	},
		1652	);
		1653
		1654	=back
		1655
		1656
		1657	=head2 SAFE SCRIPTING
		1658
		1659	Functions that provide a safe environment to compile and execute
		1660	snippets of perl code without them endangering the safety of the server
		1661	itself. Looping constructs, I/O operators and other built-in functionality
		1662	is not available in the safe scripting environment, and the number of
		1663	functions and methods that can be called is greatly reduced.
		1664
		1665	=cut
860		1666
861	our $safe = new Safe "safe";	1667	our $safe = new Safe "safe";
862	our $safe_hole = new Safe::Hole;	1668	our $safe_hole = new Safe::Hole;
863		1669
864	$SIG{FPE} = 'IGNORE';	1670	$SIG{FPE} = 'IGNORE';
865		1671
866	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1672	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
867		1673
868	# here we export the classes and methods available to script code	1674	# here we export the classes and methods available to script code
869		1675
		1676	=pod
		1677
		1678	The following fucntions and emthods are available within a safe environment:
		1679
		1680	cf::object contr pay_amount pay_player map
		1681	cf::object::player player
		1682	cf::player peaceful
		1683	cf::map trigger
		1684
		1685	=cut
		1686
870	for (	1687	for (
871	["cf::object" => qw(contr pay_amount pay_player)],	1688	["cf::object" => qw(contr pay_amount pay_player map)],
872	["cf::object::player" => qw(player)],	1689	["cf::object::player" => qw(player)],
873	["cf::player" => qw(peaceful)],	1690	["cf::player" => qw(peaceful)],
		1691	["cf::map" => qw(trigger)],
874	) {	1692	) {
875	no strict 'refs';	1693	no strict 'refs';
876	my ($pkg, @funs) = @$_;	1694	my ($pkg, @funs) = @$_;
877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1695	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878	for @funs;	1696	for @funs;
879	}	1697	}
		1698
		1699	=over 4
		1700
		1701	=item @retval = safe_eval $code, [var => value, ...]
		1702
		1703	Compiled and executes the given perl code snippet. additional var/value
		1704	pairs result in temporary local (my) scalar variables of the given name
		1705	that are available in the code snippet. Example:
		1706
		1707	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1708
		1709	=cut
880		1710
881	sub safe_eval($;@) {	1711	sub safe_eval($;@) {
882	my ($code, %vars) = @_;	1712	my ($code, %vars) = @_;
883		1713
884	my $qcode = $code;	1714	my $qcode = $code;
…		…
907	}	1737	}
908		1738
909	wantarray ? @res : $res[0]	1739	wantarray ? @res : $res[0]
910	}	1740	}
911		1741
		1742	=item cf::register_script_function $function => $cb
		1743
		1744	Register a function that can be called from within map/npc scripts. The
		1745	function should be reasonably secure and should be put into a package name
		1746	like the extension.
		1747
		1748	Example: register a function that gets called whenever a map script calls
		1749	C<rent::overview>, as used by the C<rent> extension.
		1750
		1751	cf::register_script_function "rent::overview" => sub {
		1752	...
		1753	};
		1754
		1755	=cut
		1756
912	sub register_script_function {	1757	sub register_script_function {
913	my ($fun, $cb) = @_;	1758	my ($fun, $cb) = @_;
914		1759
915	no strict 'refs';	1760	no strict 'refs';
916	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1761	*{"safe::$fun"} = $safe_hole->wrap ($cb);
917	}	1762	}
918		1763
		1764	=back
		1765
		1766	=cut
		1767
		1768	#############################################################################
		1769
		1770	=head2 EXTENSION DATABASE SUPPORT
		1771
		1772	Crossfire maintains a very simple database for extension use. It can
		1773	currently store anything that can be serialised using Storable, which
		1774	excludes objects.
		1775
		1776	The parameter C<$family> should best start with the name of the extension
		1777	using it, it should be unique.
		1778
		1779	=over 4
		1780
		1781	=item $hashref = cf::db_get $family
		1782
		1783	Return a hashref for use by the extension C<$family>, which can be
		1784	modified. After modifications, you have to call C<cf::db_dirty> or
		1785	C<cf::db_sync>.
		1786
		1787	=item $value = cf::db_get $family => $key
		1788
		1789	Returns a single value from the database
		1790
		1791	=item cf::db_put $family => $hashref
		1792
		1793	Stores the given family hashref into the database. Updates are delayed, if
		1794	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1795
		1796	=item cf::db_put $family => $key => $value
		1797
		1798	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1799	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1800
		1801	=item cf::db_dirty
		1802
		1803	Marks the database as dirty, to be updated at a later time.
		1804
		1805	=item cf::db_sync
		1806
		1807	Immediately write the database to disk I<if it is dirty>.
		1808
		1809	=cut
		1810
		1811	our $DB;
		1812
		1813	{
		1814	my $path = cf::localdir . "/database.pst";
		1815
		1816	sub db_load() {
		1817	warn "loading database $path\n";#d# remove later
		1818	$DB = stat $path ? Storable::retrieve $path : { };
		1819	}
		1820
		1821	my $pid;
		1822
		1823	sub db_save() {
		1824	warn "saving database $path\n";#d# remove later
		1825	waitpid $pid, 0 if $pid;
		1826	if (0 == ($pid = fork)) {
		1827	$DB->{_meta}{version} = 1;
		1828	Storable::nstore $DB, "$path~";
		1829	rename "$path~", $path;
		1830	cf::_exit 0 if defined $pid;
		1831	}
		1832	}
		1833
		1834	my $dirty;
		1835
		1836	sub db_sync() {
		1837	db_save if $dirty;
		1838	undef $dirty;
		1839	}
		1840
		1841	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1842	db_sync;
		1843	});
		1844
		1845	sub db_dirty() {
		1846	$dirty = 1;
		1847	$idle->start;
		1848	}
		1849
		1850	sub db_get($;$) {
		1851	@_ >= 2
		1852	? $DB->{$_[0]}{$_[1]}
		1853	: ($DB->{$_[0]} ||= { })
		1854	}
		1855
		1856	sub db_put($$;$) {
		1857	if (@_ >= 3) {
		1858	$DB->{$_[0]}{$_[1]} = $_[2];
		1859	} else {
		1860	$DB->{$_[0]} = $_[1];
		1861	}
		1862	db_dirty;
		1863	}
		1864
		1865	cf::global->attach (
		1866	prio => 10000,
		1867	on_cleanup => sub {
		1868	db_sync;
		1869	},
		1870	);
		1871	}
		1872
919	#############################################################################	1873	#############################################################################
920	# the server's main()	1874	# the server's main()
921		1875
		1876	sub cfg_load {
		1877	open my $fh, "<:utf8", cf::confdir . "/config"
		1878	or return;
		1879
		1880	local $/;
		1881	*CFG = YAML::Syck::Load <$fh>;
		1882	}
		1883
922	sub main {	1884	sub main {
		1885	# we must not ever block the main coroutine
		1886	local $Coro::idle = sub {
		1887	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		1888	(Coro::unblock_sub {
		1889	Event::one_event;
		1890	})->();
		1891	};
		1892
		1893	cfg_load;
		1894	db_load;
		1895	load_extensions;
923	Event::loop;	1896	Event::loop;
924	}	1897	}
925		1898
926	#############################################################################	1899	#############################################################################
927	# initialisation	1900	# initialisation
928		1901
		1902	sub reload() {
		1903	# can/must only be called in main
		1904	if ($Coro::current != $Coro::main) {
		1905	warn "can only reload from main coroutine\n";
		1906	return;
		1907	}
		1908
		1909	warn "reloading...";
		1910
		1911	local $FREEZE = 1;
		1912	cf::emergency_save;
		1913
		1914	eval {
		1915	# if anything goes wrong in here, we should simply crash as we already saved
		1916
		1917	# cancel all watchers
		1918	for (Event::all_watchers) {
		1919	$_->cancel if $_->data & WF_AUTOCANCEL;
		1920	}
		1921
		1922	# cancel all extension coros
		1923	$_->cancel for values %EXT_CORO;
		1924	%EXT_CORO = ();
		1925
		1926	# unload all extensions
		1927	for (@exts) {
		1928	warn "unloading <$_>";
		1929	unload_extension $_;
		1930	}
		1931
		1932	# unload all modules loaded from $LIBDIR
		1933	while (my ($k, $v) = each %INC) {
		1934	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1935
		1936	warn "removing <$k>";
		1937	delete $INC{$k};
		1938
		1939	$k =~ s/\.pm$//;
		1940	$k =~ s/\//::/g;
		1941
		1942	if (my $cb = $k->can ("unload_module")) {
		1943	$cb->();
		1944	}
		1945
		1946	Symbol::delete_package $k;
		1947	}
		1948
		1949	# sync database to disk
		1950	cf::db_sync;
		1951	IO::AIO::flush;
		1952
		1953	# get rid of safe::, as good as possible
		1954	Symbol::delete_package "safe::$_"
		1955	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		1956
		1957	# remove register_script_function callbacks
		1958	# TODO
		1959
		1960	# unload cf.pm "a bit"
		1961	delete $INC{"cf.pm"};
		1962
		1963	# don't, removes xs symbols, too,
		1964	# and global variables created in xs
		1965	#Symbol::delete_package __PACKAGE__;
		1966
		1967	# reload cf.pm
		1968	warn "reloading cf.pm";
		1969	require cf;
		1970	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1971
		1972	# load config and database again
		1973	cf::cfg_load;
		1974	cf::db_load;
		1975
		1976	# load extensions
		1977	warn "load extensions";
		1978	cf::load_extensions;
		1979
		1980	# reattach attachments to objects
		1981	warn "reattach";
		1982	_global_reattach;
		1983	};
		1984
		1985	if ($@) {
		1986	warn $@;
		1987	warn "error while reloading, exiting.";
		1988	exit 1;
		1989	}
		1990
		1991	warn "reloaded successfully";
		1992	};
		1993
		1994	#############################################################################
		1995
		1996	unless ($LINK_MAP) {
		1997	$LINK_MAP = cf::map::new;
		1998
		1999	$LINK_MAP->width (41);
		2000	$LINK_MAP->height (41);
		2001	$LINK_MAP->alloc;
		2002	$LINK_MAP->path ("{link}");
		2003	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2004	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2005
		2006	# dirty hack because... archetypes are not yet loaded
		2007	Event->timer (
		2008	after => 2,
		2009	cb => sub {
		2010	$_[0]->w->cancel;
		2011
		2012	# provide some exits "home"
		2013	my $exit = cf::object::new "exit";
		2014
		2015	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2016	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2017	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2018
		2019	$LINK_MAP->insert ($exit->clone, 19, 19);
		2020	$LINK_MAP->insert ($exit->clone, 19, 20);
		2021	$LINK_MAP->insert ($exit->clone, 19, 21);
		2022	$LINK_MAP->insert ($exit->clone, 20, 19);
		2023	$LINK_MAP->insert ($exit->clone, 20, 21);
		2024	$LINK_MAP->insert ($exit->clone, 21, 19);
		2025	$LINK_MAP->insert ($exit->clone, 21, 20);
		2026	$LINK_MAP->insert ($exit->clone, 21, 21);
		2027
		2028	$exit->destroy;
		2029	});
		2030
		2031	$LINK_MAP->{deny_save} = 1;
		2032	$LINK_MAP->{deny_reset} = 1;
		2033
		2034	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2035	}
		2036
929	register "<global>", __PACKAGE__;	2037	register "<global>", __PACKAGE__;
930		2038
		2039	register_command "reload" => sub {
		2040	my ($who, $arg) = @_;
		2041
		2042	if ($who->flag (FLAG_WIZ)) {
		2043	$who->message ("start of reload.");
		2044	reload;
		2045	$who->message ("end of reload.");
		2046	}
		2047	};
		2048
931	unshift @INC, $LIBDIR;	2049	unshift @INC, $LIBDIR;
932		2050
933	load_extensions;
934
935	$TICK_WATCHER = Event->timer (	2051	$TICK_WATCHER = Event->timer (
		2052	reentrant => 0,
936	prio => 1,	2053	prio => 0,
937	at => $NEXT_TICK || 1,	2054	at => $NEXT_TICK || $TICK,
		2055	data => WF_AUTOCANCEL,
938	cb => sub {	2056	cb => sub {
		2057	unless ($FREEZE) {
939	cf::server_tick; # one server iteration	2058	cf::server_tick; # one server iteration
		2059	$RUNTIME += $TICK;
		2060	}
940		2061
941	my $NOW = Event::time;
942	$NEXT_TICK += $TICK;	2062	$NEXT_TICK += $TICK;
943		2063
944	# if we are delayed by four ticks, skip them all	2064	# if we are delayed by four ticks or more, skip them all
945	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2065	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
946		2066
947	$TICK_WATCHER->at ($NEXT_TICK);	2067	$TICK_WATCHER->at ($NEXT_TICK);
948	$TICK_WATCHER->start;	2068	$TICK_WATCHER->start;
949	},	2069	},
950	);	2070	);
951		2071
952	_reload_2;	2072	IO::AIO::max_poll_time $TICK * 0.2;
		2073
		2074	Event->io (
		2075	fd => IO::AIO::poll_fileno,
		2076	poll => 'r',
		2077	prio => 5,
		2078	data => WF_AUTOCANCEL,
		2079	cb => \&IO::AIO::poll_cb,
		2080	);
		2081
		2082	Event->timer (
		2083	data => WF_AUTOCANCEL,
		2084	after => 0,
		2085	interval => 10,
		2086	cb => sub {
		2087	(Coro::unblock_sub {
		2088	write_runtime
		2089	or warn "ERROR: unable to write runtime file: $!";
		2090	})->();
		2091	},
		2092	);
953		2093
954	1	2094	1
955		2095

Diff Legend

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