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.54 by root, Tue Aug 29 14:49:28 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 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;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18
		19	use IO::AIO 2.3;
		20	use YAML::Syck ();
10	use Time::HiRes;	21	use Time::HiRes;
11	use Event;	22
12	$Event::Eval = 1; # no idea why this is required, but it is	23	use Event; $Event::Eval = 1; # no idea why this is required, but it is
13		24
14	use strict;	25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		26	$YAML::Syck::ImplicitUnicode = 1;
15		27
16	_reload_1;	28	$Coro::main->prio (Coro::PRIO_MIN);
17		29
		30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		31
18	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
19	our @EVENT;	36	our @EVENT;
20	our %PROP_TYPE;	37	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		38
24	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	40	our $TICK_WATCHER;
26	our $NEXT_TICK;	41	our $NEXT_TICK;
		42
		43	our %CFG;
		44
		45	our $UPTIME; $UPTIME ||= time;
		46
		47	#############################################################################
		48
		49	=head2 GLOBAL VARIABLES
		50
		51	=over 4
		52
		53	=item $cf::UPTIME
		54
		55	The timestamp of the server start (so not actually an uptime).
		56
		57	=item $cf::LIBDIR
		58
		59	The perl library directory, where extensions and cf-specific modules can
		60	be found. It will be added to C<@INC> automatically.
		61
		62	=item $cf::TICK
		63
		64	The interval between server ticks, in seconds.
		65
		66	=item %cf::CFG
		67
		68	Configuration for the server, loaded from C</etc/crossfire/config>, or
		69	from wherever your confdir points to.
		70
		71	=back
		72
		73	=cut
27		74
28	BEGIN {	75	BEGIN {
29	*CORE::GLOBAL::warn = sub {	76	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	77	my $msg = join "", @_;
31	$msg .= "\n"	78	$msg .= "\n"
…		…
34	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
36	};	83	};
37	}	84	}
38		85
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	86	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40		87	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41	# generate property mutators	88	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42	sub prop_gen {	89	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43	my ($prefix, $class) = @_;	90	@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';	91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		92
75	# we bless all objects into (empty) derived classes to force a method lookup	93	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	94	# 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)) {	95	for my $pkg (qw(
		96	cf::global cf::attachable
		97	cf::object cf::object::player
		98	cf::client cf::player
		99	cf::arch cf::living
		100	cf::map cf::party cf::region
		101	)) {
78	no strict 'refs';	102	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	104	}
81		105
82	$Event::DIED = sub {	106	$Event::DIED = sub {
…		…
84	};	108	};
85		109
86	my %ext_pkg;	110	my %ext_pkg;
87	my @exts;	111	my @exts;
88	my @hook;	112	my @hook;
89	my %command;
90	my %extcmd;
91		113
92	#############################################################################	114	=head2 UTILITY FUNCTIONS
93	# utility functions	115
		116	=over 4
		117
		118	=cut
94		119
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	120	use JSON::Syck (); # TODO# replace by JSON::PC once working
		121
		122	=item $ref = cf::from_json $json
		123
		124	Converts a JSON string into the corresponding perl data structure.
		125
		126	=cut
96		127
97	sub from_json($) {	128	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	129	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	130	JSON::Syck::Load $_[0]
100	}	131	}
101		132
		133	=item $json = cf::to_json $ref
		134
		135	Converts a perl data structure into its JSON representation.
		136
		137	=cut
		138
102	sub to_json($) {	139	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	140	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	141	JSON::Syck::Dump $_[0]
105	}	142	}
106		143
		144	=back
		145
		146	=cut
		147
107	#############################################################################	148	#############################################################################
108	# "new" plug-in system
109		149
110	=item $object->attach ($attachment, key => $value...)	150	=head2 ATTACHABLE OBJECTS
111		151
112	=item $object->detach ($attachment)	152	Many objects in crossfire are so-called attachable objects. That means you can
		153	attach callbacks/event handlers (a collection of which is called an "attachment")
		154	to it. All such attachable objects support the following methods.
113		155
114	Attach/detach a pre-registered attachment to an object.	156	In the following description, CLASS can be any of C<global>, C<object>
		157	C<player>, C<client> or C<map> (i.e. the attachable objects in
		158	crossfire+).
115		159
116	=item $player->attach ($attachment, key => $value...)	160	=over 4
117		161
118	=item $player->detach ($attachment)
119
120	Attach/detach a pre-registered attachment to a player.
121
122	=item $map->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
123		163
124	=item $map->detach ($attachment)	164	=item $attachable->detach ($attachment)
125		165
126	Attach/detach a pre-registered attachment to a map.	166	Attach/detach a pre-registered attachment to a specific object and give it
		167	the specified key/value pairs as arguments.
127		168
128	=item cf::attach_global ...	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
129		171
130	Attach handlers for global events.	172	$obj->attach (minesweeper => width => 10, height => 10);
131		173
132	This and all following C<attach_*>-functions expect any number of the	174	=item $bool = $attachable->attached ($name)
133	following handler/hook descriptions:	175
		176	Checks wether the named attachment is currently attached to the object.
		177
		178	=item cf::CLASS->attach ...
		179
		180	=item cf::CLASS->detach ...
		181
		182	Define an anonymous attachment and attach it to all objects of the given
		183	CLASS. See the next function for an explanation of its arguments.
		184
		185	You can attach to global events by using the C<cf::global> class.
		186
		187	Example, log all player logins:
		188
		189	cf::player->attach (
		190	on_login => sub {
		191	my ($pl) = @_;
		192	...
		193	},
		194	);
		195
		196	Example, attach to the jeweler skill:
		197
		198	cf::object->attach (
		199	type => cf::SKILL,
		200	subtype => cf::SK_JEWELER,
		201	on_use_skill => sub {
		202	my ($sk, $ob, $part, $dir, $msg) = @_;
		203	...
		204	},
		205	);
		206
		207	=item cf::CLASS::attachment $name, ...
		208
		209	Register an attachment by C<$name> through which attachable objects of the
		210	given CLASS can refer to this attachment.
		211
		212	Some classes such as crossfire maps and objects can specify attachments
		213	that are attached at load/instantiate time, thus the need for a name.
		214
		215	These calls expect any number of the following handler/hook descriptions:
134		216
135	=over 4	217	=over 4
136		218
137	=item prio => $number	219	=item prio => $number
138		220
…		…
140	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
141	earlier. The default priority is C<0>, and many built-in handlers are	223	earlier. The default priority is C<0>, and many built-in handlers are
142	registered at priority C<-1000>, so lower priorities should not be used	224	registered at priority C<-1000>, so lower priorities should not be used
143	unless you know what you are doing.	225	unless you know what you are doing.
144		226
		227	=item type => $type
		228
		229	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		230	given type of objects only (the additional parameter C<subtype> can be
		231	used to further limit to the given subtype).
		232
145	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
146		234
147	Call the given code reference whenever the named event happens (event is	235	Call the given code reference whenever the named event happens (event is
148	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	236	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
149	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
158	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
159	object/class are recognised.	247	object/class are recognised.
160		248
161	=back	249	=back
162		250
163	=item cf::attach_to_type $object_type, $subtype, ...	251	Example, define an attachment called "sockpuppet" that calls the given
		252	event handler when a monster attacks:
164		253
165	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
166	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
167	type.	256	my ($self, $victim) = @_;
		257	...
		258	}
		259	}
168		260
169	=item cf::attach_to_objects ...	261	=item $attachable->valid
170		262
171	Attach handlers to all objects. Do not use this except for debugging or	263	Just because you have a perl object does not mean that the corresponding
172	very rare events, as handlers are (obviously) called for I<all> objects in	264	C-level object still exists. If you try to access an object that has no
173	the game.	265	valid C counterpart anymore you get an exception at runtime. This method
174		266	can be used to test for existence of the C object part without causing an
175	=item cf::attach_to_players ...	267	exception.
176
177	Attach handlers to all players.
178
179	=item cf::attach_to_maps ...
180
181	Attach handlers to all maps.
182
183	=item cf:register_attachment $name, ...
184
185	Register an attachment by name through which objects can refer to this
186	attachment.
187
188	=item cf:register_map_attachment $name, ...
189
190	Register an attachment by name through which maps can refer to this
191	attachment.
192		268
193	=cut	269	=cut
194		270
195	# the following variables are defined in .xs and must not be re-created	271	# the following variables are defined in .xs and must not be re-created
196	our @CB_GLOBAL = (); # registry for all global events	272	our @CB_GLOBAL = (); # registry for all global events
		273	our @CB_ATTACHABLE = (); # registry for all attachables
197	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	274	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
198	our @CB_PLAYER = ();	275	our @CB_PLAYER = ();
		276	our @CB_CLIENT = ();
199	our @CB_TYPE = (); # registry for type (cf-object class) based events	277	our @CB_TYPE = (); # registry for type (cf-object class) based events
200	our @CB_MAP = ();	278	our @CB_MAP = ();
201		279
202	my %attachment;	280	my %attachment;
203		281
204	sub _attach_cb($\%$$$) {	282	sub _attach_cb($$$$) {
205	my ($registry, $undo, $event, $prio, $cb) = @_;	283	my ($registry, $event, $prio, $cb) = @_;
206		284
207	use sort 'stable';	285	use sort 'stable';
208		286
209	$cb = [$prio, $cb];	287	$cb = [$prio, $cb];
210		288
211	@{$registry->[$event]} = sort	289	@{$registry->[$event]} = sort
212	{ $a->[0] cmp $b->[0] }	290	{ $a->[0] cmp $b->[0] }
213	@{$registry->[$event] || []}, $cb;	291	@{$registry->[$event] || []}, $cb;
214
215	push @{$undo->{cb}}, [$event, $cb];
216	}	292	}
		293
		294	# hack
		295	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
217		296
218	# attach handles attaching event callbacks	297	# attach handles attaching event callbacks
219	# the only thing the caller has to do is pass the correct	298	# the only thing the caller has to do is pass the correct
220	# registry (== where the callback attaches to).	299	# registry (== where the callback attaches to).
221	sub _attach(\@$@) {	300	sub _attach {
222	my ($registry, $klass, @arg) = @_;	301	my ($registry, $klass, @arg) = @_;
223		302
		303	my $object_type;
224	my $prio = 0;	304	my $prio = 0;
225
226	my %undo = (
227	registry => $registry,
228	cb => [],
229	);
230
231	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	305	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		306
		307	#TODO: get rid of this hack
		308	if ($attachable_klass{$klass}) {
		309	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		310	}
232		311
233	while (@arg) {	312	while (@arg) {
234	my $type = shift @arg;	313	my $type = shift @arg;
235		314
236	if ($type eq "prio") {	315	if ($type eq "prio") {
237	$prio = shift @arg;	316	$prio = shift @arg;
238		317
		318	} elsif ($type eq "type") {
		319	$object_type = shift @arg;
		320	$registry = $CB_TYPE[$object_type] ||= [];
		321
		322	} elsif ($type eq "subtype") {
		323	defined $object_type or Carp::croak "subtype specified without type";
		324	my $object_subtype = shift @arg;
		325	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		326
239	} elsif ($type eq "package") {	327	} elsif ($type eq "package") {
240	my $pkg = shift @arg;	328	my $pkg = shift @arg;
241		329
242	while (my ($name, $id) = each %cb_id) {	330	while (my ($name, $id) = each %cb_id) {
243	if (my $cb = $pkg->can ($name)) {	331	if (my $cb = $pkg->can ($name)) {
244	_attach_cb $registry, %undo, $id, $prio, $cb;	332	_attach_cb $registry, $id, $prio, $cb;
245	}	333	}
246	}	334	}
247		335
248	} elsif (exists $cb_id{$type}) {	336	} elsif (exists $cb_id{$type}) {
249	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
250		338
251	} elsif (ref $type) {	339	} elsif (ref $type) {
252	warn "attaching objects not supported, ignoring.\n";	340	warn "attaching objects not supported, ignoring.\n";
253		341
254	} else {	342	} else {
255	shift @arg;	343	shift @arg;
256	warn "attach argument '$type' not supported, ignoring.\n";	344	warn "attach argument '$type' not supported, ignoring.\n";
257	}	345	}
258	}	346	}
259
260	\%undo
261	}	347	}
262		348
263	sub _attach_attachment {	349	sub _object_attach {
264	my ($obj, $name, %arg) = @_;	350	my ($obj, $name, %arg) = @_;
265		351
266	my $res;	352	return if exists $obj->{_attachment}{$name};
267		353
268	if (my $attach = $attachment{$name}) {	354	if (my $attach = $attachment{$name}) {
269	my $registry = $obj->registry;	355	my $registry = $obj->registry;
270		356
271	for (@$attach) {	357	for (@$attach) {
272	my ($klass, @attach) = @$_;	358	my ($klass, @attach) = @$_;
273	$res = _attach @$registry, $klass, @attach;	359	_attach $registry, $klass, @attach;
274	}	360	}
275		361
276	$obj->{$name} = \%arg;	362	$obj->{$name} = \%arg;
277	} else {	363	} else {
278	warn "object uses attachment '$name' that is not available, postponing.\n";	364	warn "object uses attachment '$name' that is not available, postponing.\n";
279	}	365	}
280		366
281	$obj->{_attachment}{$name} = undef;	367	$obj->{_attachment}{$name} = undef;
282
283	$res->{attachment} = $name;
284	$res
285	}	368	}
286		369
287	*cf::object::attach =	370	sub cf::attachable::attach {
288	*cf::player::attach =	371	if (ref $_[0]) {
289	*cf::map::attach = sub {	372	_object_attach @_;
290	my ($obj, $name, %arg) = @_;	373	} else {
291		374	_attach shift->_attach_registry, @_;
292	_attach_attachment $obj, $name, %arg;	375	}
293	}	376	};
294		377
295	# all those should be optimised	378	# all those should be optimised
296	*cf::object::detach =	379	sub cf::attachable::detach {
297	*cf::player::detach =
298	*cf::map::detach = sub {
299	my ($obj, $name) = @_;	380	my ($obj, $name) = @_;
300		381
		382	if (ref $obj) {
301	delete $obj->{_attachment}{$name};	383	delete $obj->{_attachment}{$name};
302	reattach $obj;	384	reattach ($obj);
		385	} else {
		386	Carp::croak "cannot, currently, detach class attachments";
		387	}
303	};	388	};
304		389
305	sub attach_global {	390	sub cf::attachable::attached {
306	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	391	my ($obj, $name) = @_;
307	}
308		392
309	sub attach_to_type {	393	exists $obj->{_attachment}{$name}
310	my $type = shift;
311	my $subtype = shift;
312
313	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
314	}	394	}
315		395
316	sub attach_to_objects {	396	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
317	_attach @CB_OBJECT, KLASS_OBJECT, @_	397	eval "#line " . __LINE__ . " 'cf.pm'
318	}	398	sub cf::\L$klass\E::_attach_registry {
		399	(\\\@CB_$klass, KLASS_$klass)
		400	}
319		401
320	sub attach_to_players {	402	sub cf::\L$klass\E::attachment {
321	_attach @CB_PLAYER, KLASS_PLAYER, @_
322	}
323
324	sub attach_to_maps {
325	_attach @CB_MAP, KLASS_MAP, @_
326	}
327
328	sub register_attachment {
329	my $name = shift;	403	my \$name = shift;
330		404
331	$attachment{$name} = [[KLASS_OBJECT, @_]];
332	}
333
334	sub register_map_attachment {
335	my $name = shift;
336
337	$attachment{$name} = [[KLASS_MAP, @_]];	405	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		406	}
		407	";
		408	die if $@;
338	}	409	}
339		410
340	our $override;	411	our $override;
341	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	412	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
342		413
…		…
356	for (@$callbacks) {	427	for (@$callbacks) {
357	eval { &{$_->[1]} };	428	eval { &{$_->[1]} };
358		429
359	if ($@) {	430	if ($@) {
360	warn "$@";	431	warn "$@";
361	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
362	override;	433	override;
363	}	434	}
364		435
365	return 1 if $override;	436	return 1 if $override;
366	}	437	}
367		438
368	0	439	0
369	}	440	}
		441
		442	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		443
		444	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		445
		446	Generate an object-specific event with the given arguments.
		447
		448	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		449	removed in future versions), and there is no public API to access override
		450	results (if you must, access C<@cf::invoke_results> directly).
		451
		452	=back
		453
		454	=cut
370		455
371	#############################################################################	456	#############################################################################
372	# object support	457	# object support
373		458
374	sub instantiate {
375	my ($obj, $data) = @_;
376
377	$data = from_json $data;
378
379	for (@$data) {
380	my ($name, $args) = @$_;
381
382	$obj->attach ($name, %{$args || {} });
383	}
384	}
385
386	# basically do the same as instantiate, without calling instantiate
387	sub reattach {	459	sub reattach {
		460	# basically do the same as instantiate, without calling instantiate
388	my ($obj) = @_;	461	my ($obj) = @_;
		462
389	my $registry = $obj->registry;	463	my $registry = $obj->registry;
390		464
391	@$registry = ();	465	@$registry = ();
392		466
393	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	467	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
394		468
395	for my $name (keys %{ $obj->{_attachment} || {} }) {	469	for my $name (keys %{ $obj->{_attachment} || {} }) {
396	if (my $attach = $attachment{$name}) {	470	if (my $attach = $attachment{$name}) {
397	for (@$attach) {	471	for (@$attach) {
398	my ($klass, @attach) = @$_;	472	my ($klass, @attach) = @$_;
399	_attach @$registry, $klass, @attach;	473	_attach $registry, $klass, @attach;
400	}	474	}
401	} else {	475	} else {
402	warn "object uses attachment '$name' that is not available, postponing.\n";	476	warn "object uses attachment '$name' that is not available, postponing.\n";
403	}	477	}
404	}	478	}
405	}	479	}
406		480
407	sub object_freezer_save {	481	cf::attachable->attach (
408	my ($filename, $objs) = @_;
409
410	if (@$objs) {
411	open my $fh, ">:raw", "$filename.pst~";
412	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
413	close $fh;
414	chmod SAVE_MODE, "$filename.pst~";
415	rename "$filename.pst~", "$filename.pst";
416	} else {
417	unlink "$filename.pst";
418	}
419
420	chmod SAVE_MODE, "$filename~";
421	rename "$filename~", $filename;
422	}
423
424	sub object_thawer_load {
425	my ($filename) = @_;
426
427	open my $fh, "<:raw:perlio", "$filename.pst"
428	or return;
429
430	eval { local $/; (Storable::thaw <$fh>)->{objs} }
431	}
432
433	attach_to_objects
434	prio => -1000000,	482	prio => -1000000,
		483	on_instantiate => sub {
		484	my ($obj, $data) = @_;
		485
		486	$data = from_json $data;
		487
		488	for (@$data) {
		489	my ($name, $args) = @$_;
		490
		491	$obj->attach ($name, %{$args || {} });
		492	}
		493	},
		494	on_reattach => \&reattach,
435	on_clone => sub {	495	on_clone => sub {
436	my ($src, $dst) = @_;	496	my ($src, $dst) = @_;
437		497
438	@{$dst->registry} = @{$src->registry};	498	@{$dst->registry} = @{$src->registry};
439		499
440	%$dst = %$src;	500	%$dst = %$src;
441		501
442	%{$dst->{_attachment}} = %{$src->{_attachment}}	502	%{$dst->{_attachment}} = %{$src->{_attachment}}
443	if exists $src->{_attachment};	503	if exists $src->{_attachment};
444	},	504	},
445	;	505	);
		506
		507	sub object_freezer_save {
		508	my ($filename, $rdata, $objs) = @_;
		509
		510	if (length $$rdata) {
		511	warn sprintf "saving %s (%d,%d)\n",
		512	$filename, length $$rdata, scalar @$objs;
		513
		514	if (open my $fh, ">:raw", "$filename~") {
		515	chmod SAVE_MODE, $fh;
		516	syswrite $fh, $$rdata;
		517	close $fh;
		518
		519	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		520	chmod SAVE_MODE, $fh;
		521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		522	close $fh;
		523	rename "$filename.pst~", "$filename.pst";
		524	} else {
		525	unlink "$filename.pst";
		526	}
		527
		528	rename "$filename~", $filename;
		529	} else {
		530	warn "FATAL: $filename~: $!\n";
		531	}
		532	} else {
		533	unlink $filename;
		534	unlink "$filename.pst";
		535	}
		536	}
		537
		538	sub object_freezer_as_string {
		539	my ($rdata, $objs) = @_;
		540
		541	use Data::Dumper;
		542
		543	$$rdata . Dumper $objs
		544	}
		545
		546	sub object_thawer_load {
		547	my ($filename) = @_;
		548
		549	local $/;
		550
		551	my $av;
		552
		553	#TODO: use sysread etc.
		554	if (open my $data, "<:raw:perlio", $filename) {
		555	$data = <$data>;
		556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		557	$av = eval { (Storable::thaw <$pst>)->{objs} };
		558	}
		559	return ($data, $av);
		560	}
		561
		562	()
		563	}
446		564
447	#############################################################################	565	#############################################################################
448	# old plug-in events	566	# command handling &c
449		567
450	sub inject_event {	568	=item cf::register_command $name => \&callback($ob,$args);
451	my $extension = shift;
452	my $event_code = shift;
453		569
454	my $cb = $hook[$event_code]{$extension}	570	Register a callback for execution when the client sends the user command
455	or return;	571	$name.
456		572
457	&$cb	573	=cut
458	}
459
460	sub inject_global_event {
461	my $event = shift;
462
463	my $cb = $hook[$event]
464	or return;
465
466	List::Util::max map &$_, values %$cb
467	}
468
469	sub inject_command {
470	my ($name, $obj, $params) = @_;
471
472	for my $cmd (@{ $command{$name} }) {
473	$cmd->[1]->($obj, $params);
474	}
475
476	-1
477	}
478		574
479	sub register_command {	575	sub register_command {
480	my ($name, $time, $cb) = @_;	576	my ($name, $cb) = @_;
481		577
482	my $caller = caller;	578	my $caller = caller;
483	#warn "registering command '$name/$time' to '$caller'";	579	#warn "registering command '$name/$time' to '$caller'";
484		580
485	push @{ $command{$name} }, [$time, $cb, $caller];	581	push @{ $COMMAND{$name} }, [$caller, $cb];
486	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
487	}	582	}
		583
		584	=item cf::register_extcmd $name => \&callback($pl,$packet);
		585
		586	Register a callbackf ro execution when the client sends an extcmd packet.
		587
		588	If the callback returns something, it is sent back as if reply was being
		589	called.
		590
		591	=cut
488		592
489	sub register_extcmd {	593	sub register_extcmd {
490	my ($name, $cb) = @_;	594	my ($name, $cb) = @_;
491		595
492	my $caller = caller;	596	my $caller = caller;
493	#warn "registering extcmd '$name' to '$caller'";	597	#warn "registering extcmd '$name' to '$caller'";
494		598
495	$extcmd{$name} = [$cb, $caller];	599	$EXTCMD{$name} = [$cb, $caller];
496	}	600	}
		601
		602	cf::player->attach (
		603	on_command => sub {
		604	my ($pl, $name, $params) = @_;
		605
		606	my $cb = $COMMAND{$name}
		607	or return;
		608
		609	for my $cmd (@$cb) {
		610	$cmd->[1]->($pl->ob, $params);
		611	}
		612
		613	cf::override;
		614	},
		615	on_extcmd => sub {
		616	my ($pl, $buf) = @_;
		617
		618	my $msg = eval { from_json $buf };
		619
		620	if (ref $msg) {
		621	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		622	if (my %reply = $cb->[0]->($pl, $msg)) {
		623	$pl->ext_reply ($msg->{msgid}, %reply);
		624	}
		625	}
		626	} else {
		627	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		628	}
		629
		630	cf::override;
		631	},
		632	);
