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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.36 by root, Thu Aug 24 14:04:29 2006 UTC vs.
Revision 1.74 by root, Sun Oct 1 15:59:29 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 YAML::Syck ();
10	use Time::HiRes;	11	use Time::HiRes;
11	use Event;	12	use Event;
12	$Event::Eval = 1; # no idea why this is required, but it is	13	$Event::Eval = 1; # no idea why this is required, but it is
13		14
		15	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		16	$YAML::Syck::ImplicitUnicode = 1;
		17
14	use strict;	18	use strict;
15		19
		20	_init_vars;
		21
16	our %COMMAND;	22	our %COMMAND = ();
17	our @EVENT;	23	our @EVENT;
18	our %PROP_TYPE;
19	our %PROP_IDX;
20	our $LIBDIR = maps_directory "perl";	24	our $LIBDIR = maps_directory "perl";
21		25
22	our $TICK = MAX_TIME * 1e-6;	26	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	27	our $TICK_WATCHER;
24	our $NEXT_TICK;	28	our $NEXT_TICK;
25		29
		30	our %CFG;
		31
		32	#############################################################################
		33
		34	=head2 GLOBAL VARIABLES
		35
		36	=over 4
		37
		38	=item $cf::LIBDIR
		39
		40	The perl library directory, where extensions and cf-specific modules can
		41	be found. It will be added to C<@INC> automatically.
		42
		43	=item $cf::TICK
		44
		45	The interval between server ticks, in seconds.
		46
		47	=item %cf::CFG
		48
		49	Configuration for the server, loaded from C</etc/crossfire/config>, or
		50	from wherever your confdir points to.
		51
		52	=back
		53
		54	=cut
		55
