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.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 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	sub cf::object::attach {	370	sub cf::attachable::attach {
288	my ($obj, $name, %arg) = @_;	371	if (ref $_[0]) {
		372	_object_attach @_;
		373	} else {
		374	_attach shift->_attach_registry, @_;
		375	}
		376	};
289		377
290	_attach_attachment $obj, $name, %arg;	378	# all those should be optimised
291	}
292
293	sub cf::player::attach {
294	my ($obj, $name, %arg) = @_;
295
296	_attach_attachment $obj, $name, %arg;
297	}
298
299	sub cf::map::attach {
300	my ($obj, $name, %arg) = @_;
301
302	_attach_attachment $obj, $name, %arg;
303	}
304
305	sub cf::object::detach {	379	sub cf::attachable::detach {
306	my ($obj, $name) = @_;	380	my ($obj, $name) = @_;
307	die;#d#	381
308	}	382	if (ref $obj) {
309	sub cf::player::detach {	383	delete $obj->{_attachment}{$name};
		384	reattach ($obj);
		385	} else {
		386	Carp::croak "cannot, currently, detach class attachments";
		387	}
		388	};
		389
		390	sub cf::attachable::attached {
310	my ($obj, $name) = @_;	391	my ($obj, $name) = @_;
311	die;#d#
312	}
313	sub cf::map::detach {
314	my ($obj, $name) = @_;
315	die;#d#
316	}
317		392
318	sub attach_global {	393	exists $obj->{_attachment}{$name}
319	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
320	}	394	}
321		395
322	sub attach_to_type {	396	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
323	my $type = shift;	397	eval "#line " . __LINE__ . " 'cf.pm'
324	my $subtype = shift;	398	sub cf::\L$klass\E::_attach_registry {
		399	(\\\@CB_$klass, KLASS_$klass)
		400	}
325		401
326	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	402	sub cf::\L$klass\E::attachment {
327	}
328
329	sub attach_to_objects {
330	_attach @CB_OBJECT, KLASS_OBJECT, @_
331	}
332
333	sub attach_to_players {
334	_attach @CB_PLAYER, KLASS_PLAYER, @_
335	}
336
337	sub attach_to_maps {
338	_attach @CB_MAP, KLASS_MAP, @_
339	}
340
341	sub register_attachment {
342	my $name = shift;	403	my \$name = shift;
343		404
344	$attachment{$name} = [[KLASS_OBJECT, @_]];
345	}
346
347	sub register_map_attachment {
348	my $name = shift;
349
350	$attachment{$name} = [[KLASS_MAP, @_]];	405	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		406	}
		407	";
		408	die if $@;
351	}	409	}
352		410
353	our $override;	411	our $override;
354	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?
355		413
…		…
369	for (@$callbacks) {	427	for (@$callbacks) {
370	eval { &{$_->[1]} };	428	eval { &{$_->[1]} };
371		429
372	if ($@) {	430	if ($@) {
373	warn "$@";	431	warn "$@";
374	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
375	override;	433	override;
376	}	434	}
377		435
378	return 1 if $override;	436	return 1 if $override;
379	}	437	}
380		438
381	0	439	0
382	}	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
383		455
384	#############################################################################	456	#############################################################################
385	# object support	457	# object support
386		458
387	sub instantiate {	459	cf::attachable->attach (
		460	prio => -1000000,
		461	on_instantiate => sub {
388	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
389		463
390	$data = from_json $data;	464	$data = from_json $data;
391		465
392	for (@$data) {	466	for (@$data) {
393	my ($name, $args) = @$_;	467	my ($name, $args) = @$_;
394		468
395	$obj->attach ($name, %{$args || {} });	469	$obj->attach ($name, %{$args || {} });
		470	}
396	}	471	},
397	}	472	on_reattach => sub {
398
399	# basically do the same as instantiate, without calling instantiate	473	# basically do the same as instantiate, without calling instantiate
400	sub reattach {
401	my ($obj) = @_;	474	my ($obj) = @_;
402	my $registry = $obj->registry;	475	my $registry = $obj->registry;
403		476
404	@$registry = ();	477	@$registry = ();
405		478
406	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
407		480
408	for my $name (keys %{ $obj->{_attachment} || {} }) {	481	for my $name (keys %{ $obj->{_attachment} || {} }) {
409	if (my $attach = $attachment{$name}) {	482	if (my $attach = $attachment{$name}) {
410	for (@$attach) {	483	for (@$attach) {
411	my ($klass, @attach) = @$_;	484	my ($klass, @attach) = @$_;
412	_attach @$registry, $klass, @attach;	485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
413	}	489	}
414	} else {
415	warn "object uses attachment '$name' that is not available, postponing.\n";
416	}	490	}
417	}	491	},
418	}
419
420	sub object_freezer_save {
421	my ($filename, $objs) = @_;
422
423	if (@$objs) {
424	open my $fh, ">:raw", "$filename.pst~";
425	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
426	close $fh;
427	chmod SAVE_MODE, "$filename.pst~";
428	rename "$filename.pst~", "$filename.pst";
429	} else {
430	unlink "$filename.pst";
431	}
432
433	chmod SAVE_MODE, "$filename~";
434	rename "$filename~", $filename;
435	}
436
437	sub object_thawer_load {
438	my ($filename) = @_;
439
440	open my $fh, "<:raw:perlio", "$filename.pst"
441	or return;
442
443	eval { local $/; (Storable::thaw <$fh>)->{objs} }
444	}
445
446	attach_to_objects
447	prio => -1000000,
448	on_clone => sub {	492	on_clone => sub {
449	my ($src, $dst) = @_;	493	my ($src, $dst) = @_;
450		494
451	@{$dst->registry} = @{$src->registry};	495	@{$dst->registry} = @{$src->registry};
452		496
453	%$dst = %$src;	497	%$dst = %$src;
454		498
455	%{$dst->{_attachment}} = %{$src->{_attachment}}	499	%{$dst->{_attachment}} = %{$src->{_attachment}}
456	if exists $src->{_attachment};	500	if exists $src->{_attachment};
457	},	501	},
458	;	502	);
		503
		504	sub object_freezer_save {
		505	my ($filename, $rdata, $objs) = @_;
		506
		507	if (length $$rdata) {
		508	warn sprintf "saving %s (%d,%d)\n",
		509	$filename, length $$rdata, scalar @$objs;
		510
		511	if (open my $fh, ">:raw", "$filename~") {
		512	chmod SAVE_MODE, $fh;
		513	syswrite $fh, $$rdata;
		514	close $fh;
		515
		516	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		517	chmod SAVE_MODE, $fh;
		518	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		519	close $fh;
		520	rename "$filename.pst~", "$filename.pst";
		521	} else {
		522	unlink "$filename.pst";
		523	}
		524
		525	rename "$filename~", $filename;
		526	} else {
		527	warn "FATAL: $filename~: $!\n";
		528	}
		529	} else {
		530	unlink $filename;
		531	unlink "$filename.pst";
		532	}
		533	}
		534
		535	sub object_freezer_as_string {
		536	my ($rdata, $objs) = @_;
		537
		538	use Data::Dumper;
		539
		540	$$rdata . Dumper $objs
		541	}
		542
		543	sub object_thawer_load {
		544	my ($filename) = @_;
		545
		546	local $/;
		547
		548	my $av;
		549
		550	#TODO: use sysread etc.
		551	if (open my $data, "<:raw:perlio", $filename) {
		552	$data = <$data>;
		553	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		554	$av = eval { (Storable::thaw <$pst>)->{objs} };
		555	}
		556	return ($data, $av);
		557	}
		558
		559	()
		560	}
459		561
460	#############################################################################	562	#############################################################################
461	# old plug-in events	563	# command handling &c
462		564
463	sub inject_event {	565	=item cf::register_command $name => \&callback($ob,$args);
464	my $extension = shift;
465	my $event_code = shift;
466		566
467	my $cb = $hook[$event_code]{$extension}	567	Register a callback for execution when the client sends the user command
468	or return;	568	$name.
469		569
470	&$cb	570	=cut
471	}
472
473	sub inject_global_event {
474	my $event = shift;
475
476	my $cb = $hook[$event]
477	or return;
478
479	List::Util::max map &$_, values %$cb
480	}
481
482	sub inject_command {
483	my ($name, $obj, $params) = @_;
484
485	for my $cmd (@{ $command{$name} }) {
486	$cmd->[1]->($obj, $params);
487	}
488
489	-1
490	}
491		571
492	sub register_command {	572	sub register_command {
493	my ($name, $time, $cb) = @_;	573	my ($name, $cb) = @_;
494		574
495	my $caller = caller;	575	my $caller = caller;
496	#warn "registering command '$name/$time' to '$caller'";	576	#warn "registering command '$name/$time' to '$caller'";
497		577
498	push @{ $command{$name} }, [$time, $cb, $caller];	578	push @{ $COMMAND{$name} }, [$caller, $cb];
499	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
500	}	579	}
		580
		581	=item cf::register_extcmd $name => \&callback($pl,$packet);
		582
		583	Register a callbackf ro execution when the client sends an extcmd packet.
		584
		585	If the callback returns something, it is sent back as if reply was being
		586	called.
		587
		588	=cut
