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.49 by root, Sun Aug 27 17:59:26 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 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)) {	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
		150	=head2 ATTACHABLE OBJECTS
		151
		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.
		155
		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+).
		159
		160	=over 4
		161
110	=item $object->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
111		163
112	Attach a pre-registered attachment to an object.	164	=item $attachable->detach ($attachment)
113		165
114	=item $player->attach ($attachment, key => $value...)	166	Attach/detach a pre-registered attachment to a specific object and give it
		167	the specified key/value pairs as arguments.
115		168
116	Attach a pre-registered attachment to a player.	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
117		171
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	172	$obj->attach (minesweeper => width => 10, height => 10);
119		173
120	Attach a pre-registered attachment to a map.	174	=item $bool = $attachable->attached ($name)
121		175
122	=item cf::attach_global ...	176	Checks wether the named attachment is currently attached to the object.
123		177
124	Attach handlers for global events.	178	=item cf::CLASS->attach ...
125		179
126	This and all following C<attach_*>-functions expect any number of the	180	=item cf::CLASS->detach ...
127	following handler/hook descriptions:	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:
128		216
129	=over 4	217	=over 4
130		218
131	=item prio => $number	219	=item prio => $number
132		220
…		…
134	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
135	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
136	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
137	unless you know what you are doing.	225	unless you know what you are doing.
138		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
139	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
140		234
141	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
142	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
143	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
152	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
153	object/class are recognised.	247	object/class are recognised.
154		248
155	=back	249	=back
156		250
157	=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:
158		253
159	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
160	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
161	type.	256	my ($self, $victim) = @_;
		257	...
		258	}
		259	}
162		260
163	=item cf::attach_to_objects ...	261	=item $attachable->valid
164		262
165	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
166	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
167	the game.	265	valid C counterpart anymore you get an exception at runtime. This method
168		266	can be used to test for existence of the C object part without causing an
169	=item cf::attach_to_players ...	267	exception.
170
171	Attach handlers to all players.
172
173	=item cf::attach_to_maps ...
174
175	Attach handlers to all maps.
176
177	=item cf:register_attachment $name, ...
178		268
179	=cut	269	=cut
180		270
181	# 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
182	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
183	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)
184	our @CB_PLAYER = ();	275	our @CB_PLAYER = ();
		276	our @CB_CLIENT = ();
185	our @CB_TYPE = (); # registry for type (cf-object class) based events	277	our @CB_TYPE = (); # registry for type (cf-object class) based events
186	our @CB_MAP = ();	278	our @CB_MAP = ();
187		279
188	my %attachment;	280	my %attachment;
189		281
190	sub _attach_cb($\%$$$) {	282	sub _attach_cb($$$$) {
191	my ($registry, $undo, $event, $prio, $cb) = @_;	283	my ($registry, $event, $prio, $cb) = @_;
192		284
193	use sort 'stable';	285	use sort 'stable';
194		286
195	$cb = [$prio, $cb];	287	$cb = [$prio, $cb];
196		288
197	@{$registry->[$event]} = sort	289	@{$registry->[$event]} = sort
198	{ $a->[0] cmp $b->[0] }	290	{ $a->[0] cmp $b->[0] }
199	@{$registry->[$event] || []}, $cb;	291	@{$registry->[$event] || []}, $cb;
200
201	push @{$undo->{cb}}, [$event, $cb];
202	}	292	}
		293
		294	# hack
		295	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
203		296
204	# attach handles attaching event callbacks	297	# attach handles attaching event callbacks
205	# 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
206	# registry (== where the callback attaches to).	299	# registry (== where the callback attaches to).
207	sub _attach(\@$@) {	300	sub _attach {
208	my ($registry, $klass, @arg) = @_;	301	my ($registry, $klass, @arg) = @_;
209		302
		303	my $object_type;
210	my $prio = 0;	304	my $prio = 0;
211
212	my %undo = (
213	registry => $registry,
214	cb => [],
215	);
216
217	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	}
218		311
219	while (@arg) {	312	while (@arg) {
220	my $type = shift @arg;	313	my $type = shift @arg;
221		314
222	if ($type eq "prio") {	315	if ($type eq "prio") {
223	$prio = shift @arg;	316	$prio = shift @arg;
224		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
225	} elsif ($type eq "package") {	327	} elsif ($type eq "package") {
226	my $pkg = shift @arg;	328	my $pkg = shift @arg;
227		329
228	while (my ($name, $id) = each %cb_id) {	330	while (my ($name, $id) = each %cb_id) {
229	if (my $cb = $pkg->can ($name)) {	331	if (my $cb = $pkg->can ($name)) {
230	_attach_cb $registry, %undo, $id, $prio, $cb;	332	_attach_cb $registry, $id, $prio, $cb;
231	}	333	}
232	}	334	}
233		335
234	} elsif (exists $cb_id{$type}) {	336	} elsif (exists $cb_id{$type}) {
235	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236		338
237	} elsif (ref $type) {	339	} elsif (ref $type) {
238	warn "attaching objects not supported, ignoring.\n";	340	warn "attaching objects not supported, ignoring.\n";
239		341
240	} else {	342	} else {
241	shift @arg;	343	shift @arg;
242	warn "attach argument '$type' not supported, ignoring.\n";	344	warn "attach argument '$type' not supported, ignoring.\n";
243	}	345	}
244	}	346	}
245
246	\%undo
247	}	347	}
248		348
249	sub _attach_attachment {	349	sub _object_attach {
250	my ($obj, $name, %arg) = @_;	350	my ($obj, $name, %arg) = @_;
251		351
252	my $res;	352	return if exists $obj->{_attachment}{$name};
253		353
254	if (my $attach = $attachment{$name}) {	354	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	355	my $registry = $obj->registry;
256		356
257	for (@$attach) {	357	for (@$attach) {
258	my ($klass, @attach) = @$_;	358	my ($klass, @attach) = @$_;
259	$res = _attach @$registry, $klass, @attach;	359	_attach $registry, $klass, @attach;
260	}	360	}
261		361
262	$obj->{$name} = \%arg;	362	$obj->{$name} = \%arg;
263	} else {	363	} else {
264	warn "object uses attachment '$name' that is not available, postponing.\n";	364	warn "object uses attachment '$name' that is not available, postponing.\n";
265	}	365	}
266		366
267	push @{$obj->{_attachment}}, $name;	367	$obj->{_attachment}{$name} = undef;
268
269	$res->{attachment} = $name;
270	$res
271	}	368	}
272		369
273	sub cf::object::attach {	370	sub cf::attachable::attach {
		371	if (ref $_[0]) {
		372	_object_attach @_;
		373	} else {
		374	_attach shift->_attach_registry, @_;
		375	}
		376	};
		377
		378	# all those should be optimised
		379	sub cf::attachable::detach {
274	my ($obj, $name, %arg) = @_;	380	my ($obj, $name) = @_;
275		381
276	_attach_attachment $obj, $name, %arg;	382	if (ref $obj) {
277	}	383	delete $obj->{_attachment}{$name};
		384	reattach ($obj);
		385	} else {
		386	Carp::croak "cannot, currently, detach class attachments";
		387	}
		388	};
278		389
279	sub cf::player::attach {	390	sub cf::attachable::attached {
280	my ($obj, $name, %arg) = @_;	391	my ($obj, $name) = @_;
281		392
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	393	exists $obj->{_attachment}{$name}
283	}	394	}
284		395
285	sub cf::map::attach {	396	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
286	my ($obj, $name, %arg) = @_;	397	eval "#line " . __LINE__ . " 'cf.pm'
		398	sub cf::\L$klass\E::_attach_registry {
		399	(\\\@CB_$klass, KLASS_$klass)
		400	}
287		401
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	402	sub cf::\L$klass\E::attachment {
289	}
290
291	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}
294
295	sub attach_to_type {
296	my $type = shift;
297	my $subtype = shift;
298
299	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	403	my \$name = shift;
316		404
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	405	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		406	}
		407	";
		408	die if $@;
318	}	409	}
319		410
320	our $override;	411	our $override;
321	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?
322		413
…		…
336	for (@$callbacks) {	427	for (@$callbacks) {
337	eval { &{$_->[1]} };	428	eval { &{$_->[1]} };
338		429
339	if ($@) {	430	if ($@) {
340	warn "$@";	431	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	433	override;
343	}	434	}
344		435
345	return 1 if $override;	436	return 1 if $override;
346	}	437	}
347		438
348	0	439	0
349	}	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
350		455
351	#############################################################################	456	#############################################################################
352	# object support	457	# object support
353		458
354	sub instantiate {	459	cf::attachable->attach (
		460	prio => -1000000,
		461	on_instantiate => sub {
355	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
356		463
357	$data = from_json $data;	464	$data = from_json $data;
358		465
359	for (@$data) {	466	for (@$data) {
360	my ($name, $args) = @$_;	467	my ($name, $args) = @$_;
361		468
362	$obj->attach ($name, %{$args || {} });	469	$obj->attach ($name, %{$args || {} });
		470	}
363	}	471	},
364	}	472	on_reattach => sub {
365
366	# basically do the same as instantiate, without calling instantiate	473	# basically do the same as instantiate, without calling instantiate
367	sub reattach {
368	my ($obj) = @_;	474	my ($obj) = @_;
369	my $registry = $obj->registry;	475	my $registry = $obj->registry;
370		476
371	@$registry = ();	477	@$registry = ();
372		478
373	delete $obj->{_attachment} unless @{ $obj->{_attachment} || [] };	479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
374		480
375	for my $name (@{ $obj->{_attachment} || [] }) {	481	for my $name (keys %{ $obj->{_attachment} || {} }) {
376	if (my $attach = $attachment{$name}) {	482	if (my $attach = $attachment{$name}) {
377	for (@$attach) {	483	for (@$attach) {
378	my ($klass, @attach) = @$_;	484	my ($klass, @attach) = @$_;
379	_attach @$registry, $klass, @attach;	485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
		489	}
		490	}
		491	},
		492	on_clone => sub {
		493	my ($src, $dst) = @_;
		494
		495	@{$dst->registry} = @{$src->registry};
		496
		497	%$dst = %$src;
		498
		499	%{$dst->{_attachment}} = %{$src->{_attachment}}
		500	if exists $src->{_attachment};
		501	},
		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	}
		561
		562	#############################################################################
		563	# command handling &c
		564
		565	=item cf::register_command $name => \&callback($ob,$args);
		566
		567	Register a callback for execution when the client sends the user command
		568	$name.
		569
		570	=cut
		571
		572	sub register_command {
		573	my ($name, $cb) = @_;
		574
		575	my $caller = caller;
		576	#warn "registering command '$name/$time' to '$caller'";
		577
		578	push @{ $COMMAND{$name} }, [$caller, $cb];
		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
		589
		590	sub register_extcmd {
		591	my ($name, $cb) = @_;
		592
		593	my $caller = caller;
		594	#warn "registering extcmd '$name' to '$caller'";
		595
		596	$EXTCMD{$name} = [$cb, $caller];
		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	}
380	}	622	}
381	} else {	623	} else {
382	warn "object uses attachment '$name' that is not available, postponing.\n";	624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
383	}	625	}
384	}
385	}
386		626
387	sub object_freezer_save {	627	cf::override;
388	my ($filename, $objs) = @_;
389
390	$filename .= ".pst";
391
392	if (@$objs) {
393	open my $fh, ">:raw", "$filename~";
394	chmod $fh, SAVE_MODE;
395	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
396	close $fh;
397	rename "$filename~", $filename;
398	} else {
399	unlink $filename;
400	}
401	}
402
403	sub object_thawer_load {
404	my ($filename) = @_;
405
406	open my $fh, "<:raw:perlio", "$filename.pst"
407	or return;
408
409	eval { local $/; (Storable::thaw <$fh>)->{objs} }
410	}
411
412	attach_to_objects
413	prio => -1000000,
414	on_clone => sub {
415	my ($src, $dst) = @_;
416
417	@{$dst->registry} = @{$src->registry};
418
419	%$dst = %$src;
420
421	$dst->{_attachment} = [@{ $src->{_attachment} }]
422	if exists $src->{_attachment};
423	},	628	},
424	;	629	);
425
426	#############################################################################
427	# old plug-in events
428
429	sub inject_event {
430	my $extension = shift;
431	my $event_code = shift;
432
433	my $cb = $hook[$event_code]{$extension}
434	or return;
435
436	&$cb
437	}
438
439	sub inject_global_event {
440	my $event = shift;
441
442	my $cb = $hook[$event]
443	or return;
444
445	List::Util::max map &$_, values %$cb
446	}
447
448	sub inject_command {
449	my ($name, $obj, $params) = @_;
450
451	for my $cmd (@{ $command{$name} }) {
452	$cmd->[1]->($obj, $params);
453	}
454
455	-1
456	}
457
458	sub register_command {
459	my ($name, $time, $cb) = @_;
460
461	my $caller = caller;
462	#warn "registering command '$name/$time' to '$caller'";
463
464	push @{ $command{$name} }, [$time, $cb, $caller];
465	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
466	}
467
468	sub register_extcmd {
469	my ($name, $cb) = @_;
470
471	my $caller = caller;
472	#warn "registering extcmd '$name' to '$caller'";
473
474	$extcmd{$name} = [$cb, $caller];
475	}
476		630
477	sub register {	631	sub register {
478	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
479		633
480	#TODO	634	#TODO
…		…
499	. "#line 1 \"$path\"\n{\n"	653	. "#line 1 \"$path\"\n{\n"
500	. (do { local $/; <$fh> })	654	. (do { local $/; <$fh> })
501	. "\n};\n1";	655	. "\n};\n1";
502		656
503	eval $source	657	eval $source
504	or die "$path: $@";	658	or die $@ ? "$path: $@\n"
		659	: "extension disabled.\n";
505		660
506	push @exts, $pkg;	661	push @exts, $pkg;
507	$ext_pkg{$base} = $pkg;	662	$ext_pkg{$base} = $pkg;
508		663
509	# no strict 'refs';	664	# no strict 'refs';
…		…
522	# for my $idx (0 .. $#PLUGIN_EVENT) {	677	# for my $idx (0 .. $#PLUGIN_EVENT) {
523	# delete $hook[$idx]{$pkg};	678	# delete $hook[$idx]{$pkg};
524	# }	679	# }
525		680
526	# remove commands	681	# remove commands
527	for my $name (keys %command) {	682	for my $name (keys %COMMAND) {
528	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
529		684
530	if (@cb) {	685	if (@cb) {
531	$command{$name} = \@cb;	686	$COMMAND{$name} = \@cb;
532	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
533	} else {	687	} else {
534	delete $command{$name};
535	delete $COMMAND{"$name\000"};	688	delete $COMMAND{$name};
536	}	689	}
537	}	690	}
538		691
539	# remove extcmds	692	# remove extcmds
540	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
541	delete $extcmd{$name};	694	delete $EXTCMD{$name};
542	}	695	}
543		696
544	if (my $cb = $pkg->can ("unload")) {	697	if (my $cb = $pkg->can ("unload")) {
545	eval {	698	eval {
546	$cb->($pkg);	699	$cb->($pkg);
…		…
550		703
551	Symbol::delete_package $pkg;	704	Symbol::delete_package $pkg;
552	}	705	}
553		706
554	sub load_extensions {	707	sub load_extensions {
555	my $LIBDIR = maps_directory "perl";
556
557	for my $ext (<$LIBDIR/*.ext>) {	708	for my $ext (<$LIBDIR/*.ext>) {
558	next unless -r $ext;	709	next unless -r $ext;
559	eval {	710	eval {
560	load_extension $ext;	711	load_extension $ext;
561	1	712	1
562	} or warn "$ext not loaded: $@";	713	} or warn "$ext not loaded: $@";
563	}	714	}
564	}	715	}
565		716
566	sub _perl_reload(&) {
567	my ($msg) = @_;
568
569	$msg->("reloading...");
570
571	eval {
572	# 1. cancel all watchers
573	$_->cancel for Event::all_watchers;
574
575	# 2. unload all extensions
576	for (@exts) {
577	$msg->("unloading <$_>");
578	unload_extension $_;
579	}
580
581	# 3. unload all modules loaded from $LIBDIR
582	while (my ($k, $v) = each %INC) {
583	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
584
585	$msg->("removing <$k>");
586	delete $INC{$k};
587
588	$k =~ s/\.pm$//;
589	$k =~ s/\//::/g;
590
591	if (my $cb = $k->can ("unload_module")) {
592	$cb->();
593	}
594
595	Symbol::delete_package $k;
596	}
597
598	# 4. get rid of safe::, as good as possible
599	Symbol::delete_package "safe::$_"
600	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
601
602	# 5. remove register_script_function callbacks
603	# TODO
604
605	# 6. unload cf.pm "a bit"
606	delete $INC{"cf.pm"};
607
608	# don't, removes xs symbols, too,
609	# and global variables created in xs
610	#Symbol::delete_package __PACKAGE__;
611
612	# 7. reload cf.pm
613	$msg->("reloading cf.pm");
614	require cf;
615	};
616	$msg->($@) if $@;
617
618	$msg->("reloaded");
619	};
620
621	sub perl_reload() {
622	_perl_reload {
623	warn $_[0];
624	print "$_[0]\n";
625	};
626	}
627
628	register_command "perl-reload", 0, sub {
629	my ($who, $arg) = @_;
630
631	if ($who->flag (FLAG_WIZ)) {
632	_perl_reload {
633	warn $_[0];
634	$who->message ($_[0]);
635	};
636	}
637	};
638
639	#############################################################################
640	# extcmd framework, basically convert ext <msg>
641	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
642
643	attach_to_players
644	on_extcmd => sub {
645	my ($pl, $buf) = @_;
646
647	my $msg = eval { from_json $buf };
648
649	if (ref $msg) {
650	if (my $cb = $extcmd{$msg->{msgtype}}) {
651	if (my %reply = $cb->[0]->($pl, $msg)) {
652	$pl->ext_reply ($msg->{msgid}, %reply);
653	}
654	}
655	} else {
656	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
657	}
658
659	cf::override;
660	},
661	;
662
663	#############################################################################	717	#############################################################################
664	# load/save/clean perl data associated with a map	718	# load/save/clean perl data associated with a map
665		719
666	*cf::mapsupport::on_clean = sub {	720	*cf::mapsupport::on_clean = sub {
667	my ($map) = @_;	721	my ($map) = @_;
668		722
669	my $path = $map->tmpname;	723	my $path = $map->tmpname;
670	defined $path or return;	724	defined $path or return;
671		725
672	unlink "$path.cfperl";
673	unlink "$path.pst";	726	unlink "$path.pst";
674	};	727	};
675		728
676	*cf::mapsupport::on_swapin =
677	*cf::mapsupport::on_load = sub {
678	my ($map) = @_;
679
680	my $path = $map->tmpname;
681	$path = $map->path unless defined $path;
682
683	open my $fh, "<:raw", "$path.cfperl"
684	or return; # no perl data
685
686	my $data = Storable::thaw do { local $/; <$fh> };
687
688	$data->{version} <= 1
689	or return; # too new
690
691	$map->_set_obs ($data->{obs});
692	};
693
694	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
695		730
696	#############################################################################	731	#############################################################################
697	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
698		733
699	sub all_objects(@) {	734	sub all_objects(@) {
700	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
701	}	736	}
702		737
703	attach_to_players	738	# TODO: compatibility cruft, remove when no longer needed
		739	cf::player->attach (
704	on_load => sub {	740	on_load => sub {
705	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
706		742
707	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
708	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
710		746
711	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
712	}	748	}
713	}	749	}
714	},	750	},
715	;	751	);
716		752
717	#############################################################################	753	#############################################################################
718	# 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
719		762
720	=item cf::player::exists $login	763	=item cf::player::exists $login
721		764
722	Returns true when the given account exists.	765	Returns true when the given account exists.
723		766
…		…
726	sub cf::player::exists($) {	769	sub cf::player::exists($) {
727	cf::player::find $_[0]	770	cf::player::find $_[0]
728	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;
729	}	772	}
730		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
731	=item $player->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
732		795
733	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>
734	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
735	dialogue with the given NPC character.	798	dialogue with the given NPC character.
736		799
737	=cut	800	=cut
738		801
739	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
740	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
741	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
742	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
743		807
744	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
745		809
…		…
749	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
750	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
751	}	815	}
752	}	816	}
753		817
754	=item $player->ext_reply ($msgid, $msgtype, %msg)	818	=item $player_object->may ("access")
755		819
756	Sends an ext reply to the player.	820	Returns wether the given player is authorized to access resource "access"
		821	(e.g. "command_wizcast").
757		822
758	=cut	823	=cut
759		824
760	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 {
761	my ($self, $id, %msg) = @_;	911	my ($self, $cb) = @_;
762		912
763	$msg{msgid} = $id;	913	my $coro; $coro = async {
		914	eval {
		915	$cb->();
		916	};
		917	warn $@ if $@;
		918	delete $self->{_coro}{$coro+0};
		919	};
764		920
765	$self->send ("ext " . to_json \%msg);	921	$self->{_coro}{$coro+0} = $coro;
766	}	922	}
767		923
768	#############################################################################	924	cf::client->attach (
769	# 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
770		944
771	our $safe = new Safe "safe";	945	our $safe = new Safe "safe";
772	our $safe_hole = new Safe::Hole;	946	our $safe_hole = new Safe::Hole;
773		947
774	$SIG{FPE} = 'IGNORE';	948	$SIG{FPE} = 'IGNORE';
775		949
776	$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));
777		951
778	# here we export the classes and methods available to script code	952	# here we export the classes and methods available to script code
779		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
780	for (	965	for (
781	["cf::object" => qw(contr pay_amount pay_player)],	966	["cf::object" => qw(contr pay_amount pay_player map)],
782	["cf::object::player" => qw(player)],	967	["cf::object::player" => qw(player)],
783	["cf::player" => qw(peaceful)],	968	["cf::player" => qw(peaceful)],
		969	["cf::map" => qw(trigger)],
784	) {	970	) {
785	no strict 'refs';	971	no strict 'refs';
786	my ($pkg, @funs) = @$_;	972	my ($pkg, @funs) = @$_;
787	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
788	for @funs;	974	for @funs;
789	}	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
790		988
791	sub safe_eval($;@) {	989	sub safe_eval($;@) {
792	my ($code, %vars) = @_;	990	my ($code, %vars) = @_;
793		991
794	my $qcode = $code;	992	my $qcode = $code;
…		…
817	}	1015	}
818		1016
819	wantarray ? @res : $res[0]	1017	wantarray ? @res : $res[0]
820	}	1018	}
821		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
822	sub register_script_function {	1035	sub register_script_function {
823	my ($fun, $cb) = @_;	1036	my ($fun, $cb) = @_;
824		1037
825	no strict 'refs';	1038	no strict 'refs';
826	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1039	*{"safe::$fun"} = $safe_hole->wrap ($cb);
827	}	1040	}
828		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
829	#############################################################################	1151	#############################################################################
830	# the server's main()	1152	# the server's main()
831		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
832	sub main {	1162	sub main {
		1163	cfg_load;
		1164	db_load;
		1165	load_extensions;
833	Event::loop;	1166	Event::loop;
834	}	1167	}
835		1168
836	#############################################################################	1169	#############################################################################
837	# initialisation	1170	# initialisation
838		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	# load config and database again
		1229	cf::cfg_load;
		1230	cf::db_load;
		1231
		1232	# load extensions
		1233	$msg->("load extensions");
		1234	cf::load_extensions;
		1235
		1236	# reattach attachments to objects
		1237	$msg->("reattach");
		1238	_global_reattach;
		1239	};
		1240	$msg->($@) if $@;
		1241
		1242	$msg->("reloaded");
		1243	};
		1244
		1245	sub perl_reload() {
		1246	_perl_reload {
		1247	warn $_[0];
		1248	print "$_[0]\n";
		1249	};
		1250	}
		1251
839	register "<global>", __PACKAGE__;	1252	register "<global>", __PACKAGE__;
840		1253
		1254	register_command "perl-reload" => sub {
		1255	my ($who, $arg) = @_;
		1256
		1257	if ($who->flag (FLAG_WIZ)) {
		1258	_perl_reload {
		1259	warn $_[0];
		1260	$who->message ($_[0]);
		1261	};
		1262	}
		1263	};
		1264
841	unshift @INC, $LIBDIR;	1265	unshift @INC, $LIBDIR;
842		1266
843	load_extensions;
844
845	$TICK_WATCHER = Event->timer (	1267	$TICK_WATCHER = Event->timer (
846	prio => 1,	1268	prio => 0,
847	at => $NEXT_TICK || 1,	1269	at => $NEXT_TICK || 1,
		1270	data => WF_AUTOCANCEL,
848	cb => sub {	1271	cb => sub {
849	cf::server_tick; # one server iteration	1272	cf::server_tick; # one server iteration
850		1273
851	my $NOW = Event::time;	1274	my $NOW = Event::time;
852	$NEXT_TICK += $TICK;	1275	$NEXT_TICK += $TICK;
853		1276
854	# if we are delayed by four ticks, skip them all	1277	# if we are delayed by four ticks or more, skip them all
855	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1278	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
856		1279
857	$TICK_WATCHER->at ($NEXT_TICK);	1280	$TICK_WATCHER->at ($NEXT_TICK);
858	$TICK_WATCHER->start;	1281	$TICK_WATCHER->start;
859	},	1282	},
860	);	1283	);
861		1284
862	_reload_2;	1285	IO::AIO::max_poll_time $TICK * 0.2;
		1286
		1287	Event->io (fd => IO::AIO::poll_fileno,
		1288	poll => 'r',
		1289	prio => 5,
		1290	data => WF_AUTOCANCEL,
		1291	cb => \&IO::AIO::poll_cb);
863		1292
864	1	1293	1
865		1294

Diff Legend

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