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

Diff Legend

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