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

Diff Legend

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