ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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