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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.40 by root, Fri Aug 25 15:21:57 2006 UTC vs. Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.40 by root, Fri Aug 25 15:21:57 2006 UTC vs.
Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC