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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.43 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.43 by root, Fri Aug 25 17:11:53 2006 UTC vs. Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.43 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC