ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.99 by root, Sat Dec 23 05:25:35 2006 UTC

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

Diff Legend

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