26	BEGIN {	56	BEGIN {
27	@EVENT = map lc, @EVENT;
28
29	*CORE::GLOBAL::warn = sub {	57	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	58	my $msg = join "", @_;
31	$msg .= "\n"	59	$msg .= "\n"
32	unless $msg =~ /\n$/;	60	unless $msg =~ /\n$/;
33		61
34	print STDERR "cfperl: $msg";	62	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	63	LOG llevError, "cfperl: $msg";
36	};	64	};
37	}	65	}
38		66
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	67	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
40		68
41	# generate property mutators	69	# we bless all objects into (empty) derived classes to force a method lookup
42	sub prop_gen {	70	# within the Safe compartment.
43	my ($prefix, $class) = @_;	71	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
44
45	no strict 'refs';	72	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	# guessed hierarchies
74
75	@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
76	@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
77
78	# we bless all objects into derived classes to force a method lookup
79	# within the Safe compartment.
80	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
81	no strict 'refs';
82	@{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	73	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
83	}	74	}
84		75
85	$Event::DIED = sub {	76	$Event::DIED = sub {
86	warn "error in event callback: @_";	77	warn "error in event callback: @_";
87	};	78	};
…		…
90	my @exts;	81	my @exts;
91	my @hook;	82	my @hook;
92	my %command;	83	my %command;
93	my %extcmd;	84	my %extcmd;
94		85
		86	=head2 UTILITY FUNCTIONS
		87
		88	=over 4
		89
		90	=cut
		91
		92	use JSON::Syck (); # TODO# replace by JSON::PC once working
		93
		94	=item $ref = cf::from_json $json
		95
		96	Converts a JSON string into the corresponding perl data structure.
		97
		98	=cut
		99
		100	sub from_json($) {
		101	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
		102	JSON::Syck::Load $_[0]
		103	}
		104
		105	=item $json = cf::to_json $ref
		106
		107	Converts a perl data structure into its JSON representation.
		108
		109	=cut
		110
		111	sub to_json($) {
		112	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
		113	JSON::Syck::Dump $_[0]
		114	}
		115
		116	=back
		117
		118	=cut
		119
		120	#############################################################################
		121
		122	=head2 EVENTS AND OBJECT ATTACHMENTS
		123
		124	=over 4
		125
		126	=item $object->attach ($attachment, key => $value...)
		127
		128	=item $object->detach ($attachment)
		129
		130	Attach/detach a pre-registered attachment to an object.
		131
		132	=item $player->attach ($attachment, key => $value...)
		133
		134	=item $player->detach ($attachment)
		135
		136	Attach/detach a pre-registered attachment to a player.
		137
		138	=item $map->attach ($attachment, key => $value...)
		139
		140	=item $map->detach ($attachment)
		141
		142	Attach/detach a pre-registered attachment to a map.
		143
		144	=item $bool = $object->attached ($name)
		145
		146	=item $bool = $player->attached ($name)
		147
		148	=item $bool = $map->attached ($name)
		149
		150	Checks wether the named attachment is currently attached to the object.
		151
		152	=item cf::attach_global ...
		153
		154	Attach handlers for global events.
		155
		156	This and all following C<attach_*>-functions expect any number of the
		157	following handler/hook descriptions:
		158
		159	=over 4
		160
		161	=item prio => $number
		162
		163	Set the priority for all following handlers/hooks (unless overwritten
		164	by another C<prio> setting). Lower priority handlers get executed
		165	earlier. The default priority is C<0>, and many built-in handlers are
		166	registered at priority C<-1000>, so lower priorities should not be used
		167	unless you know what you are doing.
		168
		169	=item on_I<event> => \&cb
		170
		171	Call the given code reference whenever the named event happens (event is
		172	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		173	handlers are recognised generally depends on the type of object these
		174	handlers attach to).
		175
		176	See F<include/eventinc.h> for the full list of events supported, and their
		177	class.
		178
		179	=item package => package::
		180
		181	Look for sub functions of the name C<< on_I<event> >> in the given
		182	package and register them. Only handlers for eevents supported by the
		183	object/class are recognised.
		184
		185	=back
		186
		187	=item cf::attach_to_type $object_type, $subtype, ...
		188
		189	Attach handlers for a specific object type (e.g. TRANSPORT) and
		190	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		191	type.
		192
		193	=item cf::attach_to_objects ...
		194
		195	Attach handlers to all objects. Do not use this except for debugging or
		196	very rare events, as handlers are (obviously) called for I<all> objects in
		197	the game.
		198
		199	=item cf::attach_to_players ...
		200
		201	Attach handlers to all players.
		202
		203	=item cf::attach_to_maps ...
		204
		205	Attach handlers to all maps.
		206
		207	=item cf:register_attachment $name, ...
		208
		209	Register an attachment by name through which objects can refer to this
		210	attachment.
		211
		212	=item cf:register_player_attachment $name, ...
		213
		214	Register an attachment by name through which players can refer to this
		215	attachment.
		216
		217	=item cf:register_map_attachment $name, ...
		218
		219	Register an attachment by name through which maps can refer to this
		220	attachment.
		221
		222	=cut
		223
		224	# the following variables are defined in .xs and must not be re-created
		225	our @CB_GLOBAL = (); # registry for all global events
		226	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		227	our @CB_PLAYER = ();
		228	our @CB_TYPE = (); # registry for type (cf-object class) based events
		229	our @CB_MAP = ();
		230
		231	my %attachment;
		232
		233	sub _attach_cb($\%$$$) {
		234	my ($registry, $undo, $event, $prio, $cb) = @_;
		235
		236	use sort 'stable';
		237
		238	$cb = [$prio, $cb];
		239
		240	@{$registry->[$event]} = sort
		241	{ $a->[0] cmp $b->[0] }
		242	@{$registry->[$event] \|\| []}, $cb;
		243
		244	push @{$undo->{cb}}, [$event, $cb];
		245	}
		246
		247	# attach handles attaching event callbacks
		248	# the only thing the caller has to do is pass the correct
		249	# registry (== where the callback attaches to).
		250	sub _attach(\@$@) {
		251	my ($registry, $klass, @arg) = @_;
		252
		253	my $prio = 0;
		254
		255	my %undo = (
		256	registry => $registry,
		257	cb => [],
		258	);
		259
		260	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		261
		262	while (@arg) {
		263	my $type = shift @arg;
		264
		265	if ($type eq "prio") {
		266	$prio = shift @arg;
		267
		268	} elsif ($type eq "package") {
		269	my $pkg = shift @arg;
		270
		271	while (my ($name, $id) = each %cb_id) {
		272	if (my $cb = $pkg->can ($name)) {
		273	_attach_cb $registry, %undo, $id, $prio, $cb;
		274	}
		275	}
		276
		277	} elsif (exists $cb_id{$type}) {
		278	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
		279
		280	} elsif (ref $type) {
		281	warn "attaching objects not supported, ignoring.\n";
		282
		283	} else {
		284	shift @arg;
		285	warn "attach argument '$type' not supported, ignoring.\n";
		286	}
		287	}
		288
		289	\%undo
		290	}
		291
		292	sub _attach_attachment {
		293	my ($obj, $name, %arg) = @_;
		294
		295	return if exists $obj->{_attachment}{$name};
		296
		297	my $res;
		298
		299	if (my $attach = $attachment{$name}) {
		300	my $registry = $obj->registry;
		301
		302	for (@$attach) {
		303	my ($klass, @attach) = @$_;
		304	$res = _attach @$registry, $klass, @attach;
		305	}
		306
		307	$obj->{$name} = \%arg;
		308	} else {
		309	warn "object uses attachment '$name' that is not available, postponing.\n";
		310	}
		311
		312	$obj->{_attachment}{$name} = undef;
		313
		314	$res->{attachment} = $name;
		315	$res
		316	}
		317
		318	*cf::object::attach =
		319	*cf::player::attach =
		320	*cf::map::attach = sub {
		321	my ($obj, $name, %arg) = @_;
		322
		323	_attach_attachment $obj, $name, %arg;
		324	};
		325
		326	# all those should be optimised
		327	*cf::object::detach =
		328	*cf::player::detach =
		329	*cf::map::detach = sub {
		330	my ($obj, $name) = @_;
		331
		332	delete $obj->{_attachment}{$name};
		333	reattach ($obj);
		334	};
		335
		336	*cf::object::attached =
		337	*cf::player::attached =
		338	*cf::map::attached = sub {
		339	my ($obj, $name) = @_;
		340
		341	exists $obj->{_attachment}{$name}
		342	};
		343
		344	sub attach_global {
		345	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
		346	}
		347
		348	sub attach_to_type {
		349	my $type = shift;
		350	my $subtype = shift;
		351
		352	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
		353	}
		354
		355	sub attach_to_objects {
		356	_attach @CB_OBJECT, KLASS_OBJECT, @_
		357	}
		358
		359	sub attach_to_players {
		360	_attach @CB_PLAYER, KLASS_PLAYER, @_
		361	}
		362
		363	sub attach_to_maps {
		364	_attach @CB_MAP, KLASS_MAP, @_
		365	}
		366
		367	sub register_attachment {
		368	my $name = shift;
		369
		370	$attachment{$name} = [[KLASS_OBJECT, @_]];
		371	}
		372
		373	sub register_player_attachment {
		374	my $name = shift;
		375
		376	$attachment{$name} = [[KLASS_PLAYER, @_]];
		377	}
		378
		379	sub register_map_attachment {
		380	my $name = shift;
		381
		382	$attachment{$name} = [[KLASS_MAP, @_]];
		383	}
		384
		385	our $override;
		386	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		387
		388	sub override {
		389	$override = 1;
		390	@invoke_results = ();
		391	}
		392
		393	sub do_invoke {
		394	my $event = shift;
		395	my $callbacks = shift;
		396
		397	@invoke_results = ();
		398
		399	local $override;
		400
		401	for (@$callbacks) {
		402	eval { &{$_->[1]} };
		403
		404	if ($@) {
		405	warn "$@";
		406	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		407	override;
		408	}
		409
		410	return 1 if $override;
		411	}
		412
		413	0
		414	}
		415
		416	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		417
		418	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		419
		420	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		421
		422	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		423
		424	Generate a global/object/player/map-specific event with the given arguments.
		425
		426	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		427	removed in future versions), and there is no public API to access override
		428	results (if you must, access C<@cf::invoke_results> directly).
		429
		430	=back
		431
		432	=cut
		433
		434	#############################################################################
		435
		436	=head2 METHODS VALID FOR ALL CORE OBJECTS
		437
		438	=over 4
		439
		440	=item $object->valid, $player->valid, $map->valid
		441
		442	Just because you have a perl object does not mean that the corresponding
		443	C-level object still exists. If you try to access an object that has no
		444	valid C counterpart anymore you get an exception at runtime. This method
		445	can be used to test for existence of the C object part without causing an
		446	exception.
		447
		448	=back
		449
		450	=cut
		451
		452	*cf::object::valid =
		453	*cf::player::valid =
		454	*cf::map::valid = \&cf::_valid;
		455
		456	#############################################################################
		457	# object support
		458
		459	sub instantiate {
		460	my ($obj, $data) = @_;
		461
		462	$data = from_json $data;
		463
		464	for (@$data) {
		465	my ($name, $args) = @$_;
		466
		467	$obj->attach ($name, %{$args \|\| {} });
		468	}
		469	}
		470
		471	# basically do the same as instantiate, without calling instantiate
		472	sub reattach {
		473	my ($obj) = @_;
		474	my $registry = $obj->registry;
		475
		476	@$registry = ();
		477
		478	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		479
		480	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
		481	if (my $attach = $attachment{$name}) {
		482	for (@$attach) {
		483	my ($klass, @attach) = @$_;
		484	_attach @$registry, $klass, @attach;
		485	}
		486	} else {
		487	warn "object uses attachment '$name' that is not available, postponing.\n";
		488	}
		489	}
		490	}
		491
		492	sub object_freezer_save {
		493	my ($filename, $rdata, $objs) = @_;
		494
		495	if (length $$rdata) {
		496	warn sprintf "saving %s (%d,%d)\n",
		497	$filename, length $$rdata, scalar @$objs;
		498
		499	if (open my $fh, ">:raw", "$filename~") {
		500	chmod SAVE_MODE, $fh;
		501	syswrite $fh, $$rdata;
		502	close $fh;
		503
		504	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		505	chmod SAVE_MODE, $fh;
		506	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		507	close $fh;
		508	rename "$filename.pst~", "$filename.pst";
		509	} else {
		510	unlink "$filename.pst";
		511	}
		512
		513	rename "$filename~", $filename;
		514	} else {
		515	warn "FATAL: $filename~: $!\n";
		516	}
		517	} else {
		518	unlink $filename;
		519	unlink "$filename.pst";
		520	}
		521	}
		522
		523	sub object_thawer_load {
		524	my ($filename) = @_;
		525
		526	local $/;
		527
		528	my $av;
		529
		530	#TODO: use sysread etc.
		531	if (open my $data, "<:raw:perlio", $filename) {
		532	$data = <$data>;
		533	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		534	$av = eval { (Storable::thaw <$pst>)->{objs} };
		535	}
		536	return ($data, $av);
		537	}
		538
		539	()
		540	}
		541
		542	attach_to_objects
		543	prio => -1000000,
		544	on_clone => sub {
		545	my ($src, $dst) = @_;
		546
		547	@{$dst->registry} = @{$src->registry};
		548
		549	%$dst = %$src;
		550
		551	%{$dst->{_attachment}} = %{$src->{_attachment}}
		552	if exists $src->{_attachment};
		553	},
		554	;
		555
		556	#############################################################################
		557	# old plug-in events
		558
