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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.15 by root, Sun Jun 11 15:02:16 2006 UTC vs. Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.15 by root, Sun Jun 11 15:02:16 2006 UTC vs.
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC