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.40 by root, Fri Aug 25 15:21:57 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 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
		28	$Coro::main->prio (Coro::PRIO_MIN);
		29
		30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		31
16	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
17	our @EVENT;	36	our @EVENT;
18	our @PLUGIN_EVENT;	37	our $LIBDIR = datadir . "/ext";
19	our %PROP_TYPE;
20	our %PROP_IDX;
21	our $LIBDIR = maps_directory "perl";
22		38
23	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
24	our $TICK_WATCHER;	40	our $TICK_WATCHER;
25	our $NEXT_TICK;	41	our $NEXT_TICK;
26		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
		74
27	BEGIN {	75	BEGIN {
28	@PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30	*CORE::GLOBAL::warn = sub {	76	*CORE::GLOBAL::warn = sub {
31	my $msg = join "", @_;	77	my $msg = join "", @_;
32	$msg .= "\n"	78	$msg .= "\n"
33	unless $msg =~ /\n$/;	79	unless $msg =~ /\n$/;
34		80
35	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
36	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
37	};	83	};
38	}	84	}
39		85
40	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	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';
		91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
41		92
42	# generate property mutators	93	# we bless all objects into (empty) derived classes to force a method lookup
43	sub prop_gen {	94	# within the Safe compartment.
44	my ($prefix, $class) = @_;	95	for my $pkg (qw(
45		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	)) {
46	no strict 'refs';	102	no strict 'refs';
47
48	for my $prop (keys %PROP_TYPE) {
49	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
50	my $sub = lc $1;
51
52	my $type = $PROP_TYPE{$prop};
53	my $idx = $PROP_IDX {$prop};
54
55	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
56	$_[0]->get_property ($type, $idx)
57	};
58
59	*{"$class\::set_$sub"} = sub {
60	$_[0]->set_property ($type, $idx, $_[1]);
61	} unless $ignore_set{$prop};
62	}
63	}
64
65	# auto-generate most of the API
66
67	prop_gen OBJECT_PROP => "cf::object";
68	# CFAPI_OBJECT_ANIMATION?
69	prop_gen PLAYER_PROP => "cf::object::player";
70
71	prop_gen MAP_PROP => "cf::map";
72	prop_gen ARCH_PROP => "cf::arch";
73
74	# guessed hierarchies
75
76	@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
77	@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78
79	# we bless all objects into derived classes to force a method lookup
80	# within the Safe compartment.
81	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
82	no strict 'refs';
83	@{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	104	}
85		105
86	$Event::DIED = sub {	106	$Event::DIED = sub {
87	warn "error in event callback: @_";	107	warn "error in event callback: @_";
88	};	108	};
89		109
90	my %ext_pkg;	110	my %ext_pkg;
91	my @exts;	111	my @exts;
92	my @hook;	112	my @hook;
93	my %command;	113
94	my %extcmd;	114	=head2 UTILITY FUNCTIONS
		115
		116	=over 4
		117
		118	=cut
		119
		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
		127
		128	sub from_json($) {
		129	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
		130	JSON::Syck::Load $_[0]
		131	}
		132
		133	=item $json = cf::to_json $ref
		134
		135	Converts a perl data structure into its JSON representation.
		136
		137	=cut
		138
		139	sub to_json($) {
		140	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
		141	JSON::Syck::Dump $_[0]
		142	}
		143
		144	=back
		145
		146	=cut
95		147
96	#############################################################################	148	#############################################################################
97	# "new" plug-in system
98		149
99	=item cf::object::attach ... # NYI	150	=head2 ATTACHABLE OBJECTS
100		151
101	=item cf::attach_global ...	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.
102		155
103	=item cf::attach_to_type ...	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+).
104		159
105	=item cf::attach_to_objects ...	160	=over 4
106		161
107	=item cf::attach_to_players ...	162	=item $attachable->attach ($attachment, key => $value...)
108		163
109	=item cf::attach_to_maps ...	164	=item $attachable->detach ($attachment)
110		165
111	prio => $number, # lower is earlier	166	Attach/detach a pre-registered attachment to a specific object and give it
112	on_xxx => \&cb,	167	the specified key/value pairs as arguments.
		168
		169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
		171
		172	$obj->attach (minesweeper => width => 10, height => 10);
		173
		174	=item $bool = $attachable->attached ($name)
		175
		176	Checks wether the named attachment is currently attached to the object.
		177
		178	=item cf::CLASS->attach ...
		179
		180	=item cf::CLASS->detach ...
		181
		182	Define an anonymous attachment and attach it to all objects of the given
		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:
		216
		217	=over 4
		218
		219	=item prio => $number
		220
		221	Set the priority for all following handlers/hooks (unless overwritten
		222	by another C<prio> setting). Lower priority handlers get executed
		223	earlier. The default priority is C<0>, and many built-in handlers are
		224	registered at priority C<-1000>, so lower priorities should not be used
		225	unless you know what you are doing.
		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
		233	=item on_I<event> => \&cb
		234
		235	Call the given code reference whenever the named event happens (event is
		236	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		237	handlers are recognised generally depends on the type of object these
		238	handlers attach to).
		239
		240	See F<include/eventinc.h> for the full list of events supported, and their
		241	class.
		242
113	package => package::,	243	=item package => package::
		244
		245	Look for sub functions of the name C<< on_I<event> >> in the given
		246	package and register them. Only handlers for eevents supported by the
		247	object/class are recognised.
		248
		249	=back
		250
		251	Example, define an attachment called "sockpuppet" that calls the given
		252	event handler when a monster attacks:
		253
		254	cf::object::attachment sockpuppet =>
		255	on_skill_attack => sub {
		256	my ($self, $victim) = @_;
		257	...
		258	}
		259	}
		260
		261	=item $attachable->valid
		262
		263	Just because you have a perl object does not mean that the corresponding
		264	C-level object still exists. If you try to access an object that has no
		265	valid C counterpart anymore you get an exception at runtime. This method
		266	can be used to test for existence of the C object part without causing an
		267	exception.
114		268
115	=cut	269	=cut
116		270
117	# the following variables are defined in .xs and must not be re-created	271	# the following variables are defined in .xs and must not be re-created
118	our @CB_GLOBAL = (); # registry for all global events	272	our @CB_GLOBAL = (); # registry for all global events
119	our @CB_OBJECT = ();	273	our @CB_ATTACHABLE = (); # registry for all attachables
		274	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
120	our @CB_PLAYER = ();	275	our @CB_PLAYER = ();
		276	our @CB_CLIENT = ();
121	our @CB_TYPE = (); # registry for type (cf-object class) based events	277	our @CB_TYPE = (); # registry for type (cf-object class) based events
122	our @CB_MAP = ();	278	our @CB_MAP = ();
123		279
		280	my %attachment;
		281
124	sub _attach_cb($\%$$$) {	282	sub _attach_cb($$$$) {
125	my ($registry, $undo, $event, $prio, $cb) = @_;	283	my ($registry, $event, $prio, $cb) = @_;
126		284
127	use sort 'stable';	285	use sort 'stable';
128		286
129	$cb = [$prio, $cb];	287	$cb = [$prio, $cb];
130		288
131	@{$registry->[$event]} = sort	289	@{$registry->[$event]} = sort
132	{ $a->[0] cmp $b->[0] }	290	{ $a->[0] cmp $b->[0] }
133	@{$registry->[$event] || []}, $cb;	291	@{$registry->[$event] || []}, $cb;
134
135	push @{$undo->{cb}}, [$event, $cb];
136	}	292	}
		293
		294	# hack
		295	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
137		296
138	# attach handles attaching event callbacks	297	# attach handles attaching event callbacks
139	# the only thing the caller has to do is pass the correct	298	# the only thing the caller has to do is pass the correct
140	# registry (== where the callback attaches to).	299	# registry (== where the callback attaches to).
141	sub _attach(\@$\@) {	300	sub _attach {
142	my ($registry, $klass, $arg) = @_;	301	my ($registry, $klass, @arg) = @_;
143		302
		303	my $object_type;
144	my $prio = 0;	304	my $prio = 0;
145
146	my %undo = (
147	registry => $registry,
148	cb => [],
149	);
150
151	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	305	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
152		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
153	while (@$arg) {	312	while (@arg) {
154	my $type = shift @$arg;	313	my $type = shift @arg;
155		314
156	if ($type eq "prio") {	315	if ($type eq "prio") {
157	$prio = shift @$arg;	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] ||= [];
158		326
159	} elsif ($type eq "package") {	327	} elsif ($type eq "package") {
160	my $pkg = shift @$arg;	328	my $pkg = shift @arg;
161		329
162	while (my ($name, $id) = each %cb_id) {	330	while (my ($name, $id) = each %cb_id) {
163	if (my $cb = $pkg->can ($name)) {	331	if (my $cb = $pkg->can ($name)) {
164	_attach_cb $registry, %undo, $id, $prio, $cb;	332	_attach_cb $registry, $id, $prio, $cb;
165	}	333	}
166	}	334	}
167		335
168	} elsif (exists $cb_id{$type}) {	336	} elsif (exists $cb_id{$type}) {
169	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;	337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
170		338
171	} elsif (ref $type) {	339	} elsif (ref $type) {
172	warn "attaching objects not supported, ignoring.\n";	340	warn "attaching objects not supported, ignoring.\n";
173		341
174	} else {	342	} else {
175	shift @$arg;	343	shift @arg;
176	warn "attach argument '$type' not supported, ignoring.\n";	344	warn "attach argument '$type' not supported, ignoring.\n";
177	}	345	}
178	}	346	}
179
180	\%undo
181	}	347	}
182		348
183	sub cf::object::attach {	349	sub _object_attach {
184	die;	350	my ($obj, $name, %arg) = @_;
185	}
186		351
187	sub attach_global {	352	return if exists $obj->{_attachment}{$name};
188	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
189	}
190		353
191	sub attach_to_type {	354	if (my $attach = $attachment{$name}) {
192	my $type = shift;	355	my $registry = $obj->registry;
193	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
194	}
195		356
196	sub attach_to_objects {	357	for (@$attach) {
197	_attach @CB_OBJECT, KLASS_OBJECT, @_	358	my ($klass, @attach) = @$_;
198	}	359	_attach $registry, $klass, @attach;
		360	}
199		361
200	sub attach_to_players {	362	$obj->{$name} = \%arg;
201	_attach @CB_PLAYER, KLASS_PLAYER, @_	363	} else {
202	}	364	warn "object uses attachment '$name' that is not available, postponing.\n";
		365	}
203		366
204	sub attach_to_maps {	367	$obj->{_attachment}{$name} = undef;
205	_attach @CB_MAP, KLASS_MAP, @_	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 $@;
206	}	409	}
207		410
208	our $override;	411	our $override;
		412	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
209		413
210	sub override() {	414	sub override {
211	$override = 1	415	$override = 1;
		416	@invoke_results = ();
212	}	417	}
213		418
214	sub invoke {	419	sub do_invoke {
215	my $event = shift;	420	my $event = shift;
216	my $callbacks = shift;	421	my $callbacks = shift;
217		422
		423	@invoke_results = ();
		424
218	local $override;	425	local $override;
219		426
220	for (@$callbacks) {	427	for (@$callbacks) {
221	eval { &{$_->[1]} };	428	eval { &{$_->[1]} };
222		429
223	if ($@) {	430	if ($@) {
224	warn "$@";	431	warn "$@";
225	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
226	override;	433	override;
227	}	434	}
228		435
229	return 1 if $override;	436	return 1 if $override;
230	}	437	}
231		438
232	0	439	0
233	}	440	}
234		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
		452	=back
		453
		454	=cut
		455
235	#############################################################################	456	#############################################################################
236	# old plug-in events	457	# object support
237		458
238	sub inject_event {	459	cf::attachable->attach (
239	my $extension = shift;	460	prio => -1000000,
240	my $event_code = shift;	461	on_instantiate => sub {
		462	my ($obj, $data) = @_;
241		463
242	my $cb = $hook[$event_code]{$extension}	464	$data = from_json $data;
243	or return;
244		465
245	&$cb	466	for (@$data) {
246	}	467	my ($name, $args) = @$_;
247		468
248	sub inject_global_event {	469	$obj->attach ($name, %{$args || {} });
249	my $event = shift;	470	}
250
251	my $cb = $hook[$event]
252	or return;
253
254	List::Util::max map &$_, values %$cb
255	}
256
257	sub inject_command {
258	my ($name, $obj, $params) = @_;
259
260	for my $cmd (@{ $command{$name} }) {
261	$cmd->[1]->($obj, $params);
262	}	471	},
		472	on_reattach => sub {
		473	# basically do the same as instantiate, without calling instantiate
		474	my ($obj) = @_;
		475	my $registry = $obj->registry;
263		476
264	-1	477	@$registry = ();
		478
		479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		480
		481	for my $name (keys %{ $obj->{_attachment} || {} }) {
		482	if (my $attach = $attachment{$name}) {
		483	for (@$attach) {
		484	my ($klass, @attach) = @$_;
		485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
		489	}
		490	}
		491	},
		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	);
		503
		504	sub object_freezer_save {
		505	my ($filename, $rdata, $objs) = @_;
		506
		507	if (length $$rdata) {
		508	warn sprintf "saving %s (%d,%d)\n",
		509	$filename, length $$rdata, scalar @$objs;
		510
		511	if (open my $fh, ">:raw", "$filename~") {
		512	chmod SAVE_MODE, $fh;
		513	syswrite $fh, $$rdata;
		514	close $fh;
		515
		516	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		517	chmod SAVE_MODE, $fh;
		518	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		519	close $fh;
		520	rename "$filename.pst~", "$filename.pst";
		521	} else {
		522	unlink "$filename.pst";
		523	}
		524
		525	rename "$filename~", $filename;
		526	} else {
		527	warn "FATAL: $filename~: $!\n";
		528	}
		529	} else {
		530	unlink $filename;
		531	unlink "$filename.pst";
		532	}
265	}	533	}
		534
		535	sub object_freezer_as_string {
		536	my ($rdata, $objs) = @_;
		537
		538	use Data::Dumper;
		539
		540	$$rdata . Dumper $objs
		541	}
		542
		543	sub object_thawer_load {
		544	my ($filename) = @_;
		545
		546	local $/;
		547
		548	my $av;
		549
		550	#TODO: use sysread etc.
		551	if (open my $data, "<:raw:perlio", $filename) {
		552	$data = <$data>;
		553	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		554	$av = eval { (Storable::thaw <$pst>)->{objs} };
		555	}
		556	return ($data, $av);
		557	}
		558
		559	()
		560	}
		561
		562	#############################################################################
		563	# command handling &c
		564
		565	=item cf::register_command $name => \&callback($ob,$args);
		566
		567	Register a callback for execution when the client sends the user command
		568	$name.
		569
		570	=cut
