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.47 by root, Sun Aug 27 13:02:04 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)) {	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, ...)	152	=head2 ATTACHABLE OBJECTS
111		153
112	Attach a pre-registered attachment to an object.	154	Many objects in crossfire are so-called attachable objects. That means you can
		155	attach callbacks/event handlers (a collection of which is called an "attachment")
		156	to it. All such attachable objects support the following methods.
113		157
114	=item $player->attach ($attachment, ...)	158	In the following description, CLASS can be any of C<global>, C<object>
		159	C<player>, C<client> or C<map> (i.e. the attachable objects in
		160	crossfire+).
115		161
116	Attach a pre-registered attachment to a player.	162	=over 4
117		163
118	=item $map->attach ($attachment, ...) # not yet persistent	164	=item $attachable->attach ($attachment, key => $value...)
119		165
120	Attach a pre-registered attachment to a map.	166	=item $attachable->detach ($attachment)
121		167
122	=item cf::attach_global ...	168	Attach/detach a pre-registered attachment to a specific object and give it
		169	the specified key/value pairs as arguments.
123		170
124	Attach handlers for global events.	171	Example, attach a minesweeper attachment to the given object, making it a
		172	10x10 minesweeper game:
125		173
126	This and all following C<attach_*>-functions expect any number of the	174	$obj->attach (minesweeper => width => 10, height => 10);
127	following handler/hook descriptions:	175
		176	=item $bool = $attachable->attached ($name)
		177
		178	Checks wether the named attachment is currently attached to the object.
		179
		180	=item cf::CLASS->attach ...
		181
		182	=item cf::CLASS->detach ...
		183
		184	Define an anonymous attachment and attach it to all objects of the given
		185	CLASS. See the next function for an explanation of its arguments.
		186
		187	You can attach to global events by using the C<cf::global> class.
		188
		189	Example, log all player logins:
		190
		191	cf::player->attach (
		192	on_login => sub {
		193	my ($pl) = @_;
		194	...
		195	},
		196	);
		197
		198	Example, attach to the jeweler skill:
		199
		200	cf::object->attach (
		201	type => cf::SKILL,
		202	subtype => cf::SK_JEWELER,
		203	on_use_skill => sub {
		204	my ($sk, $ob, $part, $dir, $msg) = @_;
		205	...
		206	},
		207	);
		208
		209	=item cf::CLASS::attachment $name, ...
		210
		211	Register an attachment by C<$name> through which attachable objects of the
		212	given CLASS can refer to this attachment.
		213
		214	Some classes such as crossfire maps and objects can specify attachments
		215	that are attached at load/instantiate time, thus the need for a name.
		216
		217	These calls expect any number of the following handler/hook descriptions:
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, @args) = @_;	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	}
261
262	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
263	for (@$cb) {
264	eval { $_->[1]->($obj, @args); };
265	if ($@) {
266	warn "$@";
267	warn "... while processing '$name' instantiate with args <@args>.\n";
268	}
269	}	353	}
270	}	354
		355	$obj->{$name} = \%arg;
271	} else {	356	} else {
272	warn "object uses attachment '$name' that is not available, postponing.\n";	357	warn "object uses attachment '$name' that is not available, postponing.\n";
273	}	358	}
274		359
275	push @{$obj->{_attachment}}, $name;	360	$obj->{_attachment}{$name} = undef;
276
277	$res->{attachment} = $name;
278	$res
279	}	361	}
280		362
281	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 {
282	my ($obj, $name, @args) = @_;	373	my ($obj, $name) = @_;
283		374
284	_attach_attachment $obj, $name, @args;	375	if (ref $obj) {
285	}	376	delete $obj->{_attachment}{$name};
		377	reattach ($obj);
		378	} else {
		379	Carp::croak "cannot, currently, detach class attachments";
		380	}
		381	};
286		382
287	sub cf::player::attach {	383	sub cf::attachable::attached {
288	my ($obj, $name, @args) = @_;	384	my ($obj, $name) = @_;
289		385
290	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	386	exists $obj->{_attachment}{$name}
291	}	387	}
292		388
293	sub cf::map::attach {	389	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
294	my ($obj, $name, @args) = @_;	390	eval "#line " . __LINE__ . " 'cf.pm'
		391	sub cf::\L$klass\E::_attach_registry {
		392	(\\\@CB_$klass, KLASS_$klass)
		393	}
295		394
296	_attach_attachment KLASS_MAP, $obj, $name, @args;	395	sub cf::\L$klass\E::attachment {
297	}
298
299	sub attach_global {
300	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
301	}
302
303	sub attach_to_type {
304	my $type = shift;
305	my $subtype = shift;
306
307	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
308	}
309
310	sub attach_to_objects {
311	_attach @CB_OBJECT, KLASS_OBJECT, @_
312	}
313
314	sub attach_to_players {
315	_attach @CB_PLAYER, KLASS_PLAYER, @_
316	}
317
318	sub attach_to_maps {
319	_attach @CB_MAP, KLASS_MAP, @_
320	}
321
322	sub register_attachment {
323	my $name = shift;	396	my \$name = shift;
324		397
325	$attachment{$name} = [[KLASS_OBJECT, @_]];	398	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		399	}
		400	";
		401	die if $@;
326	}	402	}
327		403
328	our $override;	404	our $override;
329	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?
330		406
…		…
344	for (@$callbacks) {	420	for (@$callbacks) {
345	eval { &{$_->[1]} };	421	eval { &{$_->[1]} };
346		422
347	if ($@) {	423	if ($@) {
348	warn "$@";	424	warn "$@";
349	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	425	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
350	override;	426	override;
351	}	427	}
352		428
353	return 1 if $override;	429	return 1 if $override;
354	}	430	}
355		431
356	0	432	0
357	}	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
358		448
359	#############################################################################	449	#############################################################################
360	# object support	450	# object support
361		451
362	sub instantiate {	452	sub instantiate {
…		…
364		454
365	$data = from_json $data;	455	$data = from_json $data;
366		456
367	for (@$data) {	457	for (@$data) {
368	my ($name, $args) = @$_;	458	my ($name, $args) = @$_;
369	attach $obj, $name, @{$args || [] };	459
		460	$obj->attach ($name, %{$args || {} });
370	}	461	}
371	}	462	}
372		463
373	# basically do the same as instantiate, without calling instantiate	464	# basically do the same as instantiate, without calling instantiate
374	sub reattach {	465	sub reattach {
375	my ($obj) = @_;	466	my ($obj) = @_;
376	my $registry = $obj->registry;	467	my $registry = $obj->registry;
377		468
378	@$registry = ();	469	@$registry = ();
379		470
		471	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		472
380	for my $name (@{ $obj->{_attachment} }) {	473	for my $name (keys %{ $obj->{_attachment} || {} }) {
381	if (my $attach = $attachment{$name}) {	474	if (my $attach = $attachment{$name}) {
382	for (@$attach) {	475	for (@$attach) {
383	my ($klass, @attach) = @$_;	476	my ($klass, @attach) = @$_;
384	_attach @$registry, $klass, @attach;	477	_attach $registry, $klass, @attach;
385	}	478	}
386	} else {	479	} else {
387	warn "object uses attachment '$name' that is not available, postponing.\n";	480	warn "object uses attachment '$name' that is not available, postponing.\n";
388	}	481	}
389	}	482	}
390	}	483	}
391		484
392	sub object_freezer_save {	485	sub object_freezer_save {
393	my ($filename, $objs) = @_;	486	my ($filename, $rdata, $objs) = @_;
394		487
395	$filename .= ".pst";	488	if (length $$rdata) {
		489	warn sprintf "saving %s (%d,%d)\n",
		490	$filename, length $$rdata, scalar @$objs;
396		491
397	if (@$objs) {
398	open my $fh, ">:raw", "$filename~";	492	if (open my $fh, ">:raw", "$filename~") {
399	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;
400	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	499	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
401	close $fh;	500	close $fh;
		501	rename "$filename.pst~", "$filename.pst";
		502	} else {
		503	unlink "$filename.pst";
		504	}
		505
402	rename "$filename~", $filename;	506	rename "$filename~", $filename;
		507	} else {
		508	warn "FATAL: $filename~: $!\n";
		509	}
403	} else {	510	} else {
404	unlink $filename;	511	unlink $filename;
		512	unlink "$filename.pst";
405	}	513	}
		514	}
		515
		516	sub object_freezer_as_string {
		517	my ($rdata, $objs) = @_;
		518
		519	use Data::Dumper;
		520
		521	$$rdata . Dumper $objs
406	}	522	}
407		523
408	sub object_thawer_load {	524	sub object_thawer_load {
409	my ($filename) = @_;	525	my ($filename) = @_;
410		526
		527	local $/;
		528
		529	my $av;
		530
		531	#TODO: use sysread etc.
		532	if (open my $data, "<:raw:perlio", $filename) {
		533	$data = <$data>;
411	open my $fh, "<:raw:perlio", "$filename.pst"	534	if (open my $pst, "<:raw:perlio", "$filename.pst") {
412	or return;	535	$av = eval { (Storable::thaw <$pst>)->{objs} };
		536	}
		537	return ($data, $av);
		538	}
413		539
414	eval { local $/; (Storable::thaw <$fh>)->{objs} }	540	()
415	}	541	}
416		542
417	attach_to_objects	543	cf::object->attach (
418	prio => -1000000,	544	prio => -1000000,
419	on_clone => sub {	545	on_clone => sub {
420	my ($src, $dst) = @_;	546	my ($src, $dst) = @_;
421		547
422	@{$dst->registry} = @{$src->registry};	548	@{$dst->registry} = @{$src->registry};
423		549
424	%$dst = %$src;	550	%$dst = %$src;
425		551
426	$dst->{_attachment} = [@{ $src->{_attachment} }]	552	%{$dst->{_attachment}} = %{$src->{_attachment}}
427	if exists $src->{_attachment};	553	if exists $src->{_attachment};
428	},	554	},
429	;	555	);
430		556
431	#############################################################################	557	#############################################################################
432	# old plug-in events	558	# command handling &c
433		559
434	sub inject_event {	560	=item cf::register_command $name => \&callback($ob,$args);
435	my $extension = shift;
436	my $event_code = shift;
437		561
438	my $cb = $hook[$event_code]{$extension}	562	Register a callback for execution when the client sends the user command
439	or return;	563	$name.
440		564
441	&$cb	565	=cut
442	}
443
444	sub inject_global_event {
445	my $event = shift;
446
447	my $cb = $hook[$event]
448	or return;
449
450	List::Util::max map &$_, values %$cb
451	}
452
453	sub inject_command {
454	my ($name, $obj, $params) = @_;
455
456	for my $cmd (@{ $command{$name} }) {
457	$cmd->[1]->($obj, $params);
458	}
459
460	-1
461	}
462		566
463	sub register_command {	567	sub register_command {
464	my ($name, $time, $cb) = @_;	568	my ($name, $cb) = @_;
465		569
466	my $caller = caller;	570	my $caller = caller;
467	#warn "registering command '$name/$time' to '$caller'";	571	#warn "registering command '$name/$time' to '$caller'";
468		572
469	push @{ $command{$name} }, [$time, $cb, $caller];	573	push @{ $COMMAND{$name} }, [$caller, $cb];
470	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
471	}	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
472		584
473	sub register_extcmd {	585	sub register_extcmd {
474	my ($name, $cb) = @_;	586	my ($name, $cb) = @_;
475		587
476	my $caller = caller;	588	my $caller = caller;
477	#warn "registering extcmd '$name' to '$caller'";	589	#warn "registering extcmd '$name' to '$caller'";
478		590
479	$extcmd{$name} = [$cb, $caller];	591	$EXTCMD{$name} = [$cb, $caller];
480	}	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	);
481		625
482	sub register {	626	sub register {
483	my ($base, $pkg) = @_;	627	my ($base, $pkg) = @_;
484		628
485	#TODO	629	#TODO
…		…
504	. "#line 1 \"$path\"\n{\n"	648	. "#line 1 \"$path\"\n{\n"
505	. (do { local $/; <$fh> })	649	. (do { local $/; <$fh> })
506	. "\n};\n1";	650	. "\n};\n1";
507		651
508	eval $source	652	eval $source
509	or die "$path: $@";	653	or die $@ ? "$path: $@\n"
		654	: "extension disabled.\n";
510		655
511	push @exts, $pkg;	656	push @exts, $pkg;
512	$ext_pkg{$base} = $pkg;	657	$ext_pkg{$base} = $pkg;
513		658
514	# no strict 'refs';	659	# no strict 'refs';
…		…
527	# for my $idx (0 .. $#PLUGIN_EVENT) {	672	# for my $idx (0 .. $#PLUGIN_EVENT) {
528	# delete $hook[$idx]{$pkg};	673	# delete $hook[$idx]{$pkg};
529	# }	674	# }
530		675
531	# remove commands	676	# remove commands
532	for my $name (keys %command) {	677	for my $name (keys %COMMAND) {
533	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	678	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
534		679
535	if (@cb) {	680	if (@cb) {
536	$command{$name} = \@cb;	681	$COMMAND{$name} = \@cb;
537	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
538	} else {	682	} else {
539	delete $command{$name};
540	delete $COMMAND{"$name\000"};	683	delete $COMMAND{$name};
541	}	684	}
542	}	685	}
543		686
544	# remove extcmds	687	# remove extcmds
545	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	688	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
546	delete $extcmd{$name};	689	delete $EXTCMD{$name};
547	}	690	}
548		691
549	if (my $cb = $pkg->can ("unload")) {	692	if (my $cb = $pkg->can ("unload")) {
550	eval {	693	eval {
551	$cb->($pkg);	694	$cb->($pkg);
…		…
555		698
556	Symbol::delete_package $pkg;	699	Symbol::delete_package $pkg;
557	}	700	}
558		701
559	sub load_extensions {	702	sub load_extensions {
560	my $LIBDIR = maps_directory "perl";
561
562	for my $ext (<$LIBDIR/*.ext>) {	703	for my $ext (<$LIBDIR/*.ext>) {
563	next unless -r $ext;	704	next unless -r $ext;
564	eval {	705	eval {
565	load_extension $ext;	706	load_extension $ext;
566	1	707	1
567	} or warn "$ext not loaded: $@";	708	} or warn "$ext not loaded: $@";
568	}	709	}
569	}	710	}
570		711
571	sub _perl_reload(&) {
572	my ($msg) = @_;
573
574	$msg->("reloading...");
575
576	eval {
577	# 1. cancel all watchers
578	$_->cancel for Event::all_watchers;
579
580	# 2. unload all extensions
581	for (@exts) {
582	$msg->("unloading <$_>");
583	unload_extension $_;
584	}
585
586	# 3. unload all modules loaded from $LIBDIR
587	while (my ($k, $v) = each %INC) {
588	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
589
590	$msg->("removing <$k>");
591	delete $INC{$k};
592
593	$k =~ s/\.pm$//;
594	$k =~ s/\//::/g;
595
596	if (my $cb = $k->can ("unload_module")) {
597	$cb->();
598	}
599
600	Symbol::delete_package $k;
601	}
602
603	# 4. get rid of safe::, as good as possible
604	Symbol::delete_package "safe::$_"
605	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
606
607	# 5. remove register_script_function callbacks
608	# TODO
609
610	# 6. unload cf.pm "a bit"
611	delete $INC{"cf.pm"};
612
613	# don't, removes xs symbols, too,
614	# and global variables created in xs
615	#Symbol::delete_package __PACKAGE__;
616
617	# 7. reload cf.pm
618	$msg->("reloading cf.pm");
619	require cf;
620	};
621	$msg->($@) if $@;
622
623	$msg->("reloaded");
624	};
625
626	sub perl_reload() {
627	_perl_reload {
628	warn $_[0];
629	print "$_[0]\n";
630	};
631	}
632
633	register_command "perl-reload", 0, sub {
634	my ($who, $arg) = @_;
635
636	if ($who->flag (FLAG_WIZ)) {
637	_perl_reload {
638	warn $_[0];
639	$who->message ($_[0]);
640	};
641	}
642	};
643
644	#############################################################################
645	# extcmd framework, basically convert ext <msg>
646	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
647
648	attach_to_players
649	on_extcmd => sub {
650	my ($pl, $buf) = @_;
651
652	my $msg = eval { from_json $buf };
653
654	if (ref $msg) {
655	if (my $cb = $extcmd{$msg->{msgtype}}) {
656	if (my %reply = $cb->[0]->($pl, $msg)) {
657	$pl->ext_reply ($msg->{msgid}, %reply);
658	}
659	}
660	} else {
661	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
662	}
663
664	cf::override;
665	},
666	;
667
668	#############################################################################	712	#############################################################################
669	# load/save/clean perl data associated with a map	713	# load/save/clean perl data associated with a map
670		714
671	*cf::mapsupport::on_clean = sub {	715	*cf::mapsupport::on_clean = sub {
672	my ($map) = @_;	716	my ($map) = @_;
673		717
674	my $path = $map->tmpname;	718	my $path = $map->tmpname;
675	defined $path or return;	719	defined $path or return;
676		720
677	unlink "$path.cfperl";
678	unlink "$path.pst";	721	unlink "$path.pst";
679	};	722	};
680		723
681	*cf::mapsupport::on_swapin =
682	*cf::mapsupport::on_load = sub {
683	my ($map) = @_;
684
685	my $path = $map->tmpname;
686	$path = $map->path unless defined $path;
687
688	open my $fh, "<:raw", "$path.cfperl"
689	or return; # no perl data
690
691	my $data = Storable::thaw do { local $/; <$fh> };
692
693	$data->{version} <= 1
694	or return; # too new
695
696	$map->_set_obs ($data->{obs});
697	};
698
699	attach_to_maps prio => -10000, package => cf::mapsupport::;	724	cf::map->attach (prio => -10000, package => cf::mapsupport::);
700		725
701	#############################################################################	726	#############################################################################
702	# load/save perl data associated with player->ob objects	727	# load/save perl data associated with player->ob objects
703		728
704	sub all_objects(@) {	729	sub all_objects(@) {
705	@_, map all_objects ($_->inv), @_	730	@_, map all_objects ($_->inv), @_
706	}	731	}
707		732
708	attach_to_players	733	# TODO: compatibility cruft, remove when no longer needed
		734	cf::player->attach (
709	on_load => sub {	735	on_load => sub {
710	my ($pl, $path) = @_;	736	my ($pl, $path) = @_;
711		737
712	for my $o (all_objects $pl->ob) {	738	for my $o (all_objects $pl->ob) {
713	if (my $value = $o->get_ob_key_value ("_perl_data")) {	739	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
715		741
716	%$o = %{ Storable::thaw pack "H*", $value };	742	%$o = %{ Storable::thaw pack "H*", $value };
717	}	743	}
718	}	744	}
719	},	745	},
720	;	746	);
721		747
722	#############################################################################	748	#############################################################################
723	# 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
724		757
725	=item cf::player::exists $login	758	=item cf::player::exists $login
726		759
727	Returns true when the given account exists.	760	Returns true when the given account exists.
728		761
…		…
731	sub cf::player::exists($) {	764	sub cf::player::exists($) {
732	cf::player::find $_[0]	765	cf::player::find $_[0]
733	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;
734	}	767	}
735		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
736	=item $player->reply ($npc, $msg[, $flags])	789	=item $player_object->reply ($npc, $msg[, $flags])
737		790
738	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>
739	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
740	dialogue with the given NPC character.	793	dialogue with the given NPC character.
741		794
742	=cut	795	=cut
743		796
744	# rough implementation of a future "reply" method that works	797	# rough implementation of a future "reply" method that works
745	# with dialog boxes.	798	# with dialog boxes.
		799	#TODO: the first argument must go, split into a $npc->reply_to ( method
746	sub cf::object::player::reply($$$;$) {	800	sub cf::object::player::reply($$$;$) {
747	my ($self, $npc, $msg, $flags) = @_;	801	my ($self, $npc, $msg, $flags) = @_;
748		802
749	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	803	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
750		804
…		…
754	$msg = $npc->name . " says: $msg" if $npc;	808	$msg = $npc->name . " says: $msg" if $npc;
755	$self->message ($msg, $flags);	809	$self->message ($msg, $flags);
756	}	810	}
757	}	811	}
758		812
759	=item $player->ext_reply ($msgid, $msgtype, %msg)	813	=item $player_object->may ("access")
760		814
761	Sends an ext reply to the player.	815	Returns wether the given player is authorized to access resource "access"
		816	(e.g. "command_wizcast").
762		817
763	=cut	818	=cut
764		819
765	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 {
766	my ($self, $id, %msg) = @_;	906	my ($self, $cb) = @_;
767		907
768	$msg{msgid} = $id;	908	my $coro; $coro = async {
		909	eval {
		910	$cb->();
		911	};
		912	warn $@ if $@;
		913	delete $self->{_coro}{$coro+0};
		914	};
769		915
770	$self->send ("ext " . to_json \%msg);	916	$self->{_coro}{$coro+0} = $coro;
771	}	917	}
772		918
773	#############################################################################	919	cf::client->attach (
774	# 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
775		939
776	our $safe = new Safe "safe";	940	our $safe = new Safe "safe";
777	our $safe_hole = new Safe::Hole;	941	our $safe_hole = new Safe::Hole;
778		942
779	$SIG{FPE} = 'IGNORE';	943	$SIG{FPE} = 'IGNORE';
780		944
781	$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));
782		946
783	# here we export the classes and methods available to script code	947	# here we export the classes and methods available to script code
784		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
785	for (	960	for (
786	["cf::object" => qw(contr pay_amount pay_player)],	961	["cf::object" => qw(contr pay_amount pay_player map)],
787	["cf::object::player" => qw(player)],	962	["cf::object::player" => qw(player)],
788	["cf::player" => qw(peaceful)],	963	["cf::player" => qw(peaceful)],
		964	["cf::map" => qw(trigger)],
789	) {	965	) {
790	no strict 'refs';	966	no strict 'refs';
791	my ($pkg, @funs) = @$_;	967	my ($pkg, @funs) = @$_;
792	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	968	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
793	for @funs;	969	for @funs;
794	}	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
795		983
796	sub safe_eval($;@) {	984	sub safe_eval($;@) {
797	my ($code, %vars) = @_;	985	my ($code, %vars) = @_;
798		986
799	my $qcode = $code;	987	my $qcode = $code;
…		…
822	}	1010	}
823		1011
824	wantarray ? @res : $res[0]	1012	wantarray ? @res : $res[0]
825	}	1013	}
826		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
827	sub register_script_function {	1030	sub register_script_function {
828	my ($fun, $cb) = @_;	1031	my ($fun, $cb) = @_;
829		1032
830	no strict 'refs';	1033	no strict 'refs';
831	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1034	*{"safe::$fun"} = $safe_hole->wrap ($cb);
832	}	1035	}
833		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
834	#############################################################################	1146	#############################################################################
835	# the server's main()	1147	# the server's main()
836		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
837	sub main {	1157	sub main {
		1158	cfg_load;
		1159	db_load;
		1160	load_extensions;
838	Event::loop;	1161	Event::loop;
839	}	1162	}
840		1163
841	#############################################################################	1164	#############################################################################
842	# initialisation	1165	# initialisation
843		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
844	register "<global>", __PACKAGE__;	1246	register "<global>", __PACKAGE__;
845		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
846	unshift @INC, $LIBDIR;	1259	unshift @INC, $LIBDIR;
847		1260
848	load_extensions;
849
850	$TICK_WATCHER = Event->timer (	1261	$TICK_WATCHER = Event->timer (
851	prio => 1,	1262	prio => 0,
852	at => $NEXT_TICK || 1,	1263	at => $NEXT_TICK || 1,
		1264	data => WF_AUTOCANCEL,
853	cb => sub {	1265	cb => sub {
854	cf::server_tick; # one server iteration	1266	cf::server_tick; # one server iteration
855		1267
856	my $NOW = Event::time;	1268	my $NOW = Event::time;
857	$NEXT_TICK += $TICK;	1269	$NEXT_TICK += $TICK;
858		1270
859	# if we are delayed by four ticks, skip them all	1271	# if we are delayed by four ticks or more, skip them all
860	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1272	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
861		1273
862	$TICK_WATCHER->at ($NEXT_TICK);	1274	$TICK_WATCHER->at ($NEXT_TICK);
863	$TICK_WATCHER->start;	1275	$TICK_WATCHER->start;
864	},	1276	},
865	);	1277	);
866		1278
867	_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);
868		1286
869	1	1287	1
870		1288

Diff Legend

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