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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.71 by root, Sun Oct 1 10:59:30 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs. Revision 1.71 by root, Sun Oct 1 10:59:30 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.71 by root, Sun Oct 1 10:59:30 2006 UTC