266		571
267	sub register_command {	572	sub register_command {
268	my ($name, $time, $cb) = @_;	573	my ($name, $cb) = @_;
269		574
270	my $caller = caller;	575	my $caller = caller;
271	#warn "registering command '$name/$time' to '$caller'";	576	#warn "registering command '$name/$time' to '$caller'";
272		577
273	push @{ $command{$name} }, [$time, $cb, $caller];	578	push @{ $COMMAND{$name} }, [$caller, $cb];
274	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
275	}	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
276		589
277	sub register_extcmd {	590	sub register_extcmd {
278	my ($name, $cb) = @_;	591	my ($name, $cb) = @_;
279		592
280	my $caller = caller;	593	my $caller = caller;
281	#warn "registering extcmd '$name' to '$caller'";	594	#warn "registering extcmd '$name' to '$caller'";
282		595
283	$extcmd{$name} = [$cb, $caller];	596	$EXTCMD{$name} = [$cb, $caller];
284	}	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	);
285		630
286	sub register {	631	sub register {
287	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
288		633
289	for my $idx (0 .. $#PLUGIN_EVENT) {	634	#TODO
290	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
291	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
292	$hook[$idx]{$base} = $ref;
293	}
294	}
295	}	635	}
296		636
297	sub load_extension {	637	sub load_extension {
298	my ($path) = @_;	638	my ($path) = @_;
299		639
300	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	640	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
301	my $base = $1;	641	my $base = $1;
302	my $pkg = $1;	642	my $pkg = $1;
303	$pkg =~ s/[^[:word:]]/_/g;	643	$pkg =~ s/[^[:word:]]/_/g;
304	$pkg = "cf::ext::$pkg";	644	$pkg = "ext::$pkg";
305		645
306	warn "loading '$path' into '$pkg'\n";	646	warn "loading '$path' into '$pkg'\n";
307		647
308	open my $fh, "<:utf8", $path	648	open my $fh, "<:utf8", $path
309	or die "$path: $!";	649	or die "$path: $!";
…		…
313	. "#line 1 \"$path\"\n{\n"	653	. "#line 1 \"$path\"\n{\n"
314	. (do { local $/; <$fh> })	654	. (do { local $/; <$fh> })
315	. "\n};\n1";	655	. "\n};\n1";
316		656
317	eval $source	657	eval $source
318	or die "$path: $@";	658	or die $@ ? "$path: $@\n"
		659	: "extension disabled.\n";
319		660
320	push @exts, $pkg;	661	push @exts, $pkg;
321	$ext_pkg{$base} = $pkg;	662	$ext_pkg{$base} = $pkg;
322		663
323	# no strict 'refs';	664	# no strict 'refs';
…		…
330	my ($pkg) = @_;	671	my ($pkg) = @_;
331		672
332	warn "removing extension $pkg\n";	673	warn "removing extension $pkg\n";
333		674
334	# remove hooks	675	# remove hooks
		676	#TODO
335	for my $idx (0 .. $#PLUGIN_EVENT) {	677	# for my $idx (0 .. $#PLUGIN_EVENT) {
336	delete $hook[$idx]{$pkg};	678	# delete $hook[$idx]{$pkg};
337	}	679	# }
338		680
339	# remove commands	681	# remove commands
340	for my $name (keys %command) {	682	for my $name (keys %COMMAND) {
341	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
342		684
343	if (@cb) {	685	if (@cb) {
344	$command{$name} = \@cb;	686	$COMMAND{$name} = \@cb;
345	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
346	} else {	687	} else {
347	delete $command{$name};
348	delete $COMMAND{"$name\000"};	688	delete $COMMAND{$name};
349	}	689	}
350	}	690	}
351		691
352	# remove extcmds	692	# remove extcmds
353	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
354	delete $extcmd{$name};	694	delete $EXTCMD{$name};
355	}	695	}
356		696
357	if (my $cb = $pkg->can ("on_unload")) {	697	if (my $cb = $pkg->can ("unload")) {
358	eval {	698	eval {
359	$cb->($pkg);	699	$cb->($pkg);
360	1	700	1
361	} or warn "$pkg unloaded, but with errors: $@";	701	} or warn "$pkg unloaded, but with errors: $@";
362	}	702	}
363		703
364	Symbol::delete_package $pkg;	704	Symbol::delete_package $pkg;
365	}	705	}
366		706
367	sub load_extensions {	707	sub load_extensions {
368	my $LIBDIR = maps_directory "perl";
369
370	for my $ext (<$LIBDIR/*.ext>) {	708	for my $ext (<$LIBDIR/*.ext>) {
371	next unless -r $ext;	709	next unless -r $ext;
372	eval {	710	eval {
373	load_extension $ext;	711	load_extension $ext;
374	1	712	1
375	} or warn "$ext not loaded: $@";	713	} or warn "$ext not loaded: $@";
376	}	714	}
377	}	715	}
378		716
379	sub _perl_reload(&) {
380	my ($msg) = @_;
381
382	$msg->("reloading...");
383
384	eval {
385	# 1. cancel all watchers
386	$_->cancel for Event::all_watchers;
387
388	# 2. unload all extensions
389	for (@exts) {
390	$msg->("unloading <$_>");
391	unload_extension $_;
392	}
393
394	# 3. unload all modules loaded from $LIBDIR
395	while (my ($k, $v) = each %INC) {
396	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
397
398	$msg->("removing <$k>");
399	delete $INC{$k};
400
401	$k =~ s/\.pm$//;
402	$k =~ s/\//::/g;
403
404	if (my $cb = $k->can ("unload_module")) {
405	$cb->();
406	}
407
408	Symbol::delete_package $k;
409	}
410
411	# 4. get rid of ext::, as good as possible
412	Symbol::delete_package "ext::$_"
413	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
414
415	# 5. remove register_script_function callbacks
416	# TODO
417
418	# 6. unload cf.pm "a bit"
419	delete $INC{"cf.pm"};
420
421	# don't, removes xs symbols, too
422	#Symbol::delete_package __PACKAGE__;
423
424	# 7. reload cf.pm
425	$msg->("reloading cf.pm");
426	require cf;
427	};
428	$msg->($@) if $@;
429
430	$msg->("reloaded");
431	};
432
433	sub perl_reload() {
434	_perl_reload {
435	warn $_[0];
436	print "$_[0]\n";
437	};
438	}
439
440	register_command "perl-reload", 0, sub {
441	my ($who, $arg) = @_;
442
443	if ($who->flag (FLAG_WIZ)) {
444	_perl_reload {
445	warn $_[0];
446	$who->message ($_[0]);
447	};
448	}
449	};
450
451	#############################################################################
452	# utility functions
453
454	use JSON::Syck (); # TODO# replace by JSON::PC once working
455
456	sub from_json($) {
457	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
458	JSON::Syck::Load $_[0]
459	}
460
461	sub to_json($) {
462	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
463	JSON::Syck::Dump $_[0]
464	}
465
466	#############################################################################
467	# extcmd framework, basically convert ext <msg>
468	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
469
470	sub on_extcmd {
471	my ($pl, $buf) = @_;
472
473	my $msg = eval { from_json $buf };
474
475	if (ref $msg) {
476	if (my $cb = $extcmd{$msg->{msgtype}}) {
477	if (my %reply = $cb->[0]->($pl, $msg)) {
478	$pl->ext_reply ($msg->{msgid}, %reply);
479	}
480	}
481	} else {
482	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
483	}
484
485	1
486	}
487
488	#############################################################################	717	#############################################################################
489	# load/save/clean perl data associated with a map	718	# load/save/clean perl data associated with a map
490		719
491	*cf::mapsupport::on_clean = sub {	720	*cf::mapsupport::on_clean = sub {
492	my ($map) = @_;	721	my ($map) = @_;
493		722
494	my $path = $map->tmpname;	723	my $path = $map->tmpname;
495	defined $path or return;	724	defined $path or return;
496		725
497	unlink "$path.cfperl";	726	unlink "$path.pst";
498	};	727	};
499		728
500	*cf::mapsupport::on_swapin =
501	*cf::mapsupport::on_load = sub {
502	my ($map) = @_;
503
504	my $path = $map->tmpname;
505	$path = $map->path unless defined $path;
506
507	open my $fh, "<:raw", "$path.cfperl"
508	or return; # no perl data
509
510	my $data = Storable::thaw do { local $/; <$fh> };
511
512	$data->{version} <= 1
513	or return; # too new
514
515	$map->_set_obs ($data->{obs});
516	};
517
518	*cf::mapsupport::on_swapout = sub {
519	my ($map) = @_;
520
521	my $path = $map->tmpname;
522	$path = $map->path unless defined $path;
523
524	my $obs = $map->_get_obs;
525
526	if (defined $obs) {
527	open my $fh, ">:raw", "$path.cfperl"
528	or die "$path.cfperl: $!";
529
530	stat $path;
531
532	print $fh Storable::nfreeze {
533	size => (stat _)[7],
534	time => (stat _)[9],
535	version => 1,
536	obs => $obs,
537	};
538
539	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
540	} else {
541	unlink "$path.cfperl";
542	}
543	};
544
545	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
546		730
547	#############################################################################	731	#############################################################################
548	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
549		733
550	sub all_objects(@) {	734	sub all_objects(@) {
551	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
552	}	736	}
553		737
554	attach_to_players	738	# TODO: compatibility cruft, remove when no longer needed
		739	cf::player->attach (
555	on_load => sub {	740	on_load => sub {
556	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
557		742
558	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
559	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
561		746
562	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
563	}	748	}
564	}	749	}
565	},	750	},
566	on_save => sub {	751	);
567	my ($pl, $path) = @_;
568
569	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
570	for grep %$_, all_objects $pl->ob;
571	},
572	;
573		752
574	#############################################################################	753	#############################################################################
575	# 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
576		762
577	=item cf::player::exists $login	763	=item cf::player::exists $login
578		764
579	Returns true when the given account exists.	765	Returns true when the given account exists.
580		766
…		…
583	sub cf::player::exists($) {	769	sub cf::player::exists($) {
584	cf::player::find $_[0]	770	cf::player::find $_[0]
585	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;
586	}	772	}
587		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
588	=item $player->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
589		795
590	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>
591	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
592	dialogue with the given NPC character.	798	dialogue with the given NPC character.
593		799
594	=cut	800	=cut
595		801
596	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
597	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
598	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
599	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
600		807
601	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
602		809
…		…
606	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
607	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
608	}	815	}
609	}	816	}
610		817
611	=item $player->ext_reply ($msgid, $msgtype, %msg)	818	=item $player_object->may ("access")
612		819
613	Sends an ext reply to the player.	820	Returns wether the given player is authorized to access resource "access"
		821	(e.g. "command_wizcast").
614		822
615	=cut	823	=cut
616		824
617	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 {
618	my ($self, $id, %msg) = @_;	911	my ($self, $cb) = @_;
619		912
620	$msg{msgid} = $id;	913	my $coro; $coro = async {
		914	eval {
		915	$cb->();
		916	};
		917	warn $@ if $@;
		918	delete $self->{_coro}{$coro+0};
		919	};
621		920
622	$self->send ("ext " . to_json \%msg);	921	$self->{_coro}{$coro+0} = $coro;
623	}	922	}
624		923
625	#############################################################################	924	cf::client->attach (
626	# map scripting support	925	on_destroy => sub {
		926	my ($ns) = @_;
627		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
		944
628	our $safe = new Safe "ext";	945	our $safe = new Safe "safe";
629	our $safe_hole = new Safe::Hole;	946	our $safe_hole = new Safe::Hole;
630		947
631	$SIG{FPE} = 'IGNORE';	948	$SIG{FPE} = 'IGNORE';
632		949
633	$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));
634		951
635	# here we export the classes and methods available to script code	952	# here we export the classes and methods available to script code
636		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
637	for (	965	for (
638	["cf::object" => qw(contr pay_amount pay_player)],	966	["cf::object" => qw(contr pay_amount pay_player map)],
639	["cf::object::player" => qw(player)],	967	["cf::object::player" => qw(player)],
640	["cf::player" => qw(peaceful)],	968	["cf::player" => qw(peaceful)],
		969	["cf::map" => qw(trigger)],
641	) {	970	) {
642	no strict 'refs';	971	no strict 'refs';
643	my ($pkg, @funs) = @$_;	972	my ($pkg, @funs) = @$_;
644	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
645	for @funs;	974	for @funs;
646	}	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
647		988
648	sub safe_eval($;@) {	989	sub safe_eval($;@) {
649	my ($code, %vars) = @_;	990	my ($code, %vars) = @_;
650		991
651	my $qcode = $code;	992	my $qcode = $code;
652	$qcode =~ s/"/‟/g; # not allowed in #line filenames	993	$qcode =~ s/"/‟/g; # not allowed in #line filenames
653	$qcode =~ s/\n/\\n/g;	994	$qcode =~ s/\n/\\n/g;
654		995
655	local $_;	996	local $_;
656	local @ext::cf::_safe_eval_args = values %vars;	997	local @safe::cf::_safe_eval_args = values %vars;
657		998
658	$code =	999	my $eval =
659	"do {\n"	1000	"do {\n"
660	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	1001	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
661	. "#line 0 \"{$qcode}\"\n"	1002	. "#line 0 \"{$qcode}\"\n"
662	. $code	1003	. $code
663	. "\n}"	1004	. "\n}"
664	;	1005	;
665		1006
666	sub_generation_inc;	1007	sub_generation_inc;
667	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	1008	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
668	sub_generation_inc;	1009	sub_generation_inc;
669		1010
		1011	if ($@) {
		1012	warn "$@";
		1013	warn "while executing safe code '$code'\n";
		1014	warn "with arguments " . (join " ", %vars) . "\n";
		1015	}
		1016
670	wantarray ? @res : $res[0]	1017	wantarray ? @res : $res[0]
671	}	1018	}
		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
672		1034
673	sub register_script_function {	1035	sub register_script_function {
674	my ($fun, $cb) = @_;	1036	my ($fun, $cb) = @_;
675		1037
676	no strict 'refs';	1038	no strict 'refs';
677	*{"ext::$fun"} = $safe_hole->wrap ($cb);	1039	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		1040	}
		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	);
678	}	1149	}
679		1150
680	#############################################################################	1151	#############################################################################
681	# the server's main()	1152	# the server's main()
682		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
683	sub main {	1162	sub main {
		1163	cfg_load;
		1164	db_load;
		1165	load_extensions;
684	Event::loop;	1166	Event::loop;
685	}	1167	}
686		1168
687	#############################################################################	1169	#############################################################################
688	# initialisation	1170	# initialisation
689		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
		1229	# load config and database again
		1230	cf::cfg_load;
		1231	cf::db_load;
		1232
		1233	# load extensions
		1234	$msg->("load extensions");
		1235	cf::load_extensions;
		1236
		1237	# reattach attachments to objects
		1238	$msg->("reattach");
		1239	_global_reattach;
		1240	};
		1241	$msg->($@) if $@;
		1242
		1243	$msg->("reloaded");
		1244	};
		1245
		1246	sub perl_reload() {
		1247	_perl_reload {
		1248	warn $_[0];
		1249	print "$_[0]\n";
		1250	};
		1251	}
		1252
690	register "<global>", __PACKAGE__;	1253	register "<global>", __PACKAGE__;
691		1254
		1255	register_command "perl-reload" => sub {
		1256	my ($who, $arg) = @_;
		1257
		1258	if ($who->flag (FLAG_WIZ)) {
		1259	_perl_reload {
		1260	warn $_[0];
		1261	$who->message ($_[0]);
		1262	};
		1263	}
		1264	};
		1265
692	unshift @INC, $LIBDIR;	1266	unshift @INC, $LIBDIR;
693		1267
694	load_extensions;
695
696	$TICK_WATCHER = Event->timer (	1268	$TICK_WATCHER = Event->timer (
697	prio => 1,	1269	prio => 0,
698	at => $NEXT_TICK || 1,	1270	at => $NEXT_TICK || 1,
		1271	data => WF_AUTOCANCEL,
699	cb => sub {	1272	cb => sub {
700	cf::server_tick; # one server iteration	1273	cf::server_tick; # one server iteration
701		1274
702	my $NOW = Event::time;	1275	my $NOW = Event::time;
703	$NEXT_TICK += $TICK;	1276	$NEXT_TICK += $TICK;
704		1277
705	# if we are delayed by four ticks, skip them all	1278	# if we are delayed by four ticks or more, skip them all
706	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1279	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
707		1280
708	$TICK_WATCHER->at ($NEXT_TICK);	1281	$TICK_WATCHER->at ($NEXT_TICK);
709	$TICK_WATCHER->start;	1282	$TICK_WATCHER->start;
710	},	1283	},
711	);	1284	);
712		1285
		1286	IO::AIO::max_poll_time $TICK * 0.2;
		1287
		1288	Event->io (fd => IO::AIO::poll_fileno,
		1289	poll => 'r',
		1290	prio => 5,
		1291	data => WF_AUTOCANCEL,
		1292	cb => \&IO::AIO::poll_cb);
		1293
713	1	1294	1
714		1295

Diff Legend

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