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.39 by root, Fri Aug 25 13:24:50 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 ... # NYI	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 ... # NYI	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 ... # NYI	153	=over 4
106		154
107	=item cf::attach_to_players ... # NYI	155	=item $attachable->attach ($attachment, key => $value...)
108		156
109	=item cf::attach_to_maps ... # NYI	157	=item $attachable->detach ($attachment)
110		158
111	prio => $number, # higehr 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::
114		237
115	=cut	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.
116		241
117	our %CB_CLASS = (); # registry for class-based events	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	}
		253
		254	=cut
		255
		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
		258	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		259	our @CB_PLAYER = ();
		260	our @CB_CLIENT = ();
119	our @CB_TYPE = (); # registry for type (cf-object class) based events	261	our @CB_TYPE = (); # registry for type (cf-object class) based events
		262	our @CB_MAP = ();
120		263
		264	my %attachment;
		265
121	sub _attach_cb($\%$$$) {	266	sub _attach_cb($$$$) {
122	my ($registry, $undo, $event, $prio, $cb) = @_;	267	my ($registry, $event, $prio, $cb) = @_;
123		268
124	use sort 'stable';	269	use sort 'stable';
125		270
126	$cb = [$prio, $cb];	271	$cb = [$prio, $cb];
127		272
128	@{$registry->[$event]} = sort	273	@{$registry->[$event]} = sort
129	{ $a->[0] cmp $b->[0] }	274	{ $a->[0] cmp $b->[0] }
130	@{$registry->[$event] || []}, $cb;	275	@{$registry->[$event] || []}, $cb;
131
132	push @{$undo->{cb}}, [$event, $cb];
133	}	276	}
134		277
135	# attach handles attaching event callbacks	278	# attach handles attaching event callbacks
136	# 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
137	# registry (== where the callback attaches to).	280	# registry (== where the callback attaches to).
138	sub _attach(\@$\@) {	281	sub _attach {
139	my ($registry, $klass, $arg) = @_;	282	my ($registry, $klass, @arg) = @_;
140		283
		284	my $object_type;
141	my $prio = 0;	285	my $prio = 0;
142
143	my %undo = (
144	registry => $registry,
145	cb => [],
146	);
147
148	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;
149		287
150	while (@$arg) {	288	while (@arg) {
151	my $type = shift @$arg;	289	my $type = shift @arg;
152		290
153	if ($type eq "prio") {	291	if ($type eq "prio") {
154	$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] ||= [];
155		302
156	} elsif ($type eq "package") {	303	} elsif ($type eq "package") {
157	my $pkg = shift @$arg;	304	my $pkg = shift @arg;
158		305
159	while (my ($name, $id) = each %cb_id) {	306	while (my ($name, $id) = each %cb_id) {
160	if (my $cb = $pkg->can ($name)) {	307	if (my $cb = $pkg->can ($name)) {
161	_attach_cb $registry, %undo, $id, $prio, $cb;	308	_attach_cb $registry, $id, $prio, $cb;
162	}	309	}
163	}	310	}
164		311
165	} elsif (exists $cb_id{$type}) {	312	} elsif (exists $cb_id{$type}) {
166	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;	313	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
167		314
168	} elsif (ref $type) {	315	} elsif (ref $type) {
169	warn "attaching objects not supported, ignoring.\n";	316	warn "attaching objects not supported, ignoring.\n";
170		317
171	} else {	318	} else {
172	shift @$arg;	319	shift @arg;
173	warn "attach argument '$type' not supported, ignoring.\n";	320	warn "attach argument '$type' not supported, ignoring.\n";
174	}	321	}
175	}	322	}
176
177	\%undo
178	}	323	}
179		324
180	sub cf::object::attach {	325	sub _object_attach {
181	die;	326	my ($obj, $name, %arg) = @_;
182	}
183		327
184	sub attach_global {	328	return if exists $obj->{_attachment}{$name};
185	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
186	}
187		329
188	sub attach_type {	330	if (my $attach = $attachment{$name}) {
189	my $type = shift;	331	my $registry = $obj->registry;
190	_attach @{$CB_TYPE[$type]}, KLASS_MAP, @_
191	}
192		332
193	sub attach_to_objects {	333	for (@$attach) {
194	_attach @{$CB_CLASS{cf::object::wrap::}}, KLASS_OBJECT, @_	334	my ($klass, @attach) = @$_;
195	}	335	_attach $registry, $klass, @attach;
		336	}
196		337
197	sub attach_to_players {	338	$obj->{$name} = \%arg;
198	_attach @{$CB_CLASS{cf::player::wrap::}}, KLASS_PLAYER, @_	339	} else {
199	}	340	warn "object uses attachment '$name' that is not available, postponing.\n";
		341	}
200		342
201	sub attach_to_maps {	343	$obj->{_attachment}{$name} = undef;
202	_attach @{$CB_CLASS{cf::map::wrap::}}, 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 $@;
203	}	385	}
204		386
205	our $override;	387	our $override;
		388	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
206		389
207	sub override() {	390	sub override {
208	$override = 1	391	$override = 1;
		392	@invoke_results = ();
209	}	393	}
210		394
211	sub invoke {	395	sub do_invoke {
212	my $event = shift;	396	my $event = shift;
		397	my $callbacks = shift;
213		398
214	my @cb;	399	@invoke_results = ();
215
216	if (my $ref = ref $_[0]) {
217	# 1. object-specific (NYI)
218	# 2. class-specific
219	push @cb, @{$CB_CLASS{$ref}[$event] || []};
220	}
221
222	# global
223	push @cb, @{$CB_GLOBAL[$event] || []};
224
225	# warn "invoke id $EVENT[$event][0], args <@_> <=> @cb\n";#d#
226		400
227	local $override;	401	local $override;
228		402
229	for (@cb) {	403	for (@$callbacks) {
230	eval { &{$_->[1]} };	404	eval { &{$_->[1]} };
231		405
232	if ($@) {	406	if ($@) {
233	warn "$@";	407	warn "$@";
234	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	408	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
235	override;	409	override;
236	}	410	}
237		411
238	return 1 if $override;	412	return 1 if $override;
239	}	413	}
240		414
241	0	415	0
242	}	416	}
243		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
244	#############################################################################	438	#############################################################################
245	# old plug-in events
246		439
247	sub inject_event {	440	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
248	my $extension = shift;
249	my $event_code = shift;
250		441
251	my $cb = $hook[$event_code]{$extension}	442	Attachable objects includes objects, players, clients and maps.
252	or return;
253		443
254	&$cb	444	=over 4
255	}
256		445
257	sub inject_global_event {	446	=item $object->valid
258	my $event = shift;
259		447
260	my $cb = $hook[$event]	448	Just because you have a perl object does not mean that the corresponding
261	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.
262		453
263	List::Util::max map &$_, values %$cb	454	=back
264	}
265		455
266	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) {
267	my ($name, $obj, $params) = @_;	467	my ($name, $args) = @$_;
268		468
269	for my $cmd (@{ $command{$name} }) {	469	$obj->attach ($name, %{$args || {} });
270	$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};
271	}	563	},
		564	);
272		565
273	-1	566	#############################################################################
274	}	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
275		575
276	sub register_command {	576	sub register_command {
277	my ($name, $time, $cb) = @_;	577	my ($name, $cb) = @_;
278		578
279	my $caller = caller;	579	my $caller = caller;
280	#warn "registering command '$name/$time' to '$caller'";	580	#warn "registering command '$name/$time' to '$caller'";
281		581
282	push @{ $command{$name} }, [$time, $cb, $caller];	582	push @{ $COMMAND{$name} }, [$caller, $cb];
283	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
284	}	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
285		593
286	sub register_extcmd {	594	sub register_extcmd {
287	my ($name, $cb) = @_;	595	my ($name, $cb) = @_;
288		596
289	my $caller = caller;	597	my $caller = caller;
290	#warn "registering extcmd '$name' to '$caller'";	598	#warn "registering extcmd '$name' to '$caller'";
291		599
292	$extcmd{$name} = [$cb, $caller];	600	$EXTCMD{$name} = [$cb, $caller];
293	}	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	);
294		634
295	sub register {	635	sub register {
296	my ($base, $pkg) = @_;	636	my ($base, $pkg) = @_;
297		637
298	for my $idx (0 .. $#PLUGIN_EVENT) {	638	#TODO
299	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
300	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
301	$hook[$idx]{$base} = $ref;
302	}
303	}
304	}	639	}
305		640
306	sub load_extension {	641	sub load_extension {
307	my ($path) = @_;	642	my ($path) = @_;
308		643
309	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	644	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
310	my $base = $1;	645	my $base = $1;
311	my $pkg = $1;	646	my $pkg = $1;
312	$pkg =~ s/[^[:word:]]/_/g;	647	$pkg =~ s/[^[:word:]]/_/g;
313	$pkg = "cf::ext::$pkg";	648	$pkg = "ext::$pkg";
314		649
315	warn "loading '$path' into '$pkg'\n";	650	warn "loading '$path' into '$pkg'\n";
316		651
317	open my $fh, "<:utf8", $path	652	open my $fh, "<:utf8", $path
318	or die "$path: $!";	653	or die "$path: $!";
…		…
322	. "#line 1 \"$path\"\n{\n"	657	. "#line 1 \"$path\"\n{\n"
323	. (do { local $/; <$fh> })	658	. (do { local $/; <$fh> })
324	. "\n};\n1";	659	. "\n};\n1";
325		660
326	eval $source	661	eval $source
327	or die "$path: $@";	662	or die $@ ? "$path: $@\n"
		663	: "extension disabled.\n";
328		664
329	push @exts, $pkg;	665	push @exts, $pkg;
330	$ext_pkg{$base} = $pkg;	666	$ext_pkg{$base} = $pkg;
331		667
332	# no strict 'refs';	668	# no strict 'refs';
…		…
339	my ($pkg) = @_;	675	my ($pkg) = @_;
340		676
341	warn "removing extension $pkg\n";	677	warn "removing extension $pkg\n";
342		678
343	# remove hooks	679	# remove hooks
		680	#TODO
344	for my $idx (0 .. $#PLUGIN_EVENT) {	681	# for my $idx (0 .. $#PLUGIN_EVENT) {
345	delete $hook[$idx]{$pkg};	682	# delete $hook[$idx]{$pkg};
346	}	683	# }
347		684
348	# remove commands	685	# remove commands
349	for my $name (keys %command) {	686	for my $name (keys %COMMAND) {
350	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	687	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
351		688
352	if (@cb) {	689	if (@cb) {
353	$command{$name} = \@cb;	690	$COMMAND{$name} = \@cb;
354	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
355	} else {	691	} else {
356	delete $command{$name};
357	delete $COMMAND{"$name\000"};	692	delete $COMMAND{$name};
358	}	693	}
359	}	694	}
360		695
361	# remove extcmds	696	# remove extcmds
362	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	697	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
363	delete $extcmd{$name};	698	delete $EXTCMD{$name};
364	}	699	}
365		700
366	if (my $cb = $pkg->can ("on_unload")) {	701	if (my $cb = $pkg->can ("unload")) {
367	eval {	702	eval {
368	$cb->($pkg);	703	$cb->($pkg);
369	1	704	1
370	} or warn "$pkg unloaded, but with errors: $@";	705	} or warn "$pkg unloaded, but with errors: $@";
371	}	706	}
372		707
373	Symbol::delete_package $pkg;	708	Symbol::delete_package $pkg;
374	}	709	}
375		710
376	sub load_extensions {	711	sub load_extensions {
377	my $LIBDIR = maps_directory "perl";
378
379	for my $ext (<$LIBDIR/*.ext>) {	712	for my $ext (<$LIBDIR/*.ext>) {
380	next unless -r $ext;	713	next unless -r $ext;
381	eval {	714	eval {
382	load_extension $ext;	715	load_extension $ext;
383	1	716	1
384	} or warn "$ext not loaded: $@";	717	} or warn "$ext not loaded: $@";
385	}	718	}
386	}	719	}
387		720
388	sub _perl_reload(&) {
389	my ($msg) = @_;
390
391	$msg->("reloading...");
392
393	eval {
394	# 1. cancel all watchers
395	$_->cancel for Event::all_watchers;
396
397	# 2. unload all extensions
398	for (@exts) {
399	$msg->("unloading <$_>");
400	unload_extension $_;
401	}
402
403	# 3. unload all modules loaded from $LIBDIR
404	while (my ($k, $v) = each %INC) {
405	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
406
407	$msg->("removing <$k>");
408	delete $INC{$k};
409
410	$k =~ s/\.pm$//;
411	$k =~ s/\//::/g;
412
413	if (my $cb = $k->can ("unload_module")) {
414	$cb->();
415	}
416
417	Symbol::delete_package $k;
418	}
419
420	# 4. get rid of ext::, as good as possible
421	Symbol::delete_package "ext::$_"
422	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
423
424	# 5. remove register_script_function callbacks
425	# TODO
426
427	# 6. unload cf.pm "a bit"
428	delete $INC{"cf.pm"};
429
430	# don't, removes xs symbols, too
431	#Symbol::delete_package __PACKAGE__;
432
433	# 7. reload cf.pm
434	$msg->("reloading cf.pm");
435	require cf;
436	};
437	$msg->($@) if $@;
438
439	$msg->("reloaded");
440	};
441
442	sub perl_reload() {
443	_perl_reload {
444	warn $_[0];
445	print "$_[0]\n";
446	};
447	}
448
449	register_command "perl-reload", 0, sub {
450	my ($who, $arg) = @_;
451
452	if ($who->flag (FLAG_WIZ)) {
453	_perl_reload {
454	warn $_[0];
455	$who->message ($_[0]);
456	};
457	}
458	};
459
460	#############################################################################
461	# utility functions
462
463	use JSON::Syck (); # TODO# replace by JSON::PC once working
464
465	sub from_json($) {
466	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
467	JSON::Syck::Load $_[0]
468	}
469
470	sub to_json($) {
471	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
472	JSON::Syck::Dump $_[0]
473	}
474
475	#############################################################################
476	# extcmd framework, basically convert ext <msg>
477	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
478
479	sub on_extcmd {
480	my ($pl, $buf) = @_;
481
482	my $msg = eval { from_json $buf };
483
484	if (ref $msg) {
485	if (my $cb = $extcmd{$msg->{msgtype}}) {
486	if (my %reply = $cb->[0]->($pl, $msg)) {
487	$pl->ext_reply ($msg->{msgid}, %reply);
488	}
489	}
490	} else {
491	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
492	}
493
494	1
495	}
496
497	#############################################################################	721	#############################################################################
498	# load/save/clean perl data associated with a map	722	# load/save/clean perl data associated with a map
499		723
500	*cf::mapsupport::on_clean = sub {	724	*cf::mapsupport::on_clean = sub {
501	my ($map) = @_;	725	my ($map) = @_;
502		726
503	my $path = $map->tmpname;	727	my $path = $map->tmpname;
504	defined $path or return;	728	defined $path or return;
505		729
506	unlink "$path.cfperl";	730	unlink "$path.pst";
507	};	731	};
508		732
509	*cf::mapsupport::on_swapin =
510	*cf::mapsupport::on_load = sub {
511	my ($map) = @_;
512
513	my $path = $map->tmpname;
514	$path = $map->path unless defined $path;
515
516	open my $fh, "<:raw", "$path.cfperl"
517	or return; # no perl data
518
519	my $data = Storable::thaw do { local $/; <$fh> };
520
521	$data->{version} <= 1
522	or return; # too new
523
524	$map->_set_obs ($data->{obs});
525	};
526
527	*cf::mapsupport::on_swapout = sub {
528	my ($map) = @_;
529
530	my $path = $map->tmpname;
531	$path = $map->path unless defined $path;
532
533	my $obs = $map->_get_obs;
534
535	if (defined $obs) {
536	open my $fh, ">:raw", "$path.cfperl"
537	or die "$path.cfperl: $!";
538
539	stat $path;
540
541	print $fh Storable::nfreeze {
542	size => (stat _)[7],
543	time => (stat _)[9],
544	version => 1,
545	obs => $obs,
546	};
547
548	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
549	} else {
550	unlink "$path.cfperl";
551	}
552	};
553
554	attach_to_maps prio => -10000, package => cf::mapsupport::;	733	cf::map->attach (prio => -10000, package => cf::mapsupport::);
555		734
556	#############################################################################	735	#############################################################################
557	# load/save perl data associated with player->ob objects	736	# load/save perl data associated with player->ob objects
558		737
559	sub all_objects(@) {	738	sub all_objects(@) {
560	@_, map all_objects ($_->inv), @_	739	@_, map all_objects ($_->inv), @_
561	}	740	}
562		741
563	attach_to_players	742	# TODO: compatibility cruft, remove when no longer needed
		743	cf::player->attach (
564	on_load => sub {	744	on_load => sub {
565	my ($pl, $path) = @_;	745	my ($pl, $path) = @_;
566		746
567	for my $o (all_objects $pl->ob) {	747	for my $o (all_objects $pl->ob) {
568	if (my $value = $o->get_ob_key_value ("_perl_data")) {	748	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
570		750
571	%$o = %{ Storable::thaw pack "H*", $value };	751	%$o = %{ Storable::thaw pack "H*", $value };
572	}	752	}
573	}	753	}
574	},	754	},
575	on_save => sub {	755	);
576	my ($pl, $path) = @_;
577
578	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
579	for grep %$_, all_objects $pl->ob;
580	},
581	;
582		756
583	#############################################################################	757	#############################################################################
584	# 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
585		766
586	=item cf::player::exists $login	767	=item cf::player::exists $login
587		768
588	Returns true when the given account exists.	769	Returns true when the given account exists.
589		770
…		…
592	sub cf::player::exists($) {	773	sub cf::player::exists($) {
593	cf::player::find $_[0]	774	cf::player::find $_[0]
594	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;
595	}	776	}
596		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
597	=item $player->reply ($npc, $msg[, $flags])	798	=item $player_object->reply ($npc, $msg[, $flags])
598		799
599	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>
600	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
601	dialogue with the given NPC character.	802	dialogue with the given NPC character.
602		803
603	=cut	804	=cut
604		805
605	# rough implementation of a future "reply" method that works	806	# rough implementation of a future "reply" method that works
606	# with dialog boxes.	807	# with dialog boxes.
		808	#TODO: the first argument must go, split into a $npc->reply_to ( method
607	sub cf::object::player::reply($$$;$) {	809	sub cf::object::player::reply($$$;$) {
608	my ($self, $npc, $msg, $flags) = @_;	810	my ($self, $npc, $msg, $flags) = @_;
609		811
610	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	812	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
611		813
…		…
615	$msg = $npc->name . " says: $msg" if $npc;	817	$msg = $npc->name . " says: $msg" if $npc;
616	$self->message ($msg, $flags);	818	$self->message ($msg, $flags);
617	}	819	}
618	}	820	}
619		821
620	=item $player->ext_reply ($msgid, $msgtype, %msg)	822	=item $player_object->may ("access")
621		823
622	Sends an ext reply to the player.	824	Returns wether the given player is authorized to access resource "access"
		825	(e.g. "command_wizcast").
623		826
624	=cut	827	=cut
625		828
626	sub cf::player::ext_reply($$$%) {	829	sub cf::object::player::may {
627	my ($self, $id, %msg) = @_;	830	my ($self, $access) = @_;
628		831
629	$msg{msgid} = $id;	832	$self->flag (cf::FLAG_WIZ) ||
630		833	(ref $cf::CFG{"may_$access"}
631	$self->send ("ext " . to_json \%msg);	834	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		835	: $cf::CFG{"may_$access"})
632	}	836	}
633		837
634	#############################################################################	838	=head3 cf::client
635	# map scripting support
636		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
637	our $safe = new Safe "ext";	919	our $safe = new Safe "safe";
638	our $safe_hole = new Safe::Hole;	920	our $safe_hole = new Safe::Hole;
639		921
640	$SIG{FPE} = 'IGNORE';	922	$SIG{FPE} = 'IGNORE';
641		923
642	$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));
643		925
644	# here we export the classes and methods available to script code	926	# here we export the classes and methods available to script code
645		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
646	for (	939	for (
647	["cf::object" => qw(contr pay_amount pay_player)],	940	["cf::object" => qw(contr pay_amount pay_player map)],
648	["cf::object::player" => qw(player)],	941	["cf::object::player" => qw(player)],
649	["cf::player" => qw(peaceful)],	942	["cf::player" => qw(peaceful)],
		943	["cf::map" => qw(trigger)],
650	) {	944	) {
651	no strict 'refs';	945	no strict 'refs';
652	my ($pkg, @funs) = @$_;	946	my ($pkg, @funs) = @$_;
653	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	947	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
654	for @funs;	948	for @funs;
655	}	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
656		962
657	sub safe_eval($;@) {	963	sub safe_eval($;@) {
658	my ($code, %vars) = @_;	964	my ($code, %vars) = @_;
659		965
660	my $qcode = $code;	966	my $qcode = $code;
661	$qcode =~ s/"/‟/g; # not allowed in #line filenames	967	$qcode =~ s/"/‟/g; # not allowed in #line filenames
662	$qcode =~ s/\n/\\n/g;	968	$qcode =~ s/\n/\\n/g;
663		969
664	local $_;	970	local $_;
665	local @ext::cf::_safe_eval_args = values %vars;	971	local @safe::cf::_safe_eval_args = values %vars;
666		972
667	$code =	973	my $eval =
668	"do {\n"	974	"do {\n"
669	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	975	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
670	. "#line 0 \"{$qcode}\"\n"	976	. "#line 0 \"{$qcode}\"\n"
671	. $code	977	. $code
672	. "\n}"	978	. "\n}"
673	;	979	;
674		980
675	sub_generation_inc;	981	sub_generation_inc;
676	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	982	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
677	sub_generation_inc;	983	sub_generation_inc;
678		984
		985	if ($@) {
		986	warn "$@";
		987	warn "while executing safe code '$code'\n";
		988	warn "with arguments " . (join " ", %vars) . "\n";
		989	}
		990
679	wantarray ? @res : $res[0]	991	wantarray ? @res : $res[0]
680	}	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
681		1008
682	sub register_script_function {	1009	sub register_script_function {
683	my ($fun, $cb) = @_;	1010	my ($fun, $cb) = @_;
684		1011
685	no strict 'refs';	1012	no strict 'refs';
686	*{"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	);
687	}	1123	}
688		1124
689	#############################################################################	1125	#############################################################################
690	# the server's main()	1126	# the server's main()
691		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
692	sub main {	1136	sub main {
		1137	cfg_load;
		1138	db_load;
		1139	load_extensions;
693	Event::loop;	1140	Event::loop;
694	}	1141	}
695		1142
696	#############################################################################	1143	#############################################################################
697	# initialisation	1144	# initialisation
698		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
699	register "<global>", __PACKAGE__;	1225	register "<global>", __PACKAGE__;
700		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
701	unshift @INC, $LIBDIR;	1238	unshift @INC, $LIBDIR;
702		1239
703	load_extensions;
704
705	$TICK_WATCHER = Event->timer (	1240	$TICK_WATCHER = Event->timer (
706	prio => 1,	1241	prio => 0,
707	at => $NEXT_TICK || 1,	1242	at => $NEXT_TICK || 1,
		1243	data => WF_AUTOCANCEL,
708	cb => sub {	1244	cb => sub {
709	cf::server_tick; # one server iteration	1245	cf::server_tick; # one server iteration
710		1246
711	my $NOW = Event::time;	1247	my $NOW = Event::time;
712	$NEXT_TICK += $TICK;	1248	$NEXT_TICK += $TICK;
713		1249
714	# if we are delayed by four ticks, skip them all	1250	# if we are delayed by four ticks or more, skip them all
715	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1251	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
716		1252
717	$TICK_WATCHER->at ($NEXT_TICK);	1253	$TICK_WATCHER->at ($NEXT_TICK);
718	$TICK_WATCHER->start;	1254	$TICK_WATCHER->start;
719	},	1255	},
720	);	1256	);
721		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
722	1	1266	1
723		1267

Diff Legend

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