[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.38 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.67 by root, Tue Sep 12 23:22:32 2006 UTC

…		…
11	use Event;	11	use Event;
12	$Event::Eval = 1; # no idea why this is required, but it is	12	$Event::Eval = 1; # no idea why this is required, but it is
13		13
14	use strict;	14	use strict;
15		15
		16	_init_vars;
		17
16	our %COMMAND;	18	our %COMMAND = ();
17	our @EVENT;	19	our @EVENT;
18	our @PLUGIN_EVENT;
19	our %PROP_TYPE;
20	our %PROP_IDX;
21	our $LIBDIR = maps_directory "perl";	20	our $LIBDIR = maps_directory "perl";
22		21
23	our $TICK = MAX_TIME * 1e-6;	22	our $TICK = MAX_TIME * 1e-6;
24	our $TICK_WATCHER;	23	our $TICK_WATCHER;
25	our $NEXT_TICK;	24	our $NEXT_TICK;
26		25
27	BEGIN {	26	BEGIN {
28	@PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30	*CORE::GLOBAL::warn = sub {	27	*CORE::GLOBAL::warn = sub {
31	my $msg = join "", @_;	28	my $msg = join "", @_;
32	$msg .= "\n"	29	$msg .= "\n"
33	unless $msg =~ /\n$/;	30	unless $msg =~ /\n$/;
34		31
35	print STDERR "cfperl: $msg";	32	print STDERR "cfperl: $msg";
36	LOG llevError, "cfperl: $msg";	33	LOG llevError, "cfperl: $msg";
37	};	34	};
38	}	35	}
39		36
40	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	37	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
41		38
42	# generate property mutators	39	# we bless all objects into (empty) derived classes to force a method lookup
43	sub prop_gen {	40	# within the Safe compartment.
44	my ($prefix, $class) = @_;	41	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
45
46	no strict 'refs';	42	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;	43	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	44	}
85		45
86	$Event::DIED = sub {	46	$Event::DIED = sub {
87	warn "error in event callback: @_";	47	warn "error in event callback: @_";
88	};	48	};
…		…
91	my @exts;	51	my @exts;
92	my @hook;	52	my @hook;
93	my %command;	53	my %command;
94	my %extcmd;	54	my %extcmd;
95		55
		56	#############################################################################
		57	# utility functions
		58
		59	use JSON::Syck (); # TODO# replace by JSON::PC once working
		60
		61	sub from_json($) {
		62	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
		63	JSON::Syck::Load $_[0]
		64	}
		65
		66	sub to_json($) {
		67	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
		68	JSON::Syck::Dump $_[0]
		69	}
		70
		71	#############################################################################
		72	# "new" plug-in system
		73
		74	=head3 EVENTS AND OBJECT ATTACHMENTS
		75
		76	=over 4
		77
		78	=item $object->attach ($attachment, key => $value...)
		79
		80	=item $object->detach ($attachment)
		81
		82	Attach/detach a pre-registered attachment to an object.
		83
		84	=item $player->attach ($attachment, key => $value...)
		85
		86	=item $player->detach ($attachment)
		87
		88	Attach/detach a pre-registered attachment to a player.
		89
		90	=item $map->attach ($attachment, key => $value...)
		91
		92	=item $map->detach ($attachment)
		93
		94	Attach/detach a pre-registered attachment to a map.
		95
		96	=item $bool = $object->attached ($name)
		97
		98	=item $bool = $player->attached ($name)
		99
		100	=item $bool = $map->attached ($name)
		101
		102	Checks wether the named attachment is currently attached to the object.
		103
		104	=item cf::attach_global ...
		105
		106	Attach handlers for global events.
		107
		108	This and all following C<attach_*>-functions expect any number of the
		109	following handler/hook descriptions:
		110
		111	=over 4
		112
		113	=item prio => $number
		114
		115	Set the priority for all following handlers/hooks (unless overwritten
		116	by another C<prio> setting). Lower priority handlers get executed
		117	earlier. The default priority is C<0>, and many built-in handlers are
		118	registered at priority C<-1000>, so lower priorities should not be used
		119	unless you know what you are doing.
		120
		121	=item on_I<event> => \&cb
		122
		123	Call the given code reference whenever the named event happens (event is
		124	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		125	handlers are recognised generally depends on the type of object these
		126	handlers attach to).
		127
		128	See F<include/eventinc.h> for the full list of events supported, and their
		129	class.
		130
		131	=item package => package::
		132
		133	Look for sub functions of the name C<< on_I<event> >> in the given
		134	package and register them. Only handlers for eevents supported by the
		135	object/class are recognised.
		136
		137	=back
		138
		139	=item cf::attach_to_type $object_type, $subtype, ...
		140
		141	Attach handlers for a specific object type (e.g. TRANSPORT) and
		142	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		143	type.
		144
		145	=item cf::attach_to_objects ...
		146
		147	Attach handlers to all objects. Do not use this except for debugging or
		148	very rare events, as handlers are (obviously) called for I<all> objects in
		149	the game.
		150
		151	=item cf::attach_to_players ...
		152
		153	Attach handlers to all players.
		154
		155	=item cf::attach_to_maps ...
		156
		157	Attach handlers to all maps.
		158
		159	=item cf:register_attachment $name, ...
		160
		161	Register an attachment by name through which objects can refer to this
		162	attachment.
		163
		164	=item cf:register_player_attachment $name, ...
		165
		166	Register an attachment by name through which players can refer to this
		167	attachment.
		168
		169	=item cf:register_map_attachment $name, ...
		170
		171	Register an attachment by name through which maps can refer to this
		172	attachment.
		173
		174	=cut
		175
		176	# the following variables are defined in .xs and must not be re-created
		177	our @CB_GLOBAL = (); # registry for all global events
		178	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		179	our @CB_PLAYER = ();
		180	our @CB_TYPE = (); # registry for type (cf-object class) based events
		181	our @CB_MAP = ();
		182
		183	my %attachment;
		184
		185	sub _attach_cb($\%$$$) {
		186	my ($registry, $undo, $event, $prio, $cb) = @_;
		187
		188	use sort 'stable';
		189
		190	$cb = [$prio, $cb];
		191
		192	@{$registry->[$event]} = sort
		193	{ $a->[0] cmp $b->[0] }
		194	@{$registry->[$event] \|\| []}, $cb;
		195
		196	push @{$undo->{cb}}, [$event, $cb];
		197	}
		198
		199	# attach handles attaching event callbacks
		200	# the only thing the caller has to do is pass the correct
		201	# registry (== where the callback attaches to).
		202	sub _attach(\@$@) {
		203	my ($registry, $klass, @arg) = @_;
		204
		205	my $prio = 0;
		206
		207	my %undo = (
		208	registry => $registry,
		209	cb => [],
		210	);
		211
		212	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		213
		214	while (@arg) {
		215	my $type = shift @arg;
		216
		217	if ($type eq "prio") {
		218	$prio = shift @arg;
		219
		220	} elsif ($type eq "package") {
		221	my $pkg = shift @arg;
		222
		223	while (my ($name, $id) = each %cb_id) {
		224	if (my $cb = $pkg->can ($name)) {
		225	_attach_cb $registry, %undo, $id, $prio, $cb;
		226	}
		227	}
		228
		229	} elsif (exists $cb_id{$type}) {
		230	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
		231
		232	} elsif (ref $type) {
		233	warn "attaching objects not supported, ignoring.\n";
		234
		235	} else {
		236	shift @arg;
		237	warn "attach argument '$type' not supported, ignoring.\n";
		238	}
		239	}
		240
		241	\%undo
		242	}
		243
		244	sub _attach_attachment {
		245	my ($obj, $name, %arg) = @_;
		246
		247	return if exists $obj->{_attachment}{$name};
		248
		249	my $res;
		250
		251	if (my $attach = $attachment{$name}) {
		252	my $registry = $obj->registry;
		253
		254	for (@$attach) {
		255	my ($klass, @attach) = @$_;
		256	$res = _attach @$registry, $klass, @attach;
		257	}
		258
		259	$obj->{$name} = \%arg;
		260	} else {
		261	warn "object uses attachment '$name' that is not available, postponing.\n";
		262	}
		263
		264	$obj->{_attachment}{$name} = undef;
		265
		266	$res->{attachment} = $name;
		267	$res
		268	}
		269
		270	*cf::object::attach =
		271	*cf::player::attach =
		272	*cf::map::attach = sub {
		273	my ($obj, $name, %arg) = @_;
		274
		275	_attach_attachment $obj, $name, %arg;
		276	};
		277
		278	# all those should be optimised
		279	*cf::object::detach =
		280	*cf::player::detach =
		281	*cf::map::detach = sub {
		282	my ($obj, $name) = @_;
		283
		284	delete $obj->{_attachment}{$name};
		285	reattach ($obj);
		286	};
		287
		288	*cf::object::attached =
		289	*cf::player::attached =
		290	*cf::map::attached = sub {
		291	my ($obj, $name) = @_;
		292
		293	exists $obj->{_attachment}{$name}
		294	};
		295
		296	sub attach_global {
		297	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
		298	}
		299
		300	sub attach_to_type {
		301	my $type = shift;
		302	my $subtype = shift;
		303
		304	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
		305	}
		306
		307	sub attach_to_objects {
		308	_attach @CB_OBJECT, KLASS_OBJECT, @_
		309	}
		310
		311	sub attach_to_players {
		312	_attach @CB_PLAYER, KLASS_PLAYER, @_
		313	}
		314
		315	sub attach_to_maps {
		316	_attach @CB_MAP, KLASS_MAP, @_
		317	}
		318
		319	sub register_attachment {
		320	my $name = shift;
		321
		322	$attachment{$name} = [[KLASS_OBJECT, @_]];
		323	}
		324
		325	sub register_player_attachment {
		326	my $name = shift;
		327
		328	$attachment{$name} = [[KLASS_PLAYER, @_]];
		329	}
		330
		331	sub register_map_attachment {
		332	my $name = shift;
		333
		334	$attachment{$name} = [[KLASS_MAP, @_]];
		335	}
		336
		337	our $override;
		338	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		339
		340	sub override {
		341	$override = 1;
		342	@invoke_results = ();
		343	}
		344
		345	sub do_invoke {
		346	my $event = shift;
		347	my $callbacks = shift;
		348
		349	@invoke_results = ();
		350
		351	local $override;
		352
		353	for (@$callbacks) {
		354	eval { &{$_->[1]} };
		355
		356	if ($@) {
		357	warn "$@";
		358	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		359	override;
		360	}
		361
		362	return 1 if $override;
		363	}
		364
		365	0
		366	}
		367
		368	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		369
		370	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		371
		372	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		373
		374	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		375
		376	Generate a global/object/player/map-specific event with the given arguments.
		377
		378	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		379	removed in future versions), and there is no public API to access override
		380	results (if you must, access C<@cf::invoke_results> directly).
		381
		382	=back
		383
		384	=head2 methods valid for all pointers
		385
		386	=over 4
		387
		388	=item $object->valid
		389
		390	=item $player->valid
		391
		392	=item $map->valid
		393
		394	Just because you have a perl object does not mean that the corresponding
		395	C-level object still exists. If you try to access an object that has no
		396	valid C counterpart anymore you get an exception at runtime. This method
		397	can be used to test for existence of the C object part without causing an
		398	exception.
		399
		400	=back
		401
		402	=cut
		403
		404	*cf::object::valid =
		405	*cf::player::valid =
		406	*cf::map::valid = \&cf::_valid;
		407
		408	#############################################################################
		409	# object support
		410
		411	sub instantiate {
		412	my ($obj, $data) = @_;
		413
		414	$data = from_json $data;
		415
		416	for (@$data) {
		417	my ($name, $args) = @$_;
		418
		419	$obj->attach ($name, %{$args \|\| {} });
		420	}
		421	}
		422
		423	# basically do the same as instantiate, without calling instantiate
		424	sub reattach {
		425	my ($obj) = @_;
		426	my $registry = $obj->registry;
		427
		428	@$registry = ();
		429
		430	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		431
		432	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
		433	if (my $attach = $attachment{$name}) {
		434	for (@$attach) {
		435	my ($klass, @attach) = @$_;
		436	_attach @$registry, $klass, @attach;
		437	}
		438	} else {
		439	warn "object uses attachment '$name' that is not available, postponing.\n";
		440	}
		441	}
		442	}
		443
		444	sub object_freezer_save {
		445	my ($filename, $rdata, $objs) = @_;
		446
		447	if (length $$rdata) {
		448	warn sprintf "saving %s (%d,%d)\n",
		449	$filename, length $$rdata, scalar @$objs;
		450
		451	if (open my $fh, ">:raw", "$filename~") {
		452	chmod SAVE_MODE, $fh;
		453	syswrite $fh, $$rdata;
		454	close $fh;
		455
		456	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		457	chmod SAVE_MODE, $fh;
		458	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		459	close $fh;
		460	rename "$filename.pst~", "$filename.pst";
		461	} else {
		462	unlink "$filename.pst";
		463	}
		464
		465	rename "$filename~", $filename;
		466	} else {
		467	warn "FATAL: $filename~: $!\n";
		468	}
		469	} else {
		470	unlink $filename;
		471	unlink "$filename.pst";
		472	}
		473	}
		474
		475	sub object_thawer_load {
		476	my ($filename) = @_;
		477
		478	local $/;
		479
		480	my $av;
		481
		482	#TODO: use sysread etc.
		483	if (open my $data, "<:raw:perlio", $filename) {
		484	$data = <$data>;
		485	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		486	$av = eval { (Storable::thaw <$pst>)->{objs} };
		487	}
		488	return ($data, $av);
		489	}
		490
		491	()
		492	}
		493
		494	attach_to_objects
		495	prio => -1000000,
		496	on_clone => sub {
		497	my ($src, $dst) = @_;
		498
		499	@{$dst->registry} = @{$src->registry};
		500
		501	%$dst = %$src;
		502
		503	%{$dst->{_attachment}} = %{$src->{_attachment}}
		504	if exists $src->{_attachment};
		505	},
		506	;
		507
		508	#############################################################################
		509	# old plug-in events
		510
96	sub inject_event {	511	sub inject_event {
97	my $extension = shift;	512	my $extension = shift;
98	my $event_code = shift;	513	my $event_code = shift;
99		514
100	my $cb = $hook[$event_code]{$extension}	515	my $cb = $hook[$event_code]{$extension}
…		…
142	}	557	}
143		558
144	sub register {	559	sub register {
145	my ($base, $pkg) = @_;	560	my ($base, $pkg) = @_;
146		561
147	for my $idx (0 .. $#PLUGIN_EVENT) {	562	#TODO
148	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
149	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
150	$hook[$idx]{$base} = $ref;
151	}
152	}
153	}	563	}
154		564
155	sub load_extension {	565	sub load_extension {
156	my ($path) = @_;	566	my ($path) = @_;
157		567
158	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	568	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
159	my $base = $1;	569	my $base = $1;
160	my $pkg = $1;	570	my $pkg = $1;
161	$pkg =~ s/[^[:word:]]/_/g;	571	$pkg =~ s/[^[:word:]]/_/g;
162	$pkg = "cf::ext::$pkg";	572	$pkg = "ext::$pkg";
163		573
164	warn "loading '$path' into '$pkg'\n";	574	warn "loading '$path' into '$pkg'\n";
165		575
166	open my $fh, "<:utf8", $path	576	open my $fh, "<:utf8", $path
167	or die "$path: $!";	577	or die "$path: $!";
…		…
188	my ($pkg) = @_;	598	my ($pkg) = @_;
189		599
190	warn "removing extension $pkg\n";	600	warn "removing extension $pkg\n";
191		601
192	# remove hooks	602	# remove hooks
		603	#TODO
193	for my $idx (0 .. $#PLUGIN_EVENT) {	604	# for my $idx (0 .. $#PLUGIN_EVENT) {
194	delete $hook[$idx]{$pkg};	605	# delete $hook[$idx]{$pkg};
195	}	606	# }
196		607
197	# remove commands	608	# remove commands
198	for my $name (keys %command) {	609	for my $name (keys %command) {
199	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	610	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
200		611
…		…
210	# remove extcmds	621	# remove extcmds
211	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	622	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
212	delete $extcmd{$name};	623	delete $extcmd{$name};
213	}	624	}
214		625
215	if (my $cb = $pkg->can ("on_unload")) {	626	if (my $cb = $pkg->can ("unload")) {
216	eval {	627	eval {
217	$cb->($pkg);	628	$cb->($pkg);
218	1	629	1
219	} or warn "$pkg unloaded, but with errors: $@";	630	} or warn "$pkg unloaded, but with errors: $@";
220	}	631	}
…		…
232	1	643	1
233	} or warn "$ext not loaded: $@";	644	} or warn "$ext not loaded: $@";
234	}	645	}
235	}	646	}
236		647
237	sub _perl_reload(&) {
238	my ($msg) = @_;
239
240	$msg->("reloading...");
241
242	eval {
243	# 1. cancel all watchers
244	$_->cancel for Event::all_watchers;
245
246	# 2. unload all extensions
247	for (@exts) {
248	$msg->("unloading <$_>");
249	unload_extension $_;
250	}
251
252	# 3. unload all modules loaded from $LIBDIR
253	while (my ($k, $v) = each %INC) {
254	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
255
256	$msg->("removing <$k>");
257	delete $INC{$k};
258
259	$k =~ s/\.pm$//;
260	$k =~ s/\//::/g;
261
262	if (my $cb = $k->can ("unload_module")) {
263	$cb->();
264	}
265
266	Symbol::delete_package $k;
267	}
268
269	# 4. get rid of ext::, as good as possible
270	Symbol::delete_package "ext::$_"
271	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
272
273	# 5. remove register_script_function callbacks
274	# TODO
275
276	# 6. unload cf.pm "a bit"
277	delete $INC{"cf.pm"};
278
279	# don't, removes xs symbols, too
280	#Symbol::delete_package __PACKAGE__;
281
282	# 7. reload cf.pm
283	$msg->("reloading cf.pm");
284	require cf;
285	};
286	$msg->($@) if $@;
287
288	$msg->("reloaded");
289	};
290
291	sub perl_reload() {
292	_perl_reload {
293	warn $_[0];
294	print "$_[0]\n";
295	};
296	}
297
298	register_command "perl-reload", 0, sub {
299	my ($who, $arg) = @_;
300
301	if ($who->flag (FLAG_WIZ)) {
302	_perl_reload {
303	warn $_[0];
304	$who->message ($_[0]);
305	};
306	}
307	};
308
309	#############################################################################
310	# utility functions
311
312	use JSON::Syck (); # TODO# replace by JSON::PC once working
313
314	sub from_json($) {
315	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
316	JSON::Syck::Load $_[0]
317	}
318
319	sub to_json($) {
320	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
321	JSON::Syck::Dump $_[0]
322	}
323
324	#############################################################################	648	#############################################################################
325	# extcmd framework, basically convert ext <msg>	649	# extcmd framework, basically convert ext <msg>
326	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	650	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
327		651
328	sub on_extcmd {	652	attach_to_players
		653	on_extcmd => sub {
329	my ($pl, $buf) = @_;	654	my ($pl, $buf) = @_;
330		655
331	my $msg = eval { from_json $buf };	656	my $msg = eval { from_json $buf };
332		657
333	if (ref $msg) {	658	if (ref $msg) {
334	if (my $cb = $extcmd{$msg->{msgtype}}) {	659	if (my $cb = $extcmd{$msg->{msgtype}}) {
335	if (my %reply = $cb->[0]->($pl, $msg)) {	660	if (my %reply = $cb->[0]->($pl, $msg)) {
336	$pl->ext_reply ($msg->{msgid}, %reply);	661	$pl->ext_reply ($msg->{msgid}, %reply);
		662	}
337	}	663	}
338	}
339	} else {	664	} else {
340	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	665	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		666	}
		667
		668	cf::override;
341	}	669	},
342		670	;
343	1
344	}
345		671
346	#############################################################################	672	#############################################################################
347	# load/save/clean perl data associated with a map	673	# load/save/clean perl data associated with a map
348		674
349	*on_mapclean = sub {	675	*cf::mapsupport::on_clean = sub {
350	my ($map) = @_;	676	my ($map) = @_;
351		677
352	my $path = $map->tmpname;	678	my $path = $map->tmpname;
353	defined $path or return;	679	defined $path or return;
354		680
355	unlink "$path.cfperl";	681	unlink "$path.pst";
356	};	682	};
357		683
358	*on_mapin =	684	attach_to_maps prio => -10000, package => cf::mapsupport::;
359	*on_mapload = sub {
360	my ($map) = @_;
361
362	my $path = $map->tmpname;
363	$path = $map->path unless defined $path;
364
365	open my $fh, "<:raw", "$path.cfperl"
366	or return; # no perl data
367
368	my $data = Storable::thaw do { local $/; <$fh> };
369
370	$data->{version} <= 1
371	or return; # too new
372
373	$map->_set_obs ($data->{obs});
374	};
375
376	*on_mapout = sub {
377	my ($map) = @_;
378
379	my $path = $map->tmpname;
380	$path = $map->path unless defined $path;
381
382	my $obs = $map->_get_obs;
383
384	if (defined $obs) {
385	open my $fh, ">:raw", "$path.cfperl"
386	or die "$path.cfperl: $!";
387
388	stat $path;
389
390	print $fh Storable::nfreeze {
391	size => (stat _)[7],
392	time => (stat _)[9],
393	version => 1,
394	obs => $obs,
395	};
396
397	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
398	} else {
399	unlink "$path.cfperl";
400	}
401	};
402		685
403	#############################################################################	686	#############################################################################
404	# load/save perl data associated with player->ob objects	687	# load/save perl data associated with player->ob objects
405		688
406	sub all_objects(@) {	689	sub all_objects(@) {
407	@_, map all_objects ($_->inv), @_	690	@_, map all_objects ($_->inv), @_
408	}	691	}
409		692
410	*on_player_load = sub {	693	# TODO: compatibility cruft, remove when no longer needed
		694	attach_to_players
		695	on_load => sub {
411	my ($ob, $path) = @_;	696	my ($pl, $path) = @_;
412		697
413	for my $o (all_objects $ob) {	698	for my $o (all_objects $pl->ob) {
414	if (my $value = $o->get_ob_key_value ("_perl_data")) {	699	if (my $value = $o->get_ob_key_value ("_perl_data")) {
415	$o->set_ob_key_value ("_perl_data");	700	$o->set_ob_key_value ("_perl_data");
416		701
417	%$o = %{ Storable::thaw pack "H*", $value };	702	%$o = %{ Storable::thaw pack "H*", $value };
418	}	703	}
		704	}
419	}	705	},
420	};	706	;
421
422	*on_player_save = sub {
423	my ($ob, $path) = @_;
424
425	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
426	for grep %$_, all_objects $ob;
427	};
428		707
429	#############################################################################	708	#############################################################################
430	# core extensions - in perl	709	# core extensions - in perl
431		710
432	=item cf::player::exists $login	711	=item cf::player::exists $login
…		…
478	}	757	}
479		758
480	#############################################################################	759	#############################################################################
481	# map scripting support	760	# map scripting support
482		761
483	our $safe = new Safe "ext";	762	our $safe = new Safe "safe";
484	our $safe_hole = new Safe::Hole;	763	our $safe_hole = new Safe::Hole;
485		764
486	$SIG{FPE} = 'IGNORE';	765	$SIG{FPE} = 'IGNORE';
487		766
488	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	767	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
…		…
494	["cf::object::player" => qw(player)],	773	["cf::object::player" => qw(player)],
495	["cf::player" => qw(peaceful)],	774	["cf::player" => qw(peaceful)],
496	) {	775	) {
497	no strict 'refs';	776	no strict 'refs';
498	my ($pkg, @funs) = @$_;	777	my ($pkg, @funs) = @$_;
499	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	778	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
500	for @funs;	779	for @funs;
501	}	780	}
502		781
503	sub safe_eval($;@) {	782	sub safe_eval($;@) {
504	my ($code, %vars) = @_;	783	my ($code, %vars) = @_;
…		…
506	my $qcode = $code;	785	my $qcode = $code;
507	$qcode =~ s/"/‟/g; # not allowed in #line filenames	786	$qcode =~ s/"/‟/g; # not allowed in #line filenames
508	$qcode =~ s/\n/\\n/g;	787	$qcode =~ s/\n/\\n/g;
509		788
510	local $_;	789	local $_;
511	local @ext::cf::_safe_eval_args = values %vars;	790	local @safe::cf::_safe_eval_args = values %vars;
512		791
513	$code =	792	my $eval =
514	"do {\n"	793	"do {\n"
515	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	794	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
516	. "#line 0 \"{$qcode}\"\n"	795	. "#line 0 \"{$qcode}\"\n"
517	. $code	796	. $code
518	. "\n}"	797	. "\n}"
519	;	798	;
520		799
521	sub_generation_inc;	800	sub_generation_inc;
522	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	801	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
523	sub_generation_inc;	802	sub_generation_inc;
		803
		804	if ($@) {
		805	warn "$@";
		806	warn "while executing safe code '$code'\n";
		807	warn "with arguments " . (join " ", %vars) . "\n";
		808	}
524		809
525	wantarray ? @res : $res[0]	810	wantarray ? @res : $res[0]
526	}	811	}
527		812
528	sub register_script_function {	813	sub register_script_function {
529	my ($fun, $cb) = @_;	814	my ($fun, $cb) = @_;
530		815
531	no strict 'refs';	816	no strict 'refs';
532	*{"ext::$fun"} = $safe_hole->wrap ($cb);	817	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		818	}
		819
		820	#############################################################################
		821
		822	=head2 EXTENSION DATABASE SUPPORT
		823
		824	Crossfire maintains a very simple database for extension use. It can
		825	currently store anything that can be serialised using Storable, which
		826	excludes objects.
		827
		828	The parameter C<$family> should best start with the name of the extension
		829	using it, it should be unique.
		830
		831	=over 4
		832
		833	=item $hashref = cf::db_get $family
		834
		835	Return a hashref for use by the extension C<$family>, which can be
		836	modified. After modifications, you have to call C<cf::db_dirty> or
		837	C<cf::db_sync>.
		838
		839	=item $value = cf::db_get $family => $key
		840
		841	Returns a single value from the database
		842
		843	=item cf::db_put $family => $hashref
		844
		845	Stores the given family hashref into the database. Updates are delayed, if
		846	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		847
		848	=item cf::db_put $family => $key => $value
		849
		850	Stores the given C<$value> in the family hash. Updates are delayed, if you
		851	want the data to be synced to disk immediately, use C<cf::db_sync>.
		852
		853	=item cf::db_dirty
		854
		855	Marks the database as dirty, to be updated at a later time.
		856
		857	=item cf::db_sync
		858
		859	Immediately write the database to disk I<if it is dirty>.
		860
		861	=cut
		862
		863	{
		864	my $db;
		865	my $path = cf::localdir . "/database.pst";
		866
		867	sub db_load() {
		868	warn "loading database $path\n";#d# remove later
		869	$db = stat $path ? Storable::retrieve $path : { };
		870	}
		871
		872	my $pid;
		873
		874	sub db_save() {
		875	warn "saving database $path\n";#d# remove later
		876	waitpid $pid, 0 if $pid;
		877	if (0 == ($pid = fork)) {
		878	$db->{_meta}{version} = 1;
		879	Storable::nstore $db, "$path~";
		880	rename "$path~", $path;
		881	kill 9, $$ if defined $pid; #d# remove when binary updated
		882	cf::_exit 0 if defined $pid;
		883	}
		884	}
		885
		886	my $dirty;
		887
		888	sub db_sync() {
		889	db_save if $dirty;
		890	undef $dirty;
		891	}
		892
		893	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		894	db_sync;
		895	});
		896
		897	sub db_dirty() {
		898	$dirty = 1;
		899	$idle->start;
		900	}
		901
		902	sub db_get($;$) {
		903	@_ >= 2
		904	? $db->{$_[0]}{$_[1]}
		905	: ($db->{$_[0]} \|\|= { })
		906	}
		907
		908	sub db_put($$;$) {
		909	if (@_ >= 3) {
		910	$db->{$_[0]}{$_[1]} = $_[2];
		911	} else {
		912	$db->{$_[0]} = $_[1];
		913	}
		914	db_dirty;
		915	}
		916
		917	attach_global
		918	prio => 10000,
		919	on_cleanup => sub {
		920	db_sync;
		921	},
		922	;
533	}	923	}
534		924
535	#############################################################################	925	#############################################################################
536	# the server's main()	926	# the server's main()
537		927
538	sub run {	928	sub main {
		929	db_load;
		930	load_extensions;
539	Event::loop;	931	Event::loop;
540	}	932	}
541		933
542	#############################################################################	934	#############################################################################
543	# initialisation	935	# initialisation
544		936
		937	sub _perl_reload(&) {
		938	my ($msg) = @_;
		939
		940	$msg->("reloading...");
		941
		942	eval {
		943	# cancel all watchers
		944	$_->cancel for Event::all_watchers;
		945
		946	# unload all extensions
		947	for (@exts) {
		948	$msg->("unloading <$_>");
		949	unload_extension $_;
		950	}
		951
		952	# unload all modules loaded from $LIBDIR
		953	while (my ($k, $v) = each %INC) {
		954	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		955
		956	$msg->("removing <$k>");
		957	delete $INC{$k};
		958
		959	$k =~ s/\.pm$//;
		960	$k =~ s/\//::/g;
		961
		962	if (my $cb = $k->can ("unload_module")) {
		963	$cb->();
		964	}
		965
		966	Symbol::delete_package $k;
		967	}
		968
		969	# sync database to disk
		970	cf::db_sync;
		971
		972	# get rid of safe::, as good as possible
		973	Symbol::delete_package "safe::$_"
		974	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		975
		976	# remove register_script_function callbacks
		977	# TODO
		978
		979	# unload cf.pm "a bit"
		980	delete $INC{"cf.pm"};
		981
		982	# don't, removes xs symbols, too,
		983	# and global variables created in xs
		984	#Symbol::delete_package __PACKAGE__;
		985
		986	# reload cf.pm
		987	$msg->("reloading cf.pm");
		988	require cf;
		989
		990	# load database again
		991	cf::db_load;
		992
		993	# load extensions
		994	$msg->("load extensions");
		995	cf::load_extensions;
		996
		997	# reattach attachments to objects
		998	$msg->("reattach");
		999	_global_reattach;
		1000	};
		1001	$msg->($@) if $@;
		1002
		1003	$msg->("reloaded");
		1004	};
		1005
		1006	sub perl_reload() {
		1007	_perl_reload {
		1008	warn $_[0];
		1009	print "$_[0]\n";
		1010	};
		1011	}
		1012
		1013	register_command "perl-reload", 0, sub {
		1014	my ($who, $arg) = @_;
		1015
		1016	if ($who->flag (FLAG_WIZ)) {
		1017	_perl_reload {
		1018	warn $_[0];
		1019	$who->message ($_[0]);
		1020	};
		1021	}
		1022	};
		1023
545	register "<global>", __PACKAGE__;	1024	register "<global>", __PACKAGE__;
546		1025
547	unshift @INC, $LIBDIR;	1026	unshift @INC, $LIBDIR;
548
549	load_extensions;
550		1027
551	$TICK_WATCHER = Event->timer (	1028	$TICK_WATCHER = Event->timer (
552	prio => 1,	1029	prio => 1,
553	at => $NEXT_TICK \|\| 1,	1030	at => $NEXT_TICK \|\| 1,
554	cb => sub {	1031	cb => sub {

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.38 by root, Thu Aug 24 17:29:30 2006 UTC vs. Revision 1.67 by root, Tue Sep 12 23:22:32 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.38 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.67 by root, Tue Sep 12 23:22:32 2006 UTC