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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.30 by elmex, Sat Aug 12 11:51:37 2006 UTC vs. Revision 1.82 by root, Sun Dec 3 20:59:52 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.30 by elmex, Sat Aug 12 11:51:37 2006 UTC vs.
Revision 1.82 by root, Sun Dec 3 20:59:52 2006 UTC