497		633
498	sub register {	634	sub register {
499	my ($base, $pkg) = @_;	635	my ($base, $pkg) = @_;
500		636
501	#TODO	637	#TODO
…		…
520	. "#line 1 \"$path\"\n{\n"	656	. "#line 1 \"$path\"\n{\n"
521	. (do { local $/; <$fh> })	657	. (do { local $/; <$fh> })
522	. "\n};\n1";	658	. "\n};\n1";
523		659
524	eval $source	660	eval $source
525	or die "$path: $@";	661	or die $@ ? "$path: $@\n"
		662	: "extension disabled.\n";
526		663
527	push @exts, $pkg;	664	push @exts, $pkg;
528	$ext_pkg{$base} = $pkg;	665	$ext_pkg{$base} = $pkg;
529		666
530	# no strict 'refs';	667	# no strict 'refs';
…		…
543	# for my $idx (0 .. $#PLUGIN_EVENT) {	680	# for my $idx (0 .. $#PLUGIN_EVENT) {
544	# delete $hook[$idx]{$pkg};	681	# delete $hook[$idx]{$pkg};
545	# }	682	# }
546		683
547	# remove commands	684	# remove commands
548	for my $name (keys %command) {	685	for my $name (keys %COMMAND) {
549	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	686	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
550		687
551	if (@cb) {	688	if (@cb) {
552	$command{$name} = \@cb;	689	$COMMAND{$name} = \@cb;
553	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
554	} else {	690	} else {
555	delete $command{$name};
556	delete $COMMAND{"$name\000"};	691	delete $COMMAND{$name};
557	}	692	}
558	}	693	}
559		694
560	# remove extcmds	695	# remove extcmds
561	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	696	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
562	delete $extcmd{$name};	697	delete $EXTCMD{$name};
563	}	698	}
564		699
565	if (my $cb = $pkg->can ("unload")) {	700	if (my $cb = $pkg->can ("unload")) {
566	eval {	701	eval {
567	$cb->($pkg);	702	$cb->($pkg);
…		…
571		706
572	Symbol::delete_package $pkg;	707	Symbol::delete_package $pkg;
573	}	708	}
574		709
575	sub load_extensions {	710	sub load_extensions {
576	my $LIBDIR = maps_directory "perl";
577
578	for my $ext (<$LIBDIR/*.ext>) {	711	for my $ext (<$LIBDIR/*.ext>) {
579	next unless -r $ext;	712	next unless -r $ext;
580	eval {	713	eval {
581	load_extension $ext;	714	load_extension $ext;
582	1	715	1
583	} or warn "$ext not loaded: $@";	716	} or warn "$ext not loaded: $@";
584	}	717	}
585	}	718	}
586		719
587	sub _perl_reload(&) {
588	my ($msg) = @_;
589
590	$msg->("reloading...");
591
592	eval {
593	# 1. cancel all watchers
594	$_->cancel for Event::all_watchers;
595
596	# 2. unload all extensions
597	for (@exts) {
598	$msg->("unloading <$_>");
599	unload_extension $_;
600	}
601
602	# 3. unload all modules loaded from $LIBDIR
603	while (my ($k, $v) = each %INC) {
604	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
605
606	$msg->("removing <$k>");
607	delete $INC{$k};
608
609	$k =~ s/\.pm$//;
610	$k =~ s/\//::/g;
611
612	if (my $cb = $k->can ("unload_module")) {
613	$cb->();
614	}
615
616	Symbol::delete_package $k;
617	}
618
619	# 4. get rid of safe::, as good as possible
620	Symbol::delete_package "safe::$_"
621	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
622
623	# 5. remove register_script_function callbacks
624	# TODO
625
626	# 6. unload cf.pm "a bit"
627	delete $INC{"cf.pm"};
628
629	# don't, removes xs symbols, too,
630	# and global variables created in xs
631	#Symbol::delete_package __PACKAGE__;
632
633	# 7. reload cf.pm
634	$msg->("reloading cf.pm");
635	require cf;
636	};
637	$msg->($@) if $@;
638
639	$msg->("reloaded");
640	};
641
642	sub perl_reload() {
643	_perl_reload {
644	warn $_[0];
645	print "$_[0]\n";
646	};
647	}
648
649	register_command "perl-reload", 0, sub {
650	my ($who, $arg) = @_;
651
652	if ($who->flag (FLAG_WIZ)) {
653	_perl_reload {
654	warn $_[0];
655	$who->message ($_[0]);
656	};
657	}
658	};
659
660	#############################################################################
661	# extcmd framework, basically convert ext <msg>
662	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
663
664	attach_to_players
665	on_extcmd => sub {
666	my ($pl, $buf) = @_;
667
668	my $msg = eval { from_json $buf };
669
670	if (ref $msg) {
671	if (my $cb = $extcmd{$msg->{msgtype}}) {
672	if (my %reply = $cb->[0]->($pl, $msg)) {
673	$pl->ext_reply ($msg->{msgid}, %reply);
674	}
675	}
676	} else {
677	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
678	}
679
680	cf::override;
681	},
682	;
683
684	#############################################################################	720	#############################################################################
685	# load/save/clean perl data associated with a map	721	# load/save/clean perl data associated with a map
686		722
687	*cf::mapsupport::on_clean = sub {	723	*cf::mapsupport::on_clean = sub {
688	my ($map) = @_;	724	my ($map) = @_;
…		…
691	defined $path or return;	727	defined $path or return;
692		728
693	unlink "$path.pst";	729	unlink "$path.pst";
694	};	730	};
695		731
696	# old style persistent data, TODO: remove #d#
697	*cf::mapsupport::on_swapin =
698	*cf::mapsupport::on_load = sub {
699	my ($map) = @_;
700
701	my $path = $map->tmpname;
702	$path = $map->path unless defined $path;
703
704	open my $fh, "<:raw", "$path.cfperl"
705	or return; # no perl data
706
707	my $data = Storable::thaw do { local $/; <$fh> };
708
709	$data->{version} <= 1
710	or return; # too new
711
712	$map->_set_obs ($data->{obs});
713	$map->invoke (EVENT_MAP_UPGRADE);
714	};
715
716	attach_to_maps prio => -10000, package => cf::mapsupport::;	732	cf::map->attach (prio => -10000, package => cf::mapsupport::);
717		733
718	#############################################################################	734	#############################################################################
719	# load/save perl data associated with player->ob objects	735	# load/save perl data associated with player->ob objects
720		736
721	sub all_objects(@) {	737	sub all_objects(@) {
722	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
723	}	739	}
724		740
725	attach_to_players	741	# TODO: compatibility cruft, remove when no longer needed
		742	cf::player->attach (
726	on_load => sub {	743	on_load => sub {
727	my ($pl, $path) = @_;	744	my ($pl, $path) = @_;
728		745
729	for my $o (all_objects $pl->ob) {	746	for my $o (all_objects $pl->ob) {
730	if (my $value = $o->get_ob_key_value ("_perl_data")) {	747	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
732		749
733	%$o = %{ Storable::thaw pack "H*", $value };	750	%$o = %{ Storable::thaw pack "H*", $value };
734	}	751	}
735	}	752	}
736	},	753	},
737	;	754	);
738		755
739	#############################################################################	756	#############################################################################
740	# core extensions - in perl	757
		758	=head2 CORE EXTENSIONS
		759
		760	Functions and methods that extend core crossfire objects.
		761
		762	=head3 cf::player
		763
		764	=over 4
741		765
742	=item cf::player::exists $login	766	=item cf::player::exists $login
743		767
744	Returns true when the given account exists.	768	Returns true when the given account exists.
745		769
…		…
748	sub cf::player::exists($) {	772	sub cf::player::exists($) {
749	cf::player::find $_[0]	773	cf::player::find $_[0]
750	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	774	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
751	}	775	}
752		776
		777	=item $player->ext_reply ($msgid, $msgtype, %msg)
		778
		779	Sends an ext reply to the player.
		780
		781	=cut
		782
		783	sub cf::player::ext_reply($$$%) {
		784	my ($self, $id, %msg) = @_;
		785
		786	$msg{msgid} = $id;
		787
		788	$self->send ("ext " . to_json \%msg);
		789	}
		790
		791	=back
		792
		793	=head3 cf::object::player
		794
		795	=over 4
		796
753	=item $player->reply ($npc, $msg[, $flags])	797	=item $player_object->reply ($npc, $msg[, $flags])
754		798
755	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	799	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
756	can be C<undef>. Does the right thing when the player is currently in a	800	can be C<undef>. Does the right thing when the player is currently in a
757	dialogue with the given NPC character.	801	dialogue with the given NPC character.
758		802
759	=cut	803	=cut
760		804
761	# rough implementation of a future "reply" method that works	805	# rough implementation of a future "reply" method that works
762	# with dialog boxes.	806	# with dialog boxes.
		807	#TODO: the first argument must go, split into a $npc->reply_to ( method
763	sub cf::object::player::reply($$$;$) {	808	sub cf::object::player::reply($$$;$) {
764	my ($self, $npc, $msg, $flags) = @_;	809	my ($self, $npc, $msg, $flags) = @_;
765		810
766	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	811	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
767		812
…		…
771	$msg = $npc->name . " says: $msg" if $npc;	816	$msg = $npc->name . " says: $msg" if $npc;
772	$self->message ($msg, $flags);	817	$self->message ($msg, $flags);
773	}	818	}
774	}	819	}
775		820
776	=item $player->ext_reply ($msgid, $msgtype, %msg)	821	=item $player_object->may ("access")
777		822
778	Sends an ext reply to the player.	823	Returns wether the given player is authorized to access resource "access"
		824	(e.g. "command_wizcast").
779		825
780	=cut	826	=cut
781		827
782	sub cf::player::ext_reply($$$%) {	828	sub cf::object::player::may {
		829	my ($self, $access) = @_;
		830
		831	$self->flag (cf::FLAG_WIZ) ||
		832	(ref $cf::CFG{"may_$access"}
		833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		834	: $cf::CFG{"may_$access"})
		835	}
		836
		837	=head3 cf::client
		838
		839	=over 4
		840
		841	=item $client->send_drawinfo ($text, $flags)
		842
		843	Sends a drawinfo packet to the client. Circumvents output buffering so
		844	should not be used under normal circumstances.
		845
		846	=cut
		847
		848	sub cf::client::send_drawinfo {
		849	my ($self, $text, $flags) = @_;
		850
		851	utf8::encode $text;
		852	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		853	}
		854
		855
		856	=item $success = $client->query ($flags, "text", \&cb)
		857
		858	Queues a query to the client, calling the given callback with
		859	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		860	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		861
		862	Queries can fail, so check the return code. Or don't, as queries will become
		863	reliable at some point in the future.
		864
		865	=cut
		866
		867	sub cf::client::query {
		868	my ($self, $flags, $text, $cb) = @_;
		869
		870	return unless $self->state == ST_PLAYING
		871	|| $self->state == ST_SETUP
		872	|| $self->state == ST_CUSTOM;
		873
		874	$self->state (ST_CUSTOM);
		875
		876	utf8::encode $text;
		877	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		878
		879	$self->send_packet ($self->{query_queue}[0][0])
		880	if @{ $self->{query_queue} } == 1;
		881	}
		882
		883	cf::client->attach (
		884	on_reply => sub {
		885	my ($ns, $msg) = @_;
		886
		887	# this weird shuffling is so that direct followup queries
		888	# get handled first
		889	my $queue = delete $ns->{query_queue};
		890
		891	(shift @$queue)->[1]->($msg);
		892
		893	push @{ $ns->{query_queue} }, @$queue;
		894
		895	if (@{ $ns->{query_queue} } == @$queue) {
		896	if (@$queue) {
		897	$ns->send_packet ($ns->{query_queue}[0][0]);
		898	} else {
		899	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		900	}
		901	}
		902	},
		903	);
		904
		905	=item $client->coro (\&cb)
		906
		907	Create a new coroutine, running the specified callback. The coroutine will
		908	be automatically cancelled when the client gets destroyed (e.g. on logout,
		909	or loss of connection).
		910
		911	=cut
		912
		913	sub cf::client::coro {
783	my ($self, $id, %msg) = @_;	914	my ($self, $cb) = @_;
784		915
785	$msg{msgid} = $id;	916	my $coro; $coro = async {
		917	eval {
		918	$cb->();
		919	};
		920	warn $@ if $@;
		921	delete $self->{_coro}{$coro+0};
		922	};
786		923
787	$self->send ("ext " . to_json \%msg);	924	$self->{_coro}{$coro+0} = $coro;
788	}	925	}
789		926
790	#############################################################################	927	cf::client->attach (
791	# map scripting support	928	on_destroy => sub {
		929	my ($ns) = @_;
		930
		931	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		932	},
		933	);
		934
		935	=back
		936
		937
		938	=head2 SAFE SCRIPTING
		939
		940	Functions that provide a safe environment to compile and execute
		941	snippets of perl code without them endangering the safety of the server
		942	itself. Looping constructs, I/O operators and other built-in functionality
		943	is not available in the safe scripting environment, and the number of
		944	functions and methods that can be called is greatly reduced.
		945
		946	=cut
792		947
793	our $safe = new Safe "safe";	948	our $safe = new Safe "safe";
794	our $safe_hole = new Safe::Hole;	949	our $safe_hole = new Safe::Hole;
795		950
796	$SIG{FPE} = 'IGNORE';	951	$SIG{FPE} = 'IGNORE';
797		952
798	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	953	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
799		954
800	# here we export the classes and methods available to script code	955	# here we export the classes and methods available to script code
801		956
		957	=pod
		958
		959	The following fucntions and emthods are available within a safe environment:
		960
		961	cf::object contr pay_amount pay_player map
		962	cf::object::player player
		963	cf::player peaceful
		964	cf::map trigger
		965
		966	=cut
		967
802	for (	968	for (
803	["cf::object" => qw(contr pay_amount pay_player)],	969	["cf::object" => qw(contr pay_amount pay_player map)],
804	["cf::object::player" => qw(player)],	970	["cf::object::player" => qw(player)],
805	["cf::player" => qw(peaceful)],	971	["cf::player" => qw(peaceful)],
		972	["cf::map" => qw(trigger)],
806	) {	973	) {
807	no strict 'refs';	974	no strict 'refs';
808	my ($pkg, @funs) = @$_;	975	my ($pkg, @funs) = @$_;
809	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	976	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
810	for @funs;	977	for @funs;
811	}	978	}
		979
		980	=over 4
		981
		982	=item @retval = safe_eval $code, [var => value, ...]
		983
		984	Compiled and executes the given perl code snippet. additional var/value
		985	pairs result in temporary local (my) scalar variables of the given name
		986	that are available in the code snippet. Example:
		987
		988	my $five = safe_eval '$first + $second', first => 1, second => 4;
		989
		990	=cut
812		991
813	sub safe_eval($;@) {	992	sub safe_eval($;@) {
814	my ($code, %vars) = @_;	993	my ($code, %vars) = @_;
815		994
816	my $qcode = $code;	995	my $qcode = $code;
…		…
839	}	1018	}
840		1019
841	wantarray ? @res : $res[0]	1020	wantarray ? @res : $res[0]
842	}	1021	}
843		1022
		1023	=item cf::register_script_function $function => $cb
		1024
		1025	Register a function that can be called from within map/npc scripts. The
		1026	function should be reasonably secure and should be put into a package name
		1027	like the extension.
		1028
		1029	Example: register a function that gets called whenever a map script calls
		1030	C<rent::overview>, as used by the C<rent> extension.
		1031
		1032	cf::register_script_function "rent::overview" => sub {
		1033	...
		1034	};
		1035
		1036	=cut
		1037
844	sub register_script_function {	1038	sub register_script_function {
845	my ($fun, $cb) = @_;	1039	my ($fun, $cb) = @_;
846		1040
847	no strict 'refs';	1041	no strict 'refs';
848	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1042	*{"safe::$fun"} = $safe_hole->wrap ($cb);
849	}	1043	}
850		1044
		1045	=back
		1046
		1047	=cut
		1048
		1049	#############################################################################
		1050
		1051	=head2 EXTENSION DATABASE SUPPORT
		1052
		1053	Crossfire maintains a very simple database for extension use. It can
		1054	currently store anything that can be serialised using Storable, which
		1055	excludes objects.
		1056
		1057	The parameter C<$family> should best start with the name of the extension
		1058	using it, it should be unique.
		1059
		1060	=over 4
		1061
		1062	=item $hashref = cf::db_get $family
		1063
		1064	Return a hashref for use by the extension C<$family>, which can be
		1065	modified. After modifications, you have to call C<cf::db_dirty> or
		1066	C<cf::db_sync>.
		1067
		1068	=item $value = cf::db_get $family => $key
		1069
		1070	Returns a single value from the database
		1071
		1072	=item cf::db_put $family => $hashref
		1073
		1074	Stores the given family hashref into the database. Updates are delayed, if
		1075	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1076
		1077	=item cf::db_put $family => $key => $value
		1078
		1079	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1080	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1081
		1082	=item cf::db_dirty
		1083
		1084	Marks the database as dirty, to be updated at a later time.
		1085
		1086	=item cf::db_sync
		1087
		1088	Immediately write the database to disk I<if it is dirty>.
		1089
		1090	=cut
		1091
		1092	our $DB;
		1093
		1094	{
		1095	my $path = cf::localdir . "/database.pst";
		1096
		1097	sub db_load() {
		1098	warn "loading database $path\n";#d# remove later
		1099	$DB = stat $path ? Storable::retrieve $path : { };
		1100	}
		1101
		1102	my $pid;
		1103
		1104	sub db_save() {
		1105	warn "saving database $path\n";#d# remove later
		1106	waitpid $pid, 0 if $pid;
		1107	if (0 == ($pid = fork)) {
		1108	$DB->{_meta}{version} = 1;
		1109	Storable::nstore $DB, "$path~";
		1110	rename "$path~", $path;
		1111	cf::_exit 0 if defined $pid;
		1112	}
		1113	}
		1114
		1115	my $dirty;
		1116
		1117	sub db_sync() {
		1118	db_save if $dirty;
		1119	undef $dirty;
		1120	}
		1121
		1122	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1123	db_sync;
		1124	});
		1125
		1126	sub db_dirty() {
		1127	$dirty = 1;
		1128	$idle->start;
		1129	}
		1130
		1131	sub db_get($;$) {
		1132	@_ >= 2
		1133	? $DB->{$_[0]}{$_[1]}
		1134	: ($DB->{$_[0]} ||= { })
		1135	}
		1136
		1137	sub db_put($$;$) {
		1138	if (@_ >= 3) {
		1139	$DB->{$_[0]}{$_[1]} = $_[2];
		1140	} else {
		1141	$DB->{$_[0]} = $_[1];
		1142	}
		1143	db_dirty;
		1144	}
		1145
		1146	cf::global->attach (
		1147	prio => 10000,
		1148	on_cleanup => sub {
		1149	db_sync;
		1150	},
		1151	);
		1152	}
		1153
851	#############################################################################	1154	#############################################################################
852	# the server's main()	1155	# the server's main()
853		1156
		1157	sub cfg_load {
		1158	open my $fh, "<:utf8", cf::confdir . "/config"
		1159	or return;
		1160
		1161	local $/;
		1162	*CFG = YAML::Syck::Load <$fh>;
		1163	}
		1164
854	sub main {	1165	sub main {
		1166	cfg_load;
		1167	db_load;
		1168	load_extensions;
855	Event::loop;	1169	Event::loop;
856	}	1170	}
857		1171
858	#############################################################################	1172	#############################################################################
859	# initialisation	1173	# initialisation
860		1174
		1175	sub _perl_reload(&) {
		1176	my ($msg) = @_;
		1177
		1178	$msg->("reloading...");
		1179
		1180	eval {
		1181	# cancel all watchers
		1182	for (Event::all_watchers) {
		1183	$_->cancel if $_->data & WF_AUTOCANCEL;
		1184	}
		1185
		1186	# unload all extensions
		1187	for (@exts) {
		1188	$msg->("unloading <$_>");
		1189	unload_extension $_;
		1190	}
		1191
		1192	# unload all modules loaded from $LIBDIR
		1193	while (my ($k, $v) = each %INC) {
		1194	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1195
		1196	$msg->("removing <$k>");
		1197	delete $INC{$k};
		1198
		1199	$k =~ s/\.pm$//;
		1200	$k =~ s/\//::/g;
		1201
		1202	if (my $cb = $k->can ("unload_module")) {
		1203	$cb->();
		1204	}
		1205
		1206	Symbol::delete_package $k;
		1207	}
		1208
		1209	# sync database to disk
		1210	cf::db_sync;
		1211
		1212	# get rid of safe::, as good as possible
		1213	Symbol::delete_package "safe::$_"
		1214	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1215
		1216	# remove register_script_function callbacks
		1217	# TODO
		1218
		1219	# unload cf.pm "a bit"
		1220	delete $INC{"cf.pm"};
		1221
		1222	# don't, removes xs symbols, too,
		1223	# and global variables created in xs
		1224	#Symbol::delete_package __PACKAGE__;
		1225
		1226	# reload cf.pm
		1227	$msg->("reloading cf.pm");
		1228	require cf;
		1229	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1230
		1231	# load config and database again
		1232	cf::cfg_load;
		1233	cf::db_load;
		1234
		1235	# load extensions
		1236	$msg->("load extensions");
		1237	cf::load_extensions;
		1238
		1239	# reattach attachments to objects
		1240	$msg->("reattach");
		1241	_global_reattach;
		1242	};
		1243	$msg->($@) if $@;
		1244
		1245	$msg->("reloaded");
		1246	};
		1247
		1248	sub perl_reload() {
		1249	_perl_reload {
		1250	warn $_[0];
		1251	print "$_[0]\n";
		1252	};
		1253	}
		1254
861	register "<global>", __PACKAGE__;	1255	register "<global>", __PACKAGE__;
862		1256
		1257	register_command "perl-reload" => sub {
		1258	my ($who, $arg) = @_;
		1259
		1260	if ($who->flag (FLAG_WIZ)) {
		1261	_perl_reload {
		1262	warn $_[0];
		1263	$who->message ($_[0]);
		1264	};
		1265	}
		1266	};
		1267
863	unshift @INC, $LIBDIR;	1268	unshift @INC, $LIBDIR;
864		1269
865	load_extensions;
866
867	$TICK_WATCHER = Event->timer (	1270	$TICK_WATCHER = Event->timer (
868	prio => 1,	1271	prio => 0,
869	at => $NEXT_TICK || 1,	1272	at => $NEXT_TICK || 1,
		1273	data => WF_AUTOCANCEL,
870	cb => sub {	1274	cb => sub {
871	cf::server_tick; # one server iteration	1275	cf::server_tick; # one server iteration
872		1276
873	my $NOW = Event::time;	1277	my $NOW = Event::time;
874	$NEXT_TICK += $TICK;	1278	$NEXT_TICK += $TICK;
875		1279
876	# if we are delayed by four ticks, skip them all	1280	# if we are delayed by four ticks or more, skip them all
877	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1281	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
878		1282
879	$TICK_WATCHER->at ($NEXT_TICK);	1283	$TICK_WATCHER->at ($NEXT_TICK);
880	$TICK_WATCHER->start;	1284	$TICK_WATCHER->start;
881	},	1285	},
882	);	1286	);
883		1287
884	_reload_2;	1288	IO::AIO::max_poll_time $TICK * 0.2;
		1289
		1290	Event->io (fd => IO::AIO::poll_fileno,
		1291	poll => 'r',
		1292	prio => 5,
		1293	data => WF_AUTOCANCEL,
		1294	cb => \&IO::AIO::poll_cb);
885		1295
886	1	1296	1
887		1297

Diff Legend

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