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.95 by root, Fri Dec 22 02:04:20 2006 UTC

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

Diff Legend

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