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

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.76 by root, Mon Oct 2 15:28:36 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.76 by root, Mon Oct 2 15:28:36 2006 UTC