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

Diff Legend

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