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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.44 by root, Sat Aug 26 08:44:06 2006 UTC vs.
Revision 1.77 by root, Sun Nov 5 11:13:01 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!
41
42	# generate property mutators
43	sub prop_gen {
44	my ($prefix, $class) = @_;
45
46	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	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
77	@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78		73
79	# we bless all objects into (empty) derived classes to force a method lookup	74	# we bless all objects into (empty) derived classes to force a method lookup
80	# within the Safe compartment.	75	# 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)) {	76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
82	no strict 'refs';	77	no strict 'refs';
83	@{"safe::$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 {
…		…
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	# object support
98		92
99	sub reattach {	93	=over 4
100	warn "reattach<@_>\n";
101	}
102		94
103	sub instantiate {	95	=cut
104	warn "instantiate<@_>\n";
105	}
106		96
107	sub clone {	97	use JSON::Syck (); # TODO# replace by JSON::PC once working
108	warn "clone<@_>\n";
109	}
110		98
111	#############################################################################	99	=item $ref = cf::from_json $json
112	# "new" plug-in system
113		100
114	=item cf::object::attach ... # NYI	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.
115		156
116	=item cf::attach_global ...	157	=item cf::attach_global ...
117		158
118	=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.
119		197
120	=item cf::attach_to_objects ...	198	=item cf::attach_to_objects ...
121		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
122	=item cf::attach_to_players ...	204	=item cf::attach_to_players ...
123		205
		206	Attach handlers to all players.
		207
124	=item cf::attach_to_maps ...	208	=item cf::attach_to_maps ...
125		209
126	prio => $number, # lower is earlier	210	Attach handlers to all maps.
127	on_xxx => \&cb,	211
128	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.
129		226
130	=cut	227	=cut
131		228
132	# 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
133	our @CB_GLOBAL = (); # registry for all global events	230	our @CB_GLOBAL = (); # registry for all global events
134	our @CB_OBJECT = ();	231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
135	our @CB_PLAYER = ();	232	our @CB_PLAYER = ();
136	our @CB_TYPE = (); # registry for type (cf-object class) based events	233	our @CB_TYPE = (); # registry for type (cf-object class) based events
137	our @CB_MAP = ();	234	our @CB_MAP = ();
138		235
		236	my %attachment;
		237
139	sub _attach_cb($\%$$$) {	238	sub _attach_cb($\%$$$) {
140	my ($registry, $undo, $event, $prio, $cb) = @_;	239	my ($registry, $undo, $event, $prio, $cb) = @_;
141		240
142	use sort 'stable';	241	use sort 'stable';
143		242
…		…
151	}	250	}
152		251
153	# attach handles attaching event callbacks	252	# attach handles attaching event callbacks
154	# 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
155	# registry (== where the callback attaches to).	254	# registry (== where the callback attaches to).
156	sub _attach(\@$\@) {	255	sub _attach(\@$@) {
157	my ($registry, $klass, $arg) = @_;	256	my ($registry, $klass, @arg) = @_;
158		257
159	my $prio = 0;	258	my $prio = 0;
160		259
161	my %undo = (	260	my %undo = (
162	registry => $registry,	261	registry => $registry,
163	cb => [],	262	cb => [],
164	);	263	);
165		264
166	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;
167		266
168	while (@$arg) {	267	while (@arg) {
169	my $type = shift @$arg;	268	my $type = shift @arg;
170		269
171	if ($type eq "prio") {	270	if ($type eq "prio") {
172	$prio = shift @$arg;	271	$prio = shift @arg;
173		272
174	} elsif ($type eq "package") {	273	} elsif ($type eq "package") {
175	my $pkg = shift @$arg;	274	my $pkg = shift @arg;
176		275
177	while (my ($name, $id) = each %cb_id) {	276	while (my ($name, $id) = each %cb_id) {
178	if (my $cb = $pkg->can ($name)) {	277	if (my $cb = $pkg->can ($name)) {
179	_attach_cb $registry, %undo, $id, $prio, $cb;	278	_attach_cb $registry, %undo, $id, $prio, $cb;
180	}	279	}
181	}	280	}
182		281
183	} elsif (exists $cb_id{$type}) {	282	} elsif (exists $cb_id{$type}) {
184	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;	283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
185		284
186	} elsif (ref $type) {	285	} elsif (ref $type) {
187	warn "attaching objects not supported, ignoring.\n";	286	warn "attaching objects not supported, ignoring.\n";
188		287
189	} else {	288	} else {
190	shift @$arg;	289	shift @arg;
191	warn "attach argument '$type' not supported, ignoring.\n";	290	warn "attach argument '$type' not supported, ignoring.\n";
192	}	291	}
193	}	292	}
194		293
195	\%undo	294	\%undo
196	}	295	}
197		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
198	sub cf::object::attach {	323	*cf::object::attach =
199	die;	324	*cf::player::attach =
200	}	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	};
201		348
202	sub attach_global {	349	sub attach_global {
203	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
204	}	351	}
205		352
206	sub attach_to_type {	353	sub attach_to_type {
207	my $type = shift;	354	my $type = shift;
		355	my $subtype = shift;
		356
208	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_	357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
209	}	358	}
210		359
211	sub attach_to_objects {	360	sub attach_to_objects {
212	_attach @CB_OBJECT, KLASS_OBJECT, @_	361	_attach @CB_OBJECT, KLASS_OBJECT, @_
213	}	362	}
…		…
218		367
219	sub attach_to_maps {	368	sub attach_to_maps {
220	_attach @CB_MAP, KLASS_MAP, @_	369	_attach @CB_MAP, KLASS_MAP, @_
221	}	370	}
222		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
223	our $override;	390	our $override;
		391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
224		392
225	sub override() {	393	sub override {
226	$override = 1	394	$override = 1;
		395	@invoke_results = ();
227	}	396	}
228		397
229	sub invoke {	398	sub do_invoke {
230	my $event = shift;	399	my $event = shift;
231	my $callbacks = shift;	400	my $callbacks = shift;
232		401
		402	@invoke_results = ();
		403
233	local $override;	404	local $override;
234		405
235	for (@$callbacks) {	406	for (@$callbacks) {
236	eval { &{$_->[1]} };	407	eval { &{$_->[1]} };
237		408
238	if ($@) {	409	if ($@) {
239	warn "$@";	410	warn "$@";
240	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
241	override;	412	override;
242	}	413	}
243		414
244	return 1 if $override;	415	return 1 if $override;
245	}	416	}
246		417
247	0	418	0
248	}	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	;
249		560
250	#############################################################################	561	#############################################################################
251	# old plug-in events	562	# old plug-in events
252		563
253	sub inject_event {	564	sub inject_event {
…		…
299	}	610	}
300		611
301	sub register {	612	sub register {
302	my ($base, $pkg) = @_;	613	my ($base, $pkg) = @_;
303		614
304	for my $idx (0 .. $#PLUGIN_EVENT) {	615	#TODO
305	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
306	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
307	$hook[$idx]{$base} = $ref;
308	}
309	}
310	}	616	}
311		617
312	sub load_extension {	618	sub load_extension {
313	my ($path) = @_;	619	my ($path) = @_;
314		620
…		…
345	my ($pkg) = @_;	651	my ($pkg) = @_;
346		652
347	warn "removing extension $pkg\n";	653	warn "removing extension $pkg\n";
348		654
349	# remove hooks	655	# remove hooks
		656	#TODO
350	for my $idx (0 .. $#PLUGIN_EVENT) {	657	# for my $idx (0 .. $#PLUGIN_EVENT) {
351	delete $hook[$idx]{$pkg};	658	# delete $hook[$idx]{$pkg};
352	}	659	# }
353		660
354	# remove commands	661	# remove commands
355	for my $name (keys %command) {	662	for my $name (keys %command) {
356	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	663	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
357		664
…		…
387	eval {	694	eval {
388	load_extension $ext;	695	load_extension $ext;
389	1	696	1
390	} or warn "$ext not loaded: $@";	697	} or warn "$ext not loaded: $@";
391	}	698	}
392	}
393
394	sub _perl_reload(&) {
395	my ($msg) = @_;
396
397	$msg->("reloading...");
398
399	eval {
400	# 1. cancel all watchers
401	$_->cancel for Event::all_watchers;
402
403	# 2. unload all extensions
404	for (@exts) {
405	$msg->("unloading <$_>");
406	unload_extension $_;
407	}
408
409	# 3. unload all modules loaded from $LIBDIR
410	while (my ($k, $v) = each %INC) {
411	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
412
413	$msg->("removing <$k>");
414	delete $INC{$k};
415
416	$k =~ s/\.pm$//;
417	$k =~ s/\//::/g;
418
419	if (my $cb = $k->can ("unload_module")) {
420	$cb->();
421	}
422
423	Symbol::delete_package $k;
424	}
425
426	# 4. get rid of safe::, as good as possible
427	Symbol::delete_package "safe::$_"
428	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
429
430	# 5. remove register_script_function callbacks
431	# TODO
432
433	# 6. unload cf.pm "a bit"
434	delete $INC{"cf.pm"};
435
436	# don't, removes xs symbols, too,
437	# and global variables created in xs
438	#Symbol::delete_package __PACKAGE__;
439
440	# 7. reload cf.pm
441	$msg->("reloading cf.pm");
442	require cf;
443	};
444	$msg->($@) if $@;
445
446	$msg->("reloaded");
447	};
448
449	sub perl_reload() {
450	_perl_reload {
451	warn $_[0];
452	print "$_[0]\n";
453	};
454	}
455
456	register_command "perl-reload", 0, sub {
457	my ($who, $arg) = @_;
458
459	if ($who->flag (FLAG_WIZ)) {
460	_perl_reload {
461	warn $_[0];
462	$who->message ($_[0]);
463	};
464	}
465	};
466
467	#############################################################################
468	# utility functions
469
470	use JSON::Syck (); # TODO# replace by JSON::PC once working
471
472	sub from_json($) {
473	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
474	JSON::Syck::Load $_[0]
475	}
476
477	sub to_json($) {
478	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
479	JSON::Syck::Dump $_[0]
480	}	699	}
481		700
482	#############################################################################	701	#############################################################################
483	# extcmd framework, basically convert ext <msg>	702	# extcmd framework, basically convert ext <msg>
484	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	703	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
…		…
510	my ($map) = @_;	729	my ($map) = @_;
511		730
512	my $path = $map->tmpname;	731	my $path = $map->tmpname;
513	defined $path or return;	732	defined $path or return;
514		733
515	unlink "$path.cfperl";	734	unlink "$path.pst";
516	};
517
518	*cf::mapsupport::on_swapin =
519	*cf::mapsupport::on_load = sub {
520	my ($map) = @_;
521
522	my $path = $map->tmpname;
523	$path = $map->path unless defined $path;
524
525	open my $fh, "<:raw", "$path.cfperl"
526	or return; # no perl data
527
528	my $data = Storable::thaw do { local $/; <$fh> };
529
530	$data->{version} <= 1
531	or return; # too new
532
533	$map->_set_obs ($data->{obs});
534	};
535
536	*cf::mapsupport::on_swapout = sub {
537	my ($map) = @_;
538
539	my $path = $map->tmpname;
540	$path = $map->path unless defined $path;
541
542	my $obs = $map->_get_obs;
543
544	if (defined $obs) {
545	open my $fh, ">:raw", "$path.cfperl"
546	or die "$path.cfperl: $!";
547
548	stat $path;
549
550	print $fh Storable::nfreeze {
551	size => (stat _)[7],
552	time => (stat _)[9],
553	version => 1,
554	obs => $obs,
555	};
556
557	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
558	} else {
559	unlink "$path.cfperl";
560	}
561	};	735	};
562		736
563	attach_to_maps prio => -10000, package => cf::mapsupport::;	737	attach_to_maps prio => -10000, package => cf::mapsupport::;
564		738
565	#############################################################################	739	#############################################################################
…		…
567		741
568	sub all_objects(@) {	742	sub all_objects(@) {
569	@_, map all_objects ($_->inv), @_	743	@_, map all_objects ($_->inv), @_
570	}	744	}
571		745
		746	# TODO: compatibility cruft, remove when no longer needed
572	attach_to_players	747	attach_to_players
573	on_load => sub {	748	on_load => sub {
574	my ($pl, $path) = @_;	749	my ($pl, $path) = @_;
575		750
576	for my $o (all_objects $pl->ob) {	751	for my $o (all_objects $pl->ob) {
…		…
579		754
580	%$o = %{ Storable::thaw pack "H*", $value };	755	%$o = %{ Storable::thaw pack "H*", $value };
581	}	756	}
582	}	757	}
583	},	758	},
584	on_save => sub {
585	my ($pl, $path) = @_;
586
587	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
588	for grep %$_, all_objects $pl->ob;
589	},
590	;	759	;
591		760
592	#############################################################################	761	#############################################################################
593	# core extensions - in perl	762
		763	=head2 CORE EXTENSIONS
		764
		765	Functions and methods that extend core crossfire objects.
		766
		767	=over 4
594		768
595	=item cf::player::exists $login	769	=item cf::player::exists $login
596		770
597	Returns true when the given account exists.	771	Returns true when the given account exists.
598		772
…		…
601	sub cf::player::exists($) {	775	sub cf::player::exists($) {
602	cf::player::find $_[0]	776	cf::player::find $_[0]
603	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;
604	}	778	}
605		779
606	=item $player->reply ($npc, $msg[, $flags])	780	=item $object->reply ($npc, $msg[, $flags])
607		781
608	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>
609	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
610	dialogue with the given NPC character.	784	dialogue with the given NPC character.
611		785
…		…
638	$msg{msgid} = $id;	812	$msg{msgid} = $id;
639		813
640	$self->send ("ext " . to_json \%msg);	814	$self->send ("ext " . to_json \%msg);
641	}	815	}
642		816
		817	=back
		818
		819	=cut
		820
