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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.33 by root, Mon Aug 21 01:51:23 2006 UTC vs. Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.33 by root, Mon Aug 21 01:51:23 2006 UTC vs.
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC