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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.12 by root, Tue Mar 28 16:48:11 2006 UTC vs.
Revision 1.78 by root, Tue Nov 7 00:15:27 2006 UTC

…		…
1	package cf;	1	package cf;
2		2
3	use Symbol;	3	use Symbol;
4	use List::Util;	4	use List::Util;
5	use Storable;	5	use Storable;
		6	use Opcode;
		7	use Safe;
		8	use Safe::Hole;
		9
		10	use IO::AIO ();
		11	use YAML::Syck ();
		12	use Time::HiRes;
		13	use Event;
		14	$Event::Eval = 1; # no idea why this is required, but it is
		15
		16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		17	$YAML::Syck::ImplicitUnicode = 1;
6		18
7	use strict;	19	use strict;
8		20
		21	_init_vars;
		22
9	our %COMMAND;	23	our %COMMAND = ();
10	our @EVENT;	24	our @EVENT;
11	our %PROP_TYPE;	25	our $LIBDIR = maps_directory "perl";
12	our %PROP_IDX;	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
13		60
14	BEGIN {	61	BEGIN {
15	@EVENT = map lc, @EVENT;
16
17	*CORE::GLOBAL::warn = sub {	62	*CORE::GLOBAL::warn = sub {
18	my $msg = join "", @_;	63	my $msg = join "", @_;
19	$msg .= "\n"	64	$msg .= "\n"
20	unless $msg =~ /\n$/;	65	unless $msg =~ /\n$/;
21		66
22	print STDERR "cfperl: $msg";	67	print STDERR "cfperl: $msg";
23	LOG llevError, "cfperl: $msg";	68	LOG llevError, "cfperl: $msg";
24	};	69	};
25	}	70	}
26		71
27	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';
28		73
29	# generate property mutators	74	# we bless all objects into (empty) derived classes to force a method lookup
30	sub prop_gen {	75	# within the Safe compartment.
31	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)) {
32
33	no strict 'refs';	77	no strict 'refs';
34		78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
35	for my $prop (keys %PROP_TYPE) {
36	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
37	my $sub = lc $1;
38
39	my $type = $PROP_TYPE{$prop};
40	my $idx = $PROP_IDX {$prop};
41
42	{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
43	$_[0]->get_property ($type, $idx)
44	};
45
46	*{"$class\::set_$sub"} = sub {
47	$_[0]->set_property ($type, $idx, $_[1]);
48	} unless $ignore_set{$prop};
49	}
50	}	79	}
51		80
52	# auto-generate most of the API	81	$Event::DIED = sub {
53		82	warn "error in event callback: @_";
54	prop_gen OBJECT_PROP => "cf::object";	83	};
55	# CFAPI_OBJECT_ANIMATION?
56	prop_gen PLAYER_PROP => "cf::object::player";
57
58	prop_gen MAP_PROP => "cf::map";
59	prop_gen ARCH_PROP => "cf::arch";
60
61	# guessed hierarchies
62
63	@cf::object::player::ISA = 'cf::object';
64	@cf::object::map::ISA = 'cf::object';
65		84
66	my %ext_pkg;	85	my %ext_pkg;
67	my @exts;	86	my @exts;
68	my @hook;	87	my @hook;
69	my %command;	88	my %command;
		89	my %extcmd;
		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_thawer_load {
		529	my ($filename) = @_;
		530
		531	local $/;
		532
		533	my $av;
		534
		535	#TODO: use sysread etc.
		536	if (open my $data, "<:raw:perlio", $filename) {
		537	$data = <$data>;
		538	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		539	$av = eval { (Storable::thaw <$pst>)->{objs} };
		540	}
		541	return ($data, $av);
		542	}
		543
		544	()
		545	}
		546
		547	attach_to_objects
		548	prio => -1000000,
		549	on_clone => sub {
		550	my ($src, $dst) = @_;
		551
		552	@{$dst->registry} = @{$src->registry};
		553
		554	%$dst = %$src;
		555
		556	%{$dst->{_attachment}} = %{$src->{_attachment}}
		557	if exists $src->{_attachment};
		558	},
		559	;
		560
		561	#############################################################################
		562	# old plug-in events
70		563
71	sub inject_event {	564	sub inject_event {
72	my ($data) = @_;	565	my $extension = shift;
		566	my $event_code = shift;
73		567
74	my $cb = $hook[$data->{event_code}]{$data->{extension}}	568	my $cb = $hook[$event_code]{$extension}
75	or return;	569	or return;
76		570
77	$cb->($data)	571	&$cb
78	}	572	}
79		573
80	sub inject_global_event {	574	sub inject_global_event {
81	my $event = shift;	575	my $event = shift;
82		576
98		592
99	sub register_command {	593	sub register_command {
100	my ($name, $time, $cb) = @_;	594	my ($name, $time, $cb) = @_;
101		595
102	my $caller = caller;	596	my $caller = caller;
103
104	warn "registering command '$name/$time' to '$caller'";	597	#warn "registering command '$name/$time' to '$caller'";
105		598
106	push @{ $command{$name} }, [$time, $cb, $caller];	599	push @{ $command{$name} }, [$time, $cb, $caller];
107	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };	600	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
108	}	601	}
109		602
		603	sub register_extcmd {
		604	my ($name, $cb) = @_;
		605
		606	my $caller = caller;
		607	#warn "registering extcmd '$name' to '$caller'";
		608
		609	$extcmd{$name} = [$cb, $caller];
		610	}
		611
110	sub register {	612	sub register {
111	my ($base, $pkg) = @_;	613	my ($base, $pkg) = @_;
112		614
113	for my $idx (0 .. $#EVENT) {	615	#TODO
114	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
115	warn "registering $EVENT[$idx] hook to '$pkg'\n";
116	$hook[$idx]{$base} = $ref;
117	}
118	}
119	}	616	}
120		617
121	sub load_extension {	618	sub load_extension {
122	my ($path) = @_;	619	my ($path) = @_;
123		620
124	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	621	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
125	my $base = $1;	622	my $base = $1;
126	my $pkg = $1;	623	my $pkg = $1;
127	$pkg =~ s/[^[:word:]]/_/g;	624	$pkg =~ s/[^[:word:]]/_/g;
128	$pkg = "cf::ext::$pkg";	625	$pkg = "ext::$pkg";
129		626
130	warn "loading '$path' into '$pkg'\n";	627	warn "loading '$path' into '$pkg'\n";
131		628
132	open my $fh, "<:utf8", $path	629	open my $fh, "<:utf8", $path
133	or die "$path: $!";	630	or die "$path: $!";
…		…
143		640
144	push @exts, $pkg;	641	push @exts, $pkg;
145	$ext_pkg{$base} = $pkg;	642	$ext_pkg{$base} = $pkg;
146		643
147	# no strict 'refs';	644	# no strict 'refs';
148	# @{"$pkg\::ISA"} = cf::ext::;	645	# @{"$pkg\::ISA"} = ext::;
149		646
150	register $base, $pkg;	647	register $base, $pkg;
151	}	648	}
152		649
153	sub unload_extension {	650	sub unload_extension {
154	my ($pkg) = @_;	651	my ($pkg) = @_;
155		652
156	warn "removing extension $pkg\n";	653	warn "removing extension $pkg\n";
157		654
158	# remove hooks	655	# remove hooks
		656	#TODO
159	for my $idx (0 .. $#EVENT) {	657	# for my $idx (0 .. $#PLUGIN_EVENT) {
160	delete $hook[$idx]{$pkg};	658	# delete $hook[$idx]{$pkg};
161	}	659	# }
162		660
163	# remove commands	661	# remove commands
164	for my $name (keys %command) {	662	for my $name (keys %command) {
165	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	663	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
166		664
…		…
171	delete $command{$name};	669	delete $command{$name};
172	delete $COMMAND{"$name\000"};	670	delete $COMMAND{"$name\000"};
173	}	671	}
174	}	672	}
175		673
		674	# remove extcmds
		675	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
		676	delete $extcmd{$name};
		677	}
		678
		679	if (my $cb = $pkg->can ("unload")) {
		680	eval {
		681	$cb->($pkg);
		682	1
		683	} or warn "$pkg unloaded, but with errors: $@";
		684	}
		685
176	Symbol::delete_package $pkg;	686	Symbol::delete_package $pkg;
177	}	687	}
178		688
179	sub load_extensions {	689	sub load_extensions {
180	my $LIBDIR = maps_directory "perl";	690	my $LIBDIR = maps_directory "perl";
…		…
186	1	696	1
187	} or warn "$ext not loaded: $@";	697	} or warn "$ext not loaded: $@";
188	}	698	}
189	}	699	}
190		700
		701	#############################################################################
		702	# extcmd framework, basically convert ext <msg>
		703	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
		704
		705	attach_to_players
		706	on_extcmd => sub {
		707	my ($pl, $buf) = @_;
		708
		709	my $msg = eval { from_json $buf };
		710
		711	if (ref $msg) {
		712	if (my $cb = $extcmd{$msg->{msgtype}}) {
		713	if (my %reply = $cb->[0]->($pl, $msg)) {
		714	$pl->ext_reply ($msg->{msgid}, %reply);
		715	}
		716	}
		717	} else {
		718	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		719	}
		720
		721	cf::override;
		722	},
		723	;
		724
		725	#############################################################################
		726	# load/save/clean perl data associated with a map
		727
		728	*cf::mapsupport::on_clean = sub {
		729	my ($map) = @_;
		730
		731	my $path = $map->tmpname;
		732	defined $path or return;
		733
		734	unlink "$path.pst";
		735	};
		736
		737	attach_to_maps prio => -10000, package => cf::mapsupport::;
		738
		739	#############################################################################
		740	# load/save perl data associated with player->ob objects
		741
		742	sub all_objects(@) {
		743	@_, map all_objects ($_->inv), @_
		744	}
		745
		746	# TODO: compatibility cruft, remove when no longer needed
		747	attach_to_players
		748	on_load => sub {
		749	my ($pl, $path) = @_;
		750
		751	for my $o (all_objects $pl->ob) {
		752	if (my $value = $o->get_ob_key_value ("_perl_data")) {
		753	$o->set_ob_key_value ("_perl_data");
		754
		755	%$o = %{ Storable::thaw pack "H*", $value };
		756	}
		757	}
		758	},
		759	;
		760
		761	#############################################################################
		762
		763	=head2 CORE EXTENSIONS
		764
		765	Functions and methods that extend core crossfire objects.
		766
		767	=over 4
		768
		769	=item cf::player::exists $login
		770
		771	Returns true when the given account exists.
		772
		773	=cut
		774
		775	sub cf::player::exists($) {
		776	cf::player::find $_[0]
		777	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
		778	}
		779
		780	=item $object->reply ($npc, $msg[, $flags])
		781
		782	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
		783	can be C<undef>. Does the right thing when the player is currently in a
		784	dialogue with the given NPC character.
		785
		786	=cut
		787
		788	# rough implementation of a future "reply" method that works
		789	# with dialog boxes.
		790	sub cf::object::player::reply($$$;$) {
		791	my ($self, $npc, $msg, $flags) = @_;
		792
		793	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
		794
		795	if ($self->{record_replies}) {
		796	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		797	} else {
		798	$msg = $npc->name . " says: $msg" if $npc;
		799	$self->message ($msg, $flags);
		800	}
		801	}
		802
		803	=item $player->ext_reply ($msgid, $msgtype, %msg)
		804
		805	Sends an ext reply to the player.
		806
		807	=cut
		808
		809	sub cf::player::ext_reply($$$%) {
		810	my ($self, $id, %msg) = @_;
		811
		812	$msg{msgid} = $id;
		813
		814	$self->send ("ext " . to_json \%msg);
		815	}
		816
		817	=back
		818
		819	=cut
		820
		821	#############################################################################
		822
		823	=head2 SAFE SCRIPTING
		824
		825	Functions that provide a safe environment to compile and execute
		826	snippets of perl code without them endangering the safety of the server
		827	itself. Looping constructs, I/O operators and other built-in functionality
		828	is not available in the safe scripting environment, and the number of
		829	functions and methods that cna be called is greatly reduced.
		830
		831	=cut
		832
		833	our $safe = new Safe "safe";
		834	our $safe_hole = new Safe::Hole;
		835
		836	$SIG{FPE} = 'IGNORE';
		837
		838	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
		839
		840	# here we export the classes and methods available to script code
		841
		842	=pod
		843
		844	The following fucntions and emthods are available within a safe environment:
		845
		846	cf::object contr pay_amount pay_player
		847	cf::object::player player
		848	cf::player peaceful
		849
		850	=cut
		851
		852	for (
		853	["cf::object" => qw(contr pay_amount pay_player)],
		854	["cf::object::player" => qw(player)],
		855	["cf::player" => qw(peaceful)],
		856	) {
		857	no strict 'refs';
		858	my ($pkg, @funs) = @$_;
		859	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
		860	for @funs;
		861	}
		862
		863	=over 4
		864
		865	=item @retval = safe_eval $code, [var => value, ...]
		866
		867	Compiled and executes the given perl code snippet. additional var/value
		868	pairs result in temporary local (my) scalar variables of the given name
		869	that are available in the code snippet. Example:
		870
		871	my $five = safe_eval '$first + $second', first => 1, second => 4;
		872
		873	=cut
		874
		875	sub safe_eval($;@) {
		876	my ($code, %vars) = @_;
		877
		878	my $qcode = $code;
		879	$qcode =~ s/"/‟/g; # not allowed in #line filenames
		880	$qcode =~ s/\n/\\n/g;
		881
		882	local $_;
		883	local @safe::cf::_safe_eval_args = values %vars;
		884
		885	my $eval =
		886	"do {\n"
		887	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
		888	. "#line 0 \"{$qcode}\"\n"
		889	. $code
		890	. "\n}"
		891	;
		892
		893	sub_generation_inc;
		894	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
		895	sub_generation_inc;
		896
		897	if ($@) {
		898	warn "$@";
		899	warn "while executing safe code '$code'\n";
		900	warn "with arguments " . (join " ", %vars) . "\n";
		901	}
		902
		903	wantarray ? @res : $res[0]
		904	}
		905
		906	=item cf::register_script_function $function => $cb
		907
		908	Register a function that can be called from within map/npc scripts. The
		909	function should be reasonably secure and should be put into a package name
		910	like the extension.
		911
		912	Example: register a function that gets called whenever a map script calls
		913	C<rent::overview>, as used by the C<rent> extension.
		914
		915	cf::register_script_function "rent::overview" => sub {
		916	...
		917	};
		918
		919	=cut
		920
		921	sub register_script_function {
		922	my ($fun, $cb) = @_;
		923
		924	no strict 'refs';
		925	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		926	}
		927
		928	=back
		929
		930	=cut
		931
		932	#############################################################################
		933
		934	=head2 EXTENSION DATABASE SUPPORT
		935
		936	Crossfire maintains a very simple database for extension use. It can
		937	currently store anything that can be serialised using Storable, which
		938	excludes objects.
		939
		940	The parameter C<$family> should best start with the name of the extension
		941	using it, it should be unique.
		942
		943	=over 4
		944
		945	=item $hashref = cf::db_get $family
		946
		947	Return a hashref for use by the extension C<$family>, which can be
		948	modified. After modifications, you have to call C<cf::db_dirty> or
		949	C<cf::db_sync>.
		950
		951	=item $value = cf::db_get $family => $key
		952
		953	Returns a single value from the database
		954
		955	=item cf::db_put $family => $hashref
		956
		957	Stores the given family hashref into the database. Updates are delayed, if
		958	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		959
		960	=item cf::db_put $family => $key => $value
		961
		962	Stores the given C<$value> in the family hash. Updates are delayed, if you
		963	want the data to be synced to disk immediately, use C<cf::db_sync>.
		964
		965	=item cf::db_dirty
		966
		967	Marks the database as dirty, to be updated at a later time.
		968
		969	=item cf::db_sync
		970
		971	Immediately write the database to disk I<if it is dirty>.
		972
		973	=cut
		974
		975	our $DB;
		976
		977	{
		978	my $path = cf::localdir . "/database.pst";
		979
		980	sub db_load() {
		981	warn "loading database $path\n";#d# remove later
		982	$DB = stat $path ? Storable::retrieve $path : { };
		983	}
		984
		985	my $pid;
		986
		987	sub db_save() {
		988	warn "saving database $path\n";#d# remove later
		989	waitpid $pid, 0 if $pid;
		990	if (0 == ($pid = fork)) {
		991	$DB->{_meta}{version} = 1;
		992	Storable::nstore $DB, "$path~";
		993	rename "$path~", $path;
		994	cf::_exit 0 if defined $pid;
		995	}
		996	}
		997
		998	my $dirty;
		999
		1000	sub db_sync() {
		1001	db_save if $dirty;
		1002	undef $dirty;
		1003	}
		1004
		1005	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		1006	db_sync;
		1007	});
		1008
		1009	sub db_dirty() {
		1010	$dirty = 1;
		1011	$idle->start;
		1012	}
		1013
		1014	sub db_get($;$) {
		1015	@_ >= 2
		1016	? $DB->{$_[0]}{$_[1]}
		1017	: ($DB->{$_[0]} \|\|= { })
		1018	}
		1019
		1020	sub db_put($$;$) {
		1021	if (@_ >= 3) {
		1022	$DB->{$_[0]}{$_[1]} = $_[2];
		1023	} else {
		1024	$DB->{$_[0]} = $_[1];
		1025	}
		1026	db_dirty;
		1027	}
		1028
		1029	attach_global
		1030	prio => 10000,
		1031	on_cleanup => sub {
		1032	db_sync;
		1033	},
		1034	;
		1035	}
		1036
		1037	#############################################################################
		1038	# the server's main()
		1039
		1040	sub cfg_load {
		1041	open my $fh, "<:utf8", cf::confdir . "/config"
		1042	or return;
		1043
		1044	local $/;
		1045	*CFG = YAML::Syck::Load <$fh>;
		1046	}
		1047
		1048	sub main {
		1049	cfg_load;
		1050	db_load;
		1051	load_extensions;
		1052	Event::loop;
		1053	}
		1054
		1055	#############################################################################
		1056	# initialisation
		1057
		1058	sub _perl_reload(&) {
		1059	my ($msg) = @_;
		1060
		1061	$msg->("reloading...");
		1062
		1063	eval {
		1064	# cancel all watchers
		1065	$_->cancel for Event::all_watchers;
		1066
		1067	# unload all extensions
		1068	for (@exts) {
		1069	$msg->("unloading <$_>");
		1070	unload_extension $_;
		1071	}
		1072
		1073	# unload all modules loaded from $LIBDIR
		1074	while (my ($k, $v) = each %INC) {
		1075	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1076
		1077	$msg->("removing <$k>");
		1078	delete $INC{$k};
		1079
		1080	$k =~ s/\.pm$//;
		1081	$k =~ s/\//::/g;
		1082
		1083	if (my $cb = $k->can ("unload_module")) {
		1084	$cb->();
		1085	}
		1086
		1087	Symbol::delete_package $k;
		1088	}
		1089
		1090	# sync database to disk
		1091	cf::db_sync;
		1092
		1093	# get rid of safe::, as good as possible
		1094	Symbol::delete_package "safe::$_"
		1095	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1096
		1097	# remove register_script_function callbacks
		1098	# TODO
		1099
		1100	# unload cf.pm "a bit"
		1101	delete $INC{"cf.pm"};
		1102
		1103	# don't, removes xs symbols, too,
		1104	# and global variables created in xs
		1105	#Symbol::delete_package __PACKAGE__;
		1106
		1107	# reload cf.pm
		1108	$msg->("reloading cf.pm");
		1109	require cf;
		1110
		1111	# load config and database again
		1112	cf::cfg_load;
		1113	cf::db_load;
		1114
		1115	# load extensions
		1116	$msg->("load extensions");
		1117	cf::load_extensions;
		1118
		1119	# reattach attachments to objects
		1120	$msg->("reattach");
		1121	_global_reattach;
		1122	};
		1123	$msg->($@) if $@;
		1124
		1125	$msg->("reloaded");
		1126	};
		1127
		1128	sub perl_reload() {
		1129	_perl_reload {
		1130	warn $_[0];
		1131	print "$_[0]\n";
		1132	};
		1133	}
		1134
191	register_command "perl-reload", 0, sub {	1135	register_command "perl-reload", 0, sub {
192	my ($who, $arg) = @_;	1136	my ($who, $arg) = @_;
193		1137
194	if ($who->flag (FLAG_WIZ)) {	1138	if ($who->flag (FLAG_WIZ)) {
195	$who->message ("reloading...");	1139	_perl_reload {
196		1140	warn $_[0];
197	warn "reloading...\n";	1141	$who->message ($_[0]);
198	eval {
199	unload_extension $_ for @exts;
200	delete $INC{"cf.pm"};
201
202	# don't, removes xs symbols, too
203	#Symbol::delete_package $pkg;
204
205	require cf;
206	};	1142	};
207	warn $@ if $@;
208	$who->message ($@) if $@;
209	warn "reloaded\n";
210
211	$who->message ("reloaded");
212	} else {
213	$who->message ("Intruder Alert!");
214	}	1143	}
215	};	1144	};
216		1145
217	#############################################################################
218	# load/save/clean perl data associated with a map
219
220	*on_mapclean = sub {
221	my $map = shift->{map};
222
223	my $path = $map->tmpname;
224	defined $path or return;
225
226	unlink "$path.cfperl";
227	};
228
229	*on_mapin =
230	*on_mapload = sub {
231	my $map = shift->{map};
232
233	my $path = $map->tmpname;
234	$path = $map->path unless defined $path;
235
236	open my $fh, "<:raw", "$path.cfperl"
237	or return; # no perl data
238
239	my $data = Storable::thaw do { local $/; <$fh> };
240
241	$data->{version} <= 1
242	or return; # too new
243
244	$map->_set_obs ($data->{obs});
245	};
246
247	*on_mapout = sub {
248	my $map = shift->{map};
249
250	my $path = $map->tmpname;
251	$path = $map->path unless defined $path;
252
253	my $obs = $map->_get_obs;
254
255	if (defined $obs) {
256	open my $fh, ">:raw", "$path.cfperl"
257	or die "$path.cfperl: $!";
258
259	stat $path;
260
261	print $fh Storable::nfreeze {
262	size => (stat _)[7],
263	time => (stat _)[9],
264	version => 1,
265	obs => $obs,
266	};
267
268	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
269	} else {
270	unlink "$path.cfperl";
271	}
272	};
273
274	#############################################################################
275	# load/save perl data associated with player->ob objects
276
277	*on_player_load = sub {
278	my ($event) = @_;
279	my $path = $event->{message};
280	my $ob = $event->{who};
281
282	if (open my $fh, "<:raw", "$path.cfperl") {
283
284	#d##TODO#remove
285
286	my $data = Storable::thaw do { local $/; <$fh> };
287
288	$data->{version} <= 1
289	or return; # too new
290
291	%$ob = %{$data->{ob}};
292	return;
293	}
294
295	for my $o ($ob, $ob->inv) {
296	if (my $value = $o->get_ob_key_value ("_perl_data")) {
297	$o->set_ob_key_value ("_perl_data");
298
299	%$o = %{ Storable::thaw pack "H*", $value };
300	}
301	}
302	};
303
304	*on_player_save = sub {
305	my ($event) = @_;
306	my $path = $event->{message};
307	my $ob = $event->{who};
308
309	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
310	for grep %$_, $ob, $ob->inv;
311
312	unlink "$path.cfperl";#d##TODO#remove
313	};
314
315	register "<global>", __PACKAGE__;	1146	register "<global>", __PACKAGE__;
316		1147
317	load_extensions;	1148	unshift @INC, $LIBDIR;
		1149
		1150	$TICK_WATCHER = Event->timer (
		1151	prio => 1,
		1152	async => 1,
		1153	at => $NEXT_TICK \|\| 1,
		1154	cb => sub {
		1155	cf::server_tick; # one server iteration
		1156
		1157	my $NOW = Event::time;
		1158	$NEXT_TICK += $TICK;
		1159
		1160	# if we are delayed by four ticks or more, skip them all
		1161	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
		1162
		1163	$TICK_WATCHER->at ($NEXT_TICK);
		1164	$TICK_WATCHER->start;
		1165	},
		1166	);
		1167
		1168	eval { IO::AIO::max_poll_time $TICK * 0.2 }; #d# remove eval after restart
		1169
		1170	Event->io (fd => IO::AIO::poll_fileno,
		1171	poll => 'r',
		1172	prio => 5,
		1173	cb => \&IO::AIO::poll_cb);
318		1174
319	1	1175	1
320		1176

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.12 by root, Tue Mar 28 16:48:11 2006 UTC vs. Revision 1.78 by root, Tue Nov 7 00:15:27 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.12 by root, Tue Mar 28 16:48:11 2006 UTC vs.
Revision 1.78 by root, Tue Nov 7 00:15:27 2006 UTC