643	#############################################################################	821	#############################################################################
644	# map scripting support	822
		823	=head2 SAFE SCRIPTING
		824
		825	Functions that provide a safe environment to compile and execute
		826	snippets of perl code without them endangering the safety of the server
		827	itself. Looping constructs, I/O operators and other built-in functionality
		828	is not available in the safe scripting environment, and the number of
		829	functions and methods that cna be called is greatly reduced.
		830
		831	=cut
645		832
646	our $safe = new Safe "safe";	833	our $safe = new Safe "safe";
647	our $safe_hole = new Safe::Hole;	834	our $safe_hole = new Safe::Hole;
648		835
649	$SIG{FPE} = 'IGNORE';	836	$SIG{FPE} = 'IGNORE';
650		837
651	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	838	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
652		839
653	# here we export the classes and methods available to script code	840	# here we export the classes and methods available to script code
		841
		842	=pod
		843
		844	The following fucntions and emthods are available within a safe environment:
		845
		846	cf::object contr pay_amount pay_player
		847	cf::object::player player
		848	cf::player peaceful
		849
		850	=cut
654		851
655	for (	852	for (
656	["cf::object" => qw(contr pay_amount pay_player)],	853	["cf::object" => qw(contr pay_amount pay_player)],
657	["cf::object::player" => qw(player)],	854	["cf::object::player" => qw(player)],
658	["cf::player" => qw(peaceful)],	855	["cf::player" => qw(peaceful)],
…		…
661	my ($pkg, @funs) = @$_;	858	my ($pkg, @funs) = @$_;
662	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	859	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
663	for @funs;	860	for @funs;
664	}	861	}
665		862
		863	=over 4
		864
		865	=item @retval = safe_eval $code, [var => value, ...]
		866
		867	Compiled and executes the given perl code snippet. additional var/value
		868	pairs result in temporary local (my) scalar variables of the given name
		869	that are available in the code snippet. Example:
		870
		871	my $five = safe_eval '$first + $second', first => 1, second => 4;
		872
		873	=cut
		874
666	sub safe_eval($;@) {	875	sub safe_eval($;@) {
667	my ($code, %vars) = @_;	876	my ($code, %vars) = @_;
668		877
669	my $qcode = $code;	878	my $qcode = $code;
670	$qcode =~ s/"/‟/g; # not allowed in #line filenames	879	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
692	}	901	}
693		902
694	wantarray ? @res : $res[0]	903	wantarray ? @res : $res[0]
695	}	904	}
696		905
		906	=item cf::register_script_function $function => $cb
		907
		908	Register a function that can be called from within map/npc scripts. The
		909	function should be reasonably secure and should be put into a package name
		910	like the extension.
		911
		912	Example: register a function that gets called whenever a map script calls
		913	C<rent::overview>, as used by the C<rent> extension.
		914
		915	cf::register_script_function "rent::overview" => sub {
		916	...
		917	};
		918
		919	=cut
		920
697	sub register_script_function {	921	sub register_script_function {
698	my ($fun, $cb) = @_;	922	my ($fun, $cb) = @_;
699		923
700	no strict 'refs';	924	no strict 'refs';
701	*{"safe::$fun"} = $safe_hole->wrap ($cb);	925	*{"safe::$fun"} = $safe_hole->wrap ($cb);
702	}	926	}
703		927
		928	=back
		929
		930	=cut
		931
		932	#############################################################################
		933
		934	=head2 EXTENSION DATABASE SUPPORT
		935
		936	Crossfire maintains a very simple database for extension use. It can
		937	currently store anything that can be serialised using Storable, which
		938	excludes objects.
		939
		940	The parameter C<$family> should best start with the name of the extension
		941	using it, it should be unique.
		942
		943	=over 4
		944
		945	=item $hashref = cf::db_get $family
		946
		947	Return a hashref for use by the extension C<$family>, which can be
		948	modified. After modifications, you have to call C<cf::db_dirty> or
		949	C<cf::db_sync>.
		950
		951	=item $value = cf::db_get $family => $key
		952
		953	Returns a single value from the database
		954
		955	=item cf::db_put $family => $hashref
		956
		957	Stores the given family hashref into the database. Updates are delayed, if
		958	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		959
		960	=item cf::db_put $family => $key => $value
		961
		962	Stores the given C<$value> in the family hash. Updates are delayed, if you
		963	want the data to be synced to disk immediately, use C<cf::db_sync>.
		964
		965	=item cf::db_dirty
		966
		967	Marks the database as dirty, to be updated at a later time.
		968
		969	=item cf::db_sync
		970
		971	Immediately write the database to disk I<if it is dirty>.
		972
		973	=cut
		974
		975	{
		976	my $db;
		977	my $path = cf::localdir . "/database.pst";
		978
		979	sub db_load() {
		980	warn "loading database $path\n";#d# remove later
		981	$db = stat $path ? Storable::retrieve $path : { };
		982	}
		983
		984	my $pid;
		985
		986	sub db_save() {
		987	warn "saving database $path\n";#d# remove later
		988	waitpid $pid, 0 if $pid;
		989	if (0 == ($pid = fork)) {
		990	$db->{_meta}{version} = 1;
		991	Storable::nstore $db, "$path~";
		992	rename "$path~", $path;
		993	cf::_exit 0 if defined $pid;
		994	}
		995	}
		996
		997	my $dirty;
		998
		999	sub db_sync() {
		1000	db_save if $dirty;
		1001	undef $dirty;
		1002	}
		1003
		1004	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		1005	db_sync;
		1006	});
		1007
		1008	sub db_dirty() {
		1009	$dirty = 1;
		1010	$idle->start;
		1011	}
		1012
		1013	sub db_get($;$) {
		1014	@_ >= 2
		1015	? $db->{$_[0]}{$_[1]}
		1016	: ($db->{$_[0]} \|\|= { })
		1017	}
		1018
		1019	sub db_put($$;$) {
		1020	if (@_ >= 3) {
		1021	$db->{$_[0]}{$_[1]} = $_[2];
		1022	} else {
		1023	$db->{$_[0]} = $_[1];
		1024	}
		1025	db_dirty;
		1026	}
		1027
		1028	attach_global
		1029	prio => 10000,
		1030	on_cleanup => sub {
		1031	db_sync;
		1032	},
		1033	;
		1034	}
		1035
704	#############################################################################	1036	#############################################################################
705	# the server's main()	1037	# the server's main()
706		1038
		1039	sub cfg_load {
		1040	open my $fh, "<:utf8", cf::confdir . "/config"
		1041	or return;
		1042
		1043	local $/;
		1044	*CFG = YAML::Syck::Load <$fh>;
		1045	}
		1046
707	sub main {	1047	sub main {
		1048	cfg_load;
		1049	db_load;
		1050	load_extensions;
708	Event::loop;	1051	Event::loop;
709	}	1052	}
710		1053
711	#############################################################################	1054	#############################################################################
712	# initialisation	1055	# initialisation
713		1056
		1057	sub _perl_reload(&) {
		1058	my ($msg) = @_;
		1059
		1060	$msg->("reloading...");
		1061
		1062	eval {
		1063	# cancel all watchers
		1064	$_->cancel for Event::all_watchers;
		1065
		1066	# unload all extensions
		1067	for (@exts) {
		1068	$msg->("unloading <$_>");
		1069	unload_extension $_;
		1070	}
		1071
		1072	# unload all modules loaded from $LIBDIR
		1073	while (my ($k, $v) = each %INC) {
		1074	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1075
		1076	$msg->("removing <$k>");
		1077	delete $INC{$k};
		1078
		1079	$k =~ s/\.pm$//;
		1080	$k =~ s/\//::/g;
		1081
		1082	if (my $cb = $k->can ("unload_module")) {
		1083	$cb->();
		1084	}
		1085
		1086	Symbol::delete_package $k;
		1087	}
		1088
		1089	# sync database to disk
		1090	cf::db_sync;
		1091
		1092	# get rid of safe::, as good as possible
		1093	Symbol::delete_package "safe::$_"
		1094	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1095
		1096	# remove register_script_function callbacks
		1097	# TODO
		1098
		1099	# unload cf.pm "a bit"
		1100	delete $INC{"cf.pm"};
		1101
		1102	# don't, removes xs symbols, too,
		1103	# and global variables created in xs
		1104	#Symbol::delete_package __PACKAGE__;
		1105
		1106	# reload cf.pm
		1107	$msg->("reloading cf.pm");
		1108	require cf;
		1109
		1110	# load config and database again
		1111	cf::cfg_load;
		1112	cf::db_load;
		1113
		1114	# load extensions
		1115	$msg->("load extensions");
		1116	cf::load_extensions;
		1117
		1118	# reattach attachments to objects
		1119	$msg->("reattach");
		1120	_global_reattach;
		1121	};
		1122	$msg->($@) if $@;
		1123
		1124	$msg->("reloaded");
		1125	};
		1126
		1127	sub perl_reload() {
		1128	_perl_reload {
		1129	warn $_[0];
		1130	print "$_[0]\n";
		1131	};
		1132	}
		1133
		1134	register_command "perl-reload", 0, sub {
		1135	my ($who, $arg) = @_;
		1136
		1137	if ($who->flag (FLAG_WIZ)) {
		1138	_perl_reload {
		1139	warn $_[0];
		1140	$who->message ($_[0]);
		1141	};
		1142	}
		1143	};
		1144
714	register "<global>", __PACKAGE__;	1145	register "<global>", __PACKAGE__;
715		1146
716	unshift @INC, $LIBDIR;	1147	unshift @INC, $LIBDIR;
717		1148
718	load_extensions;
719
720	$TICK_WATCHER = Event->timer (	1149	$TICK_WATCHER = Event->timer (
721	prio => 1,	1150	prio => 1,
		1151	async => 1,
722	at => $NEXT_TICK \|\| 1,	1152	at => $NEXT_TICK \|\| 1,
723	cb => sub {	1153	cb => sub {
724	cf::server_tick; # one server iteration	1154	cf::server_tick; # one server iteration
725		1155
726	my $NOW = Event::time;	1156	my $NOW = Event::time;
727	$NEXT_TICK += $TICK;	1157	$NEXT_TICK += $TICK;
728		1158
…		…
732	$TICK_WATCHER->at ($NEXT_TICK);	1162	$TICK_WATCHER->at ($NEXT_TICK);
733	$TICK_WATCHER->start;	1163	$TICK_WATCHER->start;
734	},	1164	},
735	);	1165	);
736		1166
		1167	IO::AIO::max_poll_time $TICK * 0.2;
		1168
		1169	Event->io (fd => IO::AIO::poll_fileno,
		1170	poll => 'r',
		1171	prio => 5,
		1172	cb => \&IO::AIO::poll_cb);
		1173
737	1	1174	1
738		1175

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.44 by root, Sat Aug 26 08:44:06 2006 UTC vs. Revision 1.77 by root, Sun Nov 5 11:13:01 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.44 by root, Sat Aug 26 08:44:06 2006 UTC vs.
Revision 1.77 by root, Sun Nov 5 11:13:01 2006 UTC