95	sub inject_event {	559	sub inject_event {
96	my $extension = shift;	560	my $extension = shift;
97	my $event_code = shift;	561	my $event_code = shift;
98		562
99	my $cb = $hook[$event_code]{$extension}	563	my $cb = $hook[$event_code]{$extension}
…		…
141	}	605	}
142		606
143	sub register {	607	sub register {
144	my ($base, $pkg) = @_;	608	my ($base, $pkg) = @_;
145		609
146	for my $idx (0 .. $#EVENT) {	610	#TODO
147	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
148	#warn "registering $EVENT[$idx] hook to '$pkg'\n";
149	$hook[$idx]{$base} = $ref;
150	}
151	}
152	}	611	}
153		612
154	sub load_extension {	613	sub load_extension {
155	my ($path) = @_;	614	my ($path) = @_;
156		615
157	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	616	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
158	my $base = $1;	617	my $base = $1;
159	my $pkg = $1;	618	my $pkg = $1;
160	$pkg =~ s/[^[:word:]]/_/g;	619	$pkg =~ s/[^[:word:]]/_/g;
161	$pkg = "cf::ext::$pkg";	620	$pkg = "ext::$pkg";
162		621
163	warn "loading '$path' into '$pkg'\n";	622	warn "loading '$path' into '$pkg'\n";
164		623
165	open my $fh, "<:utf8", $path	624	open my $fh, "<:utf8", $path
166	or die "$path: $!";	625	or die "$path: $!";
…		…
187	my ($pkg) = @_;	646	my ($pkg) = @_;
188		647
189	warn "removing extension $pkg\n";	648	warn "removing extension $pkg\n";
190		649
191	# remove hooks	650	# remove hooks
		651	#TODO
192	for my $idx (0 .. $#EVENT) {	652	# for my $idx (0 .. $#PLUGIN_EVENT) {
193	delete $hook[$idx]{$pkg};	653	# delete $hook[$idx]{$pkg};
194	}	654	# }
195		655
196	# remove commands	656	# remove commands
197	for my $name (keys %command) {	657	for my $name (keys %command) {
198	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	658	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
199		659
…		…
209	# remove extcmds	669	# remove extcmds
210	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	670	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
211	delete $extcmd{$name};	671	delete $extcmd{$name};
212	}	672	}
213		673
214	if (my $cb = $pkg->can ("on_unload")) {	674	if (my $cb = $pkg->can ("unload")) {
215	eval {	675	eval {
216	$cb->($pkg);	676	$cb->($pkg);
217	1	677	1
218	} or warn "$pkg unloaded, but with errors: $@";	678	} or warn "$pkg unloaded, but with errors: $@";
219	}	679	}
…		…
231	1	691	1
232	} or warn "$ext not loaded: $@";	692	} or warn "$ext not loaded: $@";
233	}	693	}
234	}	694	}
235		695
236	sub _perl_reload(&) {
237	my ($msg) = @_;
238
239	$msg->("reloading...");
240
241	eval {
242	# 1. cancel all watchers
243	$_->cancel for Event::all_watchers;
244
245	# 2. unload all extensions
246	for (@exts) {
247	$msg->("unloading <$_>");
248	unload_extension $_;
249	}
250
251	# 3. unload all modules loaded from $LIBDIR
252	while (my ($k, $v) = each %INC) {
253	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
254
255	$msg->("removing <$k>");
256	delete $INC{$k};
257
258	$k =~ s/\.pm$//;
259	$k =~ s/\//::/g;
260
261	if (my $cb = $k->can ("unload_module")) {
262	$cb->();
263	}
264
265	Symbol::delete_package $k;
266	}
267
268	# 4. get rid of ext::, as good as possible
269	Symbol::delete_package "ext::$_"
270	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
271
272	# 5. remove register_script_function callbacks
273	# TODO
274
275	# 6. unload cf.pm "a bit"
276	delete $INC{"cf.pm"};
277
278	# don't, removes xs symbols, too
279	#Symbol::delete_package __PACKAGE__;
280
281	# 7. reload cf.pm
282	$msg->("reloading cf.pm");
283	require cf;
284	};
285	$msg->($@) if $@;
286
287	$msg->("reloaded");
288	};
289
290	sub perl_reload() {
291	_perl_reload {
292	warn $_[0];
293	print "$_[0]\n";
294	};
295	}
296
297	register_command "perl-reload", 0, sub {
298	my ($who, $arg) = @_;
299
300	if ($who->flag (FLAG_WIZ)) {
301	_perl_reload {
302	warn $_[0];
303	$who->message ($_[0]);
304	};
305	}
306	};
307
308	#############################################################################
309	# utility functions
310
311	use JSON::Syck (); # TODO# replace by JSON::PC once working
312
313	sub from_json($) {
314	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
315	JSON::Syck::Load $_[0]
316	}
317
318	sub to_json($) {
319	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
320	JSON::Syck::Dump $_[0]
321	}
322
323	#############################################################################	696	#############################################################################
324	# extcmd framework, basically convert ext <msg>	697	# extcmd framework, basically convert ext <msg>
325	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	698	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
326		699
327	sub on_extcmd {	700	attach_to_players
		701	on_extcmd => sub {
328	my ($pl, $buf) = @_;	702	my ($pl, $buf) = @_;
329		703
330	my $msg = eval { from_json $buf };	704	my $msg = eval { from_json $buf };
331		705
332	if (ref $msg) {	706	if (ref $msg) {
333	if (my $cb = $extcmd{$msg->{msgtype}}) {	707	if (my $cb = $extcmd{$msg->{msgtype}}) {
334	if (my %reply = $cb->[0]->($pl, $msg)) {	708	if (my %reply = $cb->[0]->($pl, $msg)) {
335	$pl->ext_reply ($msg->{msgid}, %reply);	709	$pl->ext_reply ($msg->{msgid}, %reply);
		710	}
336	}	711	}
337	}
338	} else {	712	} else {
339	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	713	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		714	}
		715
		716	cf::override;
340	}	717	},
341		718	;
342	1
343	}
344		719
345	#############################################################################	720	#############################################################################
346	# load/save/clean perl data associated with a map	721	# load/save/clean perl data associated with a map
347		722
348	*on_mapclean = sub {	723	*cf::mapsupport::on_clean = sub {
349	my ($map) = @_;	724	my ($map) = @_;
350		725
351	my $path = $map->tmpname;	726	my $path = $map->tmpname;
352	defined $path or return;	727	defined $path or return;
353		728
354	unlink "$path.cfperl";	729	unlink "$path.pst";
355	};	730	};
356		731
357	*on_mapin =	732	attach_to_maps prio => -10000, package => cf::mapsupport::;
358	*on_mapload = sub {
359	my ($map) = @_;
360
361	my $path = $map->tmpname;
362	$path = $map->path unless defined $path;
363
364	open my $fh, "<:raw", "$path.cfperl"
365	or return; # no perl data
366
367	my $data = Storable::thaw do { local $/; <$fh> };
368
369	$data->{version} <= 1
370	or return; # too new
371
372	$map->_set_obs ($data->{obs});
373	};
374
375	*on_mapout = sub {
376	my ($map) = @_;
377
378	my $path = $map->tmpname;
379	$path = $map->path unless defined $path;
380
381	my $obs = $map->_get_obs;
382
383	if (defined $obs) {
384	open my $fh, ">:raw", "$path.cfperl"
385	or die "$path.cfperl: $!";
386
387	stat $path;
388
389	print $fh Storable::nfreeze {
390	size => (stat _)[7],
391	time => (stat _)[9],
392	version => 1,
393	obs => $obs,
394	};
395
396	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
397	} else {
398	unlink "$path.cfperl";
399	}
400	};
401		733
402	#############################################################################	734	#############################################################################
403	# load/save perl data associated with player->ob objects	735	# load/save perl data associated with player->ob objects
404		736
405	sub all_objects(@) {	737	sub all_objects(@) {
406	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
407	}	739	}
408		740
409	*on_player_load = sub {	741	# TODO: compatibility cruft, remove when no longer needed
		742	attach_to_players
		743	on_load => sub {
410	my ($ob, $path) = @_;	744	my ($pl, $path) = @_;
411		745
412	for my $o (all_objects $ob) {	746	for my $o (all_objects $pl->ob) {
413	if (my $value = $o->get_ob_key_value ("_perl_data")) {	747	if (my $value = $o->get_ob_key_value ("_perl_data")) {
414	$o->set_ob_key_value ("_perl_data");	748	$o->set_ob_key_value ("_perl_data");
415		749
416	%$o = %{ Storable::thaw pack "H*", $value };	750	%$o = %{ Storable::thaw pack "H*", $value };
417	}	751	}
		752	}
418	}	753	},
419	};	754	;
420		755
421	*on_player_save = sub {
422	my ($ob, $path) = @_;
423
424	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
425	for grep %$_, all_objects $ob;
426	};
427
428	#############################################################################	756	#############################################################################
429	# core extensions - in perl	757
		758	=head2 CORE EXTENSIONS
		759
		760	Functions and methods that extend core crossfire objects.
		761
		762	=over 4
430		763
431	=item cf::player::exists $login	764	=item cf::player::exists $login
432		765
433	Returns true when the given account exists.	766	Returns true when the given account exists.
434		767
…		…
474	$msg{msgid} = $id;	807	$msg{msgid} = $id;
475		808
476	$self->send ("ext " . to_json \%msg);	809	$self->send ("ext " . to_json \%msg);
477	}	810	}
478		811
479	#############################################################################	812	=back
480	# map scripting support
481		813
		814	=cut
		815
		816	#############################################################################
		817
		818	=head2 SAFE SCRIPTING
		819
		820	Functions that provide a safe environment to compile and execute
		821	snippets of perl code without them endangering the safety of the server
		822	itself. Looping constructs, I/O operators and other built-in functionality
		823	is not available in the safe scripting environment, and the number of
		824	functions and methods that cna be called is greatly reduced.
		825
		826	=cut
		827
482	our $safe = new Safe "ext";	828	our $safe = new Safe "safe";
483	our $safe_hole = new Safe::Hole;	829	our $safe_hole = new Safe::Hole;
484		830
485	$SIG{FPE} = 'IGNORE';	831	$SIG{FPE} = 'IGNORE';
486		832
487	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	833	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
488		834
489	# here we export the classes and methods available to script code	835	# here we export the classes and methods available to script code
		836
		837	=pod
		838
		839	The following fucntions and emthods are available within a safe environment:
		840
		841	cf::object contr pay_amount pay_player
		842	cf::object::player player
		843	cf::player peaceful
		844
		845	=cut
490		846
491	for (	847	for (
492	["cf::object" => qw(contr pay_amount pay_player)],	848	["cf::object" => qw(contr pay_amount pay_player)],
493	["cf::object::player" => qw(player)],	849	["cf::object::player" => qw(player)],
494	["cf::player" => qw(peaceful)],	850	["cf::player" => qw(peaceful)],
495	) {	851	) {
496	no strict 'refs';	852	no strict 'refs';
497	my ($pkg, @funs) = @$_;	853	my ($pkg, @funs) = @$_;
498	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	854	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
499	for @funs;	855	for @funs;
500	}	856	}
		857
		858	=over 4
		859
		860	=item @retval = safe_eval $code, [var => value, ...]
		861
		862	Compiled and executes the given perl code snippet. additional var/value
		863	pairs result in temporary local (my) scalar variables of the given name
		864	that are available in the code snippet. Example:
		865
		866	my $five = safe_eval '$first + $second', first => 1, second => 4;
		867
		868	=cut
501		869
502	sub safe_eval($;@) {	870	sub safe_eval($;@) {
503	my ($code, %vars) = @_;	871	my ($code, %vars) = @_;
504		872
505	my $qcode = $code;	873	my $qcode = $code;
506	$qcode =~ s/"/‟/g; # not allowed in #line filenames	874	$qcode =~ s/"/‟/g; # not allowed in #line filenames
507	$qcode =~ s/\n/\\n/g;	875	$qcode =~ s/\n/\\n/g;
508		876
509	local $_;	877	local $_;
510	local @ext::cf::_safe_eval_args = values %vars;	878	local @safe::cf::_safe_eval_args = values %vars;
511		879
512	$code =	880	my $eval =
513	"do {\n"	881	"do {\n"
514	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	882	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
515	. "#line 0 \"{$qcode}\"\n"	883	. "#line 0 \"{$qcode}\"\n"
516	. $code	884	. $code
517	. "\n}"	885	. "\n}"
518	;	886	;
519		887
520	sub_generation_inc;	888	sub_generation_inc;
521	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	889	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
522	sub_generation_inc;	890	sub_generation_inc;
523		891
		892	if ($@) {
		893	warn "$@";
		894	warn "while executing safe code '$code'\n";
		895	warn "with arguments " . (join " ", %vars) . "\n";
		896	}
		897
524	wantarray ? @res : $res[0]	898	wantarray ? @res : $res[0]
525	}	899	}
		900
		901	=item cf::register_script_function $function => $cb
		902
		903	Register a function that can be called from within map/npc scripts. The
		904	function should be reasonably secure and should be put into a package name
		905	like the extension.
		906
		907	Example: register a function that gets called whenever a map script calls
		908	C<rent::overview>, as used by the C<rent> extension.
		909
		910	cf::register_script_function "rent::overview" => sub {
		911	...
		912	};
		913
		914	=cut
526		915
527	sub register_script_function {	916	sub register_script_function {
528	my ($fun, $cb) = @_;	917	my ($fun, $cb) = @_;
529		918
530	no strict 'refs';	919	no strict 'refs';
531	*{"ext::$fun"} = $safe_hole->wrap ($cb);	920	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		921	}
		922
		923	=back
		924
		925	=cut
		926
		927	#############################################################################
		928
		929	=head2 EXTENSION DATABASE SUPPORT
		930
		931	Crossfire maintains a very simple database for extension use. It can
		932	currently store anything that can be serialised using Storable, which
		933	excludes objects.
		934
		935	The parameter C<$family> should best start with the name of the extension
		936	using it, it should be unique.
		937
		938	=over 4
		939
		940	=item $hashref = cf::db_get $family
		941
		942	Return a hashref for use by the extension C<$family>, which can be
		943	modified. After modifications, you have to call C<cf::db_dirty> or
		944	C<cf::db_sync>.
		945
		946	=item $value = cf::db_get $family => $key
		947
		948	Returns a single value from the database
		949
		950	=item cf::db_put $family => $hashref
		951
		952	Stores the given family hashref into the database. Updates are delayed, if
		953	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		954
		955	=item cf::db_put $family => $key => $value
		956
		957	Stores the given C<$value> in the family hash. Updates are delayed, if you
		958	want the data to be synced to disk immediately, use C<cf::db_sync>.
		959
		960	=item cf::db_dirty
		961
		962	Marks the database as dirty, to be updated at a later time.
		963
		964	=item cf::db_sync
		965
		966	Immediately write the database to disk I<if it is dirty>.
		967
		968	=cut
		969
		970	{
		971	my $db;
		972	my $path = cf::localdir . "/database.pst";
		973
		974	sub db_load() {
		975	warn "loading database $path\n";#d# remove later
		976	$db = stat $path ? Storable::retrieve $path : { };
		977	}
		978
		979	my $pid;
		980
		981	sub db_save() {
		982	warn "saving database $path\n";#d# remove later
		983	waitpid $pid, 0 if $pid;
		984	if (0 == ($pid = fork)) {
		985	$db->{_meta}{version} = 1;
		986	Storable::nstore $db, "$path~";
		987	rename "$path~", $path;
		988	cf::_exit 0 if defined $pid;
		989	}
		990	}
		991
		992	my $dirty;
		993
		994	sub db_sync() {
		995	db_save if $dirty;
		996	undef $dirty;
		997	}
		998
		999	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		1000	db_sync;
		1001	});
		1002
		1003	sub db_dirty() {
		1004	$dirty = 1;
		1005	$idle->start;
		1006	}
		1007
		1008	sub db_get($;$) {
		1009	@_ >= 2
		1010	? $db->{$_[0]}{$_[1]}
		1011	: ($db->{$_[0]} \|\|= { })
		1012	}
		1013
		1014	sub db_put($$;$) {
		1015	if (@_ >= 3) {
		1016	$db->{$_[0]}{$_[1]} = $_[2];
		1017	} else {
		1018	$db->{$_[0]} = $_[1];
		1019	}
		1020	db_dirty;
		1021	}
		1022
		1023	attach_global
		1024	prio => 10000,
		1025	on_cleanup => sub {
		1026	db_sync;
		1027	},
		1028	;
532	}	1029	}
533		1030
534	#############################################################################	1031	#############################################################################
535	# the server's main()	1032	# the server's main()
536		1033
537	sub run {	1034	sub cfg_load {
		1035	open my $fh, "<:utf8", cf::confdir . "/config"
		1036	or return;
		1037
		1038	local $/;
		1039	*CFG = YAML::Syck::Load <$fh>;
		1040	}
		1041
		1042	sub main {
		1043	cfg_load;
		1044	db_load;
		1045	load_extensions;
538	Event::loop;	1046	Event::loop;
539	}	1047	}
540		1048
541	#############################################################################	1049	#############################################################################
542	# initialisation	1050	# initialisation
543		1051
		1052	sub _perl_reload(&) {
		1053	my ($msg) = @_;
		1054
		1055	$msg->("reloading...");
		1056
		1057	eval {
		1058	# cancel all watchers
		1059	$_->cancel for Event::all_watchers;
		1060
		1061	# unload all extensions
		1062	for (@exts) {
		1063	$msg->("unloading <$_>");
		1064	unload_extension $_;
		1065	}
		1066
		1067	# unload all modules loaded from $LIBDIR
		1068	while (my ($k, $v) = each %INC) {
		1069	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1070
		1071	$msg->("removing <$k>");
		1072	delete $INC{$k};
		1073
		1074	$k =~ s/\.pm$//;
		1075	$k =~ s/\//::/g;
		1076
		1077	if (my $cb = $k->can ("unload_module")) {
		1078	$cb->();
		1079	}
		1080
		1081	Symbol::delete_package $k;
		1082	}
		1083
		1084	# sync database to disk
		1085	cf::db_sync;
		1086
		1087	# get rid of safe::, as good as possible
		1088	Symbol::delete_package "safe::$_"
		1089	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1090
		1091	# remove register_script_function callbacks
		1092	# TODO
		1093
		1094	# unload cf.pm "a bit"
		1095	delete $INC{"cf.pm"};
		1096
		1097	# don't, removes xs symbols, too,
		1098	# and global variables created in xs
		1099	#Symbol::delete_package __PACKAGE__;
		1100
		1101	# reload cf.pm
		1102	$msg->("reloading cf.pm");
		1103	require cf;
		1104
		1105	# load config and database again
		1106	cf::cfg_load;
		1107	cf::db_load;
		1108
		1109	# load extensions
		1110	$msg->("load extensions");
		1111	cf::load_extensions;
		1112
		1113	# reattach attachments to objects
		1114	$msg->("reattach");
		1115	_global_reattach;
		1116	};
		1117	$msg->($@) if $@;
		1118
		1119	$msg->("reloaded");
		1120	};
		1121
		1122	sub perl_reload() {
		1123	_perl_reload {
		1124	warn $_[0];
		1125	print "$_[0]\n";
		1126	};
		1127	}
		1128
		1129	register_command "perl-reload", 0, sub {
		1130	my ($who, $arg) = @_;
		1131
		1132	if ($who->flag (FLAG_WIZ)) {
		1133	_perl_reload {
		1134	warn $_[0];
		1135	$who->message ($_[0]);
		1136	};
		1137	}
		1138	};
		1139
