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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.39 by root, Fri Aug 25 13:24:50 2006 UTC vs. Revision 1.81 by root, Tue Nov 7 17:38:22 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.39 by root, Fri Aug 25 13:24:50 2006 UTC vs.
Revision 1.81 by root, Tue Nov 7 17:38:22 2006 UTC