501		589
502	sub register_extcmd {	590	sub register_extcmd {
503	my ($name, $cb) = @_;	591	my ($name, $cb) = @_;
504		592
505	my $caller = caller;	593	my $caller = caller;
506	#warn "registering extcmd '$name' to '$caller'";	594	#warn "registering extcmd '$name' to '$caller'";
507		595
508	$extcmd{$name} = [$cb, $caller];	596	$EXTCMD{$name} = [$cb, $caller];
509	}	597	}
		598
		599	cf::player->attach (
		600	on_command => sub {
		601	my ($pl, $name, $params) = @_;
		602
		603	my $cb = $COMMAND{$name}
		604	or return;
		605
		606	for my $cmd (@$cb) {
		607	$cmd->[1]->($pl->ob, $params);
		608	}
		609
		610	cf::override;
		611	},
		612	on_extcmd => sub {
		613	my ($pl, $buf) = @_;
		614
		615	my $msg = eval { from_json $buf };
		616
		617	if (ref $msg) {
		618	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		619	if (my %reply = $cb->[0]->($pl, $msg)) {
		620	$pl->ext_reply ($msg->{msgid}, %reply);
		621	}
		622	}
		623	} else {
		624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		625	}
		626
		627	cf::override;
		628	},
		629	);
510		630
511	sub register {	631	sub register {
512	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
513		633
514	#TODO	634	#TODO
…		…
533	. "#line 1 \"$path\"\n{\n"	653	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	654	. (do { local $/; <$fh> })
535	. "\n};\n1";	655	. "\n};\n1";
536		656
537	eval $source	657	eval $source
538	or die "$path: $@";	658	or die $@ ? "$path: $@\n"
		659	: "extension disabled.\n";
539		660
540	push @exts, $pkg;	661	push @exts, $pkg;
541	$ext_pkg{$base} = $pkg;	662	$ext_pkg{$base} = $pkg;
542		663
543	# no strict 'refs';	664	# no strict 'refs';
…		…
556	# for my $idx (0 .. $#PLUGIN_EVENT) {	677	# for my $idx (0 .. $#PLUGIN_EVENT) {
557	# delete $hook[$idx]{$pkg};	678	# delete $hook[$idx]{$pkg};
558	# }	679	# }
559		680
560	# remove commands	681	# remove commands
561	for my $name (keys %command) {	682	for my $name (keys %COMMAND) {
562	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
563		684
564	if (@cb) {	685	if (@cb) {
565	$command{$name} = \@cb;	686	$COMMAND{$name} = \@cb;
566	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
567	} else {	687	} else {
568	delete $command{$name};
569	delete $COMMAND{"$name\000"};	688	delete $COMMAND{$name};
570	}	689	}
571	}	690	}
572		691
573	# remove extcmds	692	# remove extcmds
574	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
575	delete $extcmd{$name};	694	delete $EXTCMD{$name};
576	}	695	}
577		696
578	if (my $cb = $pkg->can ("unload")) {	697	if (my $cb = $pkg->can ("unload")) {
579	eval {	698	eval {
580	$cb->($pkg);	699	$cb->($pkg);
…		…
584		703
585	Symbol::delete_package $pkg;	704	Symbol::delete_package $pkg;
586	}	705	}
587		706
588	sub load_extensions {	707	sub load_extensions {
589	my $LIBDIR = maps_directory "perl";
590
591	for my $ext (<$LIBDIR/*.ext>) {	708	for my $ext (<$LIBDIR/*.ext>) {
592	next unless -r $ext;	709	next unless -r $ext;
593	eval {	710	eval {
594	load_extension $ext;	711	load_extension $ext;
595	1	712	1
596	} or warn "$ext not loaded: $@";	713	} or warn "$ext not loaded: $@";
597	}	714	}
598	}	715	}
599		716
600	sub _perl_reload(&) {
601	my ($msg) = @_;
602
603	$msg->("reloading...");
604
605	eval {
606	# 1. cancel all watchers
607	$_->cancel for Event::all_watchers;
608
609	# 2. unload all extensions
610	for (@exts) {
611	$msg->("unloading <$_>");
612	unload_extension $_;
613	}
614
615	# 3. unload all modules loaded from $LIBDIR
616	while (my ($k, $v) = each %INC) {
617	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
618
619	$msg->("removing <$k>");
620	delete $INC{$k};
621
622	$k =~ s/\.pm$//;
623	$k =~ s/\//::/g;
624
625	if (my $cb = $k->can ("unload_module")) {
626	$cb->();
627	}
628
629	Symbol::delete_package $k;
630	}
631
632	# 4. get rid of safe::, as good as possible
633	Symbol::delete_package "safe::$_"
634	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
635
636	# 5. remove register_script_function callbacks
637	# TODO
638
639	# 6. unload cf.pm "a bit"
640	delete $INC{"cf.pm"};
641
642	# don't, removes xs symbols, too,
643	# and global variables created in xs
644	#Symbol::delete_package __PACKAGE__;
645
646	# 7. reload cf.pm
647	$msg->("reloading cf.pm");
648	require cf;
649	};
650	$msg->($@) if $@;
651
652	$msg->("reloaded");
653	};
654
655	sub perl_reload() {
656	_perl_reload {
657	warn $_[0];
658	print "$_[0]\n";
659	};
660	}
661
662	register_command "perl-reload", 0, sub {
663	my ($who, $arg) = @_;
664
665	if ($who->flag (FLAG_WIZ)) {
666	_perl_reload {
667	warn $_[0];
668	$who->message ($_[0]);
669	};
670	}
671	};
672
673	#############################################################################
674	# extcmd framework, basically convert ext <msg>
675	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
676
677	attach_to_players
678	on_extcmd => sub {
679	my ($pl, $buf) = @_;
680
681	my $msg = eval { from_json $buf };
682
683	if (ref $msg) {
684	if (my $cb = $extcmd{$msg->{msgtype}}) {
685	if (my %reply = $cb->[0]->($pl, $msg)) {
686	$pl->ext_reply ($msg->{msgid}, %reply);
687	}
688	}
689	} else {
690	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
691	}
692
693	cf::override;
694	},
695	;
696
697	#############################################################################	717	#############################################################################
698	# load/save/clean perl data associated with a map	718	# load/save/clean perl data associated with a map
699		719
700	*cf::mapsupport::on_clean = sub {	720	*cf::mapsupport::on_clean = sub {
701	my ($map) = @_;	721	my ($map) = @_;
…		…
704	defined $path or return;	724	defined $path or return;
705		725
706	unlink "$path.pst";	726	unlink "$path.pst";
707	};	727	};
708		728
709	# old style persistent data, TODO: remove #d#
710	*cf::mapsupport::on_swapin =
711	*cf::mapsupport::on_load = sub {
712	my ($map) = @_;
713
714	my $path = $map->tmpname;
715	$path = $map->path unless defined $path;
716
717	open my $fh, "<:raw", "$path.cfperl"
718	or return; # no perl data
719
720	my $data = Storable::thaw do { local $/; <$fh> };
721
722	$data->{version} <= 1
723	or return; # too new
724
725	$map->_set_obs ($data->{obs});
726	$map->invoke (EVENT_MAP_UPGRADE);
727	};
728
729	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
730		730
731	#############################################################################	731	#############################################################################
732	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
733		733
734	sub all_objects(@) {	734	sub all_objects(@) {
735	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
736	}	736	}
737		737
738	attach_to_players	738	# TODO: compatibility cruft, remove when no longer needed
		739	cf::player->attach (
739	on_load => sub {	740	on_load => sub {
740	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
741		742
742	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
745		746
746	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
747	}	748	}
748	}	749	}
749	},	750	},
750	;	751	);
751		752
752	#############################################################################	753	#############################################################################
753	# core extensions - in perl	754
		755	=head2 CORE EXTENSIONS
		756
		757	Functions and methods that extend core crossfire objects.
		758
		759	=head3 cf::player
		760
		761	=over 4
754		762
755	=item cf::player::exists $login	763	=item cf::player::exists $login
756		764
757	Returns true when the given account exists.	765	Returns true when the given account exists.
758		766
…		…
761	sub cf::player::exists($) {	769	sub cf::player::exists($) {
762	cf::player::find $_[0]	770	cf::player::find $_[0]
763	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	771	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
764	}	772	}
765		773
		774	=item $player->ext_reply ($msgid, $msgtype, %msg)
		775
		776	Sends an ext reply to the player.
		777
		778	=cut
		779
		780	sub cf::player::ext_reply($$$%) {
		781	my ($self, $id, %msg) = @_;
		782
		783	$msg{msgid} = $id;
		784
		785	$self->send ("ext " . to_json \%msg);
		786	}
		787
		788	=back
		789
		790	=head3 cf::object::player
		791
		792	=over 4
		793
766	=item $player->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
767		795
768	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	796	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
769	can be C<undef>. Does the right thing when the player is currently in a	797	can be C<undef>. Does the right thing when the player is currently in a
770	dialogue with the given NPC character.	798	dialogue with the given NPC character.
771		799
772	=cut	800	=cut
773		801
774	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
775	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
776	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
777	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
778		807
779	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
780		809
…		…
784	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
785	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
786	}	815	}
787	}	816	}
788		817
789	=item $player->ext_reply ($msgid, $msgtype, %msg)	818	=item $player_object->may ("access")
790		819
791	Sends an ext reply to the player.	820	Returns wether the given player is authorized to access resource "access"
		821	(e.g. "command_wizcast").
792		822
793	=cut	823	=cut
794		824
795	sub cf::player::ext_reply($$$%) {	825	sub cf::object::player::may {
		826	my ($self, $access) = @_;
		827
		828	$self->flag (cf::FLAG_WIZ) ||
		829	(ref $cf::CFG{"may_$access"}
		830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		831	: $cf::CFG{"may_$access"})
		832	}
		833
		834	=head3 cf::client
		835
		836	=over 4
		837
		838	=item $client->send_drawinfo ($text, $flags)
		839
		840	Sends a drawinfo packet to the client. Circumvents output buffering so
		841	should not be used under normal circumstances.
		842
		843	=cut
		844
		845	sub cf::client::send_drawinfo {
		846	my ($self, $text, $flags) = @_;
		847
		848	utf8::encode $text;
		849	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		850	}
		851
		852
		853	=item $success = $client->query ($flags, "text", \&cb)
		854
		855	Queues a query to the client, calling the given callback with
		856	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		857	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		858
		859	Queries can fail, so check the return code. Or don't, as queries will become
		860	reliable at some point in the future.
		861
		862	=cut
		863
		864	sub cf::client::query {
		865	my ($self, $flags, $text, $cb) = @_;
		866
		867	return unless $self->state == ST_PLAYING
		868	|| $self->state == ST_SETUP
		869	|| $self->state == ST_CUSTOM;
		870
		871	$self->state (ST_CUSTOM);
		872
		873	utf8::encode $text;
		874	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		875
		876	$self->send_packet ($self->{query_queue}[0][0])
		877	if @{ $self->{query_queue} } == 1;
		878	}
		879
		880	cf::client->attach (
		881	on_reply => sub {
		882	my ($ns, $msg) = @_;
		883
		884	# this weird shuffling is so that direct followup queries
		885	# get handled first
		886	my $queue = delete $ns->{query_queue};
		887
		888	(shift @$queue)->[1]->($msg);
		889
		890	push @{ $ns->{query_queue} }, @$queue;
		891
		892	if (@{ $ns->{query_queue} } == @$queue) {
		893	if (@$queue) {
		894	$ns->send_packet ($ns->{query_queue}[0][0]);
		895	} else {
		896	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		897	}
		898	}
		899	},
		900	);
		901
		902	=item $client->coro (\&cb)
		903
		904	Create a new coroutine, running the specified callback. The coroutine will
		905	be automatically cancelled when the client gets destroyed (e.g. on logout,
		906	or loss of connection).
		907
		908	=cut
		909
		910	sub cf::client::coro {
796	my ($self, $id, %msg) = @_;	911	my ($self, $cb) = @_;
797		912
798	$msg{msgid} = $id;	913	my $coro; $coro = async {
		914	eval {
		915	$cb->();
		916	};
		917	warn $@ if $@;
		918	delete $self->{_coro}{$coro+0};
		919	};
799		920
800	$self->send ("ext " . to_json \%msg);	921	$self->{_coro}{$coro+0} = $coro;
801	}	922	}
802		923
803	#############################################################################	924	cf::client->attach (
804	# map scripting support	925	on_destroy => sub {
		926	my ($ns) = @_;
		927
		928	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		929	},
		930	);
		931
		932	=back
		933
		934
		935	=head2 SAFE SCRIPTING
		936
		937	Functions that provide a safe environment to compile and execute
		938	snippets of perl code without them endangering the safety of the server
		939	itself. Looping constructs, I/O operators and other built-in functionality
		940	is not available in the safe scripting environment, and the number of
		941	functions and methods that can be called is greatly reduced.
		942
		943	=cut
805		944
806	our $safe = new Safe "safe";	945	our $safe = new Safe "safe";
807	our $safe_hole = new Safe::Hole;	946	our $safe_hole = new Safe::Hole;
808		947
809	$SIG{FPE} = 'IGNORE';	948	$SIG{FPE} = 'IGNORE';
810		949
811	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	950	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
812		951
813	# here we export the classes and methods available to script code	952	# here we export the classes and methods available to script code
814		953
		954	=pod
		955
		956	The following fucntions and emthods are available within a safe environment:
		957
		958	cf::object contr pay_amount pay_player map
		959	cf::object::player player
		960	cf::player peaceful
		961	cf::map trigger
		962
		963	=cut
		964
815	for (	965	for (
816	["cf::object" => qw(contr pay_amount pay_player)],	966	["cf::object" => qw(contr pay_amount pay_player map)],
817	["cf::object::player" => qw(player)],	967	["cf::object::player" => qw(player)],
818	["cf::player" => qw(peaceful)],	968	["cf::player" => qw(peaceful)],
		969	["cf::map" => qw(trigger)],
819	) {	970	) {
820	no strict 'refs';	971	no strict 'refs';
821	my ($pkg, @funs) = @$_;	972	my ($pkg, @funs) = @$_;
822	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
823	for @funs;	974	for @funs;
824	}	975	}
		976
		977	=over 4
		978
		979	=item @retval = safe_eval $code, [var => value, ...]
		980
		981	Compiled and executes the given perl code snippet. additional var/value
		982	pairs result in temporary local (my) scalar variables of the given name
		983	that are available in the code snippet. Example:
		984
		985	my $five = safe_eval '$first + $second', first => 1, second => 4;
		986
		987	=cut
825		988
826	sub safe_eval($;@) {	989	sub safe_eval($;@) {
827	my ($code, %vars) = @_;	990	my ($code, %vars) = @_;
828		991
829	my $qcode = $code;	992	my $qcode = $code;
…		…
852	}	1015	}
853		1016
854	wantarray ? @res : $res[0]	1017	wantarray ? @res : $res[0]
855	}	1018	}
856		1019
		1020	=item cf::register_script_function $function => $cb
		1021
		1022	Register a function that can be called from within map/npc scripts. The
		1023	function should be reasonably secure and should be put into a package name
		1024	like the extension.
		1025
		1026	Example: register a function that gets called whenever a map script calls
		1027	C<rent::overview>, as used by the C<rent> extension.
		1028
		1029	cf::register_script_function "rent::overview" => sub {
		1030	...
		1031	};
		1032
		1033	=cut
		1034
857	sub register_script_function {	1035	sub register_script_function {
858	my ($fun, $cb) = @_;	1036	my ($fun, $cb) = @_;
859		1037
860	no strict 'refs';	1038	no strict 'refs';
861	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1039	*{"safe::$fun"} = $safe_hole->wrap ($cb);
862	}	1040	}
863		1041
		1042	=back
		1043
		1044	=cut
		1045
		1046	#############################################################################
		1047
		1048	=head2 EXTENSION DATABASE SUPPORT
		1049
		1050	Crossfire maintains a very simple database for extension use. It can
		1051	currently store anything that can be serialised using Storable, which
		1052	excludes objects.
		1053
		1054	The parameter C<$family> should best start with the name of the extension
		1055	using it, it should be unique.
		1056
		1057	=over 4
		1058
		1059	=item $hashref = cf::db_get $family
		1060
		1061	Return a hashref for use by the extension C<$family>, which can be
		1062	modified. After modifications, you have to call C<cf::db_dirty> or
		1063	C<cf::db_sync>.
		1064
		1065	=item $value = cf::db_get $family => $key
		1066
		1067	Returns a single value from the database
		1068
		1069	=item cf::db_put $family => $hashref
		1070
		1071	Stores the given family hashref into the database. Updates are delayed, if
		1072	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1073
		1074	=item cf::db_put $family => $key => $value
		1075
		1076	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1077	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1078
		1079	=item cf::db_dirty
		1080
		1081	Marks the database as dirty, to be updated at a later time.
		1082
		1083	=item cf::db_sync
		1084
		1085	Immediately write the database to disk I<if it is dirty>.
		1086
		1087	=cut
		1088
		1089	our $DB;
		1090
		1091	{
		1092	my $path = cf::localdir . "/database.pst";
		1093
		1094	sub db_load() {
		1095	warn "loading database $path\n";#d# remove later
		1096	$DB = stat $path ? Storable::retrieve $path : { };
		1097	}
		1098
		1099	my $pid;
		1100
		1101	sub db_save() {
		1102	warn "saving database $path\n";#d# remove later
		1103	waitpid $pid, 0 if $pid;
		1104	if (0 == ($pid = fork)) {
		1105	$DB->{_meta}{version} = 1;
		1106	Storable::nstore $DB, "$path~";
		1107	rename "$path~", $path;
		1108	cf::_exit 0 if defined $pid;
		1109	}
		1110	}
		1111
		1112	my $dirty;
		1113
		1114	sub db_sync() {
		1115	db_save if $dirty;
		1116	undef $dirty;
		1117	}
		1118
		1119	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1120	db_sync;
		1121	});
		1122
		1123	sub db_dirty() {
		1124	$dirty = 1;
		1125	$idle->start;
		1126	}
		1127
		1128	sub db_get($;$) {
		1129	@_ >= 2
		1130	? $DB->{$_[0]}{$_[1]}
		1131	: ($DB->{$_[0]} ||= { })
		1132	}
		1133
		1134	sub db_put($$;$) {
		1135	if (@_ >= 3) {
		1136	$DB->{$_[0]}{$_[1]} = $_[2];
		1137	} else {
		1138	$DB->{$_[0]} = $_[1];
		1139	}
		1140	db_dirty;
		1141	}
		1142
		1143	cf::global->attach (
		1144	prio => 10000,
		1145	on_cleanup => sub {
		1146	db_sync;
		1147	},
		1148	);
		1149	}
		1150
864	#############################################################################	1151	#############################################################################
865	# the server's main()	1152	# the server's main()
866		1153
		1154	sub cfg_load {
		1155	open my $fh, "<:utf8", cf::confdir . "/config"
		1156	or return;
		1157
		1158	local $/;
		1159	*CFG = YAML::Syck::Load <$fh>;
		1160	}
		1161
867	sub main {	1162	sub main {
		1163	cfg_load;
		1164	db_load;
		1165	load_extensions;
868	Event::loop;	1166	Event::loop;
869	}	1167	}
870		1168
871	#############################################################################	1169	#############################################################################
872	# initialisation	1170	# initialisation
873		1171
		1172	sub _perl_reload(&) {
		1173	my ($msg) = @_;
		1174
		1175	$msg->("reloading...");
		1176
		1177	eval {
		1178	# cancel all watchers
		1179	for (Event::all_watchers) {
		1180	$_->cancel if $_->data & WF_AUTOCANCEL;
		1181	}
		1182
		1183	# unload all extensions
		1184	for (@exts) {
		1185	$msg->("unloading <$_>");
		1186	unload_extension $_;
		1187	}
		1188
		1189	# unload all modules loaded from $LIBDIR
		1190	while (my ($k, $v) = each %INC) {
		1191	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1192
		1193	$msg->("removing <$k>");
		1194	delete $INC{$k};
		1195
		1196	$k =~ s/\.pm$//;
		1197	$k =~ s/\//::/g;
		1198
		1199	if (my $cb = $k->can ("unload_module")) {
		1200	$cb->();
		1201	}
		1202
		1203	Symbol::delete_package $k;
		1204	}
		1205
		1206	# sync database to disk
		1207	cf::db_sync;
		1208
		1209	# get rid of safe::, as good as possible
		1210	Symbol::delete_package "safe::$_"
		1211	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1212
		1213	# remove register_script_function callbacks
		1214	# TODO
		1215
		1216	# unload cf.pm "a bit"
		1217	delete $INC{"cf.pm"};
		1218
		1219	# don't, removes xs symbols, too,
		1220	# and global variables created in xs
		1221	#Symbol::delete_package __PACKAGE__;
		1222
		1223	# reload cf.pm
		1224	$msg->("reloading cf.pm");
		1225	require cf;
		1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		1227
		1228
		1229	# load config and database again
		1230	cf::cfg_load;
		1231	cf::db_load;
		1232
		1233	# load extensions
		1234	$msg->("load extensions");
		1235	cf::load_extensions;
		1236
		1237	# reattach attachments to objects
		1238	$msg->("reattach");
		1239	_global_reattach;
		1240	};
		1241	$msg->($@) if $@;
		1242
		1243	$msg->("reloaded");
		1244	};
		1245
		1246	sub perl_reload() {
		1247	_perl_reload {
		1248	warn $_[0];
		1249	print "$_[0]\n";
		1250	};
		1251	}
		1252
874	register "<global>", __PACKAGE__;	1253	register "<global>", __PACKAGE__;
875		1254
		1255	register_command "perl-reload" => sub {
		1256	my ($who, $arg) = @_;
		1257
		1258	if ($who->flag (FLAG_WIZ)) {
		1259	_perl_reload {
		1260	warn $_[0];
		1261	$who->message ($_[0]);
		1262	};
		1263	}
		1264	};
		1265
876	unshift @INC, $LIBDIR;	1266	unshift @INC, $LIBDIR;
877		1267
878	load_extensions;
879
880	$TICK_WATCHER = Event->timer (	1268	$TICK_WATCHER = Event->timer (
881	prio => 1,	1269	prio => 0,
882	at => $NEXT_TICK || 1,	1270	at => $NEXT_TICK || 1,
		1271	data => WF_AUTOCANCEL,
883	cb => sub {	1272	cb => sub {
884	cf::server_tick; # one server iteration	1273	cf::server_tick; # one server iteration
885		1274
886	my $NOW = Event::time;	1275	my $NOW = Event::time;
887	$NEXT_TICK += $TICK;	1276	$NEXT_TICK += $TICK;
888		1277
889	# if we are delayed by four ticks, skip them all	1278	# if we are delayed by four ticks or more, skip them all
890	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1279	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
891		1280
892	$TICK_WATCHER->at ($NEXT_TICK);	1281	$TICK_WATCHER->at ($NEXT_TICK);
893	$TICK_WATCHER->start;	1282	$TICK_WATCHER->start;
894	},	1283	},
895	);	1284	);
896		1285
897	_reload_2;	1286	IO::AIO::max_poll_time $TICK * 0.2;
		1287
		1288	Event->io (fd => IO::AIO::poll_fileno,
		1289	poll => 'r',
		1290	prio => 5,
		1291	data => WF_AUTOCANCEL,
		1292	cb => \&IO::AIO::poll_cb);
898		1293
899	1	1294	1
900		1295

Diff Legend

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