544	register "<global>", __PACKAGE__;	1140	register "<global>", __PACKAGE__;
545		1141
546	unshift @INC, $LIBDIR;	1142	unshift @INC, $LIBDIR;
547
548	load_extensions;
549		1143
550	$TICK_WATCHER = Event->timer (	1144	$TICK_WATCHER = Event->timer (
551	prio => 1,	1145	prio => 1,
552	at => $NEXT_TICK \|\| 1,	1146	at => $NEXT_TICK \|\| 1,
553	cb => sub {	1147	cb => sub {
554	cf::server_tick; # one server iteration	1148	cf::server_tick; # one server iteration
555		1149
556	my $NOW = Event::time;	1150	my $NOW = Event::time;
557	$NEXT_TICK += $TICK;	1151	$NEXT_TICK += $TICK;
558		1152
559	# if we are delayed by > 0.25 second, skip ticks	1153	# if we are delayed by four ticks, skip them all
560	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + .25;	1154	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
561		1155
562	$TICK_WATCHER->at ($NEXT_TICK);	1156	$TICK_WATCHER->at ($NEXT_TICK);
563	$TICK_WATCHER->start;	1157	$TICK_WATCHER->start;
564	},	1158	},
565	);	1159	);

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.36 by root, Thu Aug 24 14:04:29 2006 UTC vs. Revision 1.74 by root, Sun Oct 1 15:59:29 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.36 by root, Thu Aug 24 14:04:29 2006 UTC vs.
Revision 1.74 by root, Sun Oct 1 15:59:29 2006 UTC