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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.47 by root, Sun Aug 27 13:02:04 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;
15		19
16	_reload_1;	20	_init_vars;
17		21
18	our %COMMAND = ();	22	our %COMMAND = ();
19	our @EVENT;	23	our @EVENT;
20	our %PROP_TYPE;
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";	24	our $LIBDIR = maps_directory "perl";
23		25
24	our $TICK = MAX_TIME * 1e-6;	26	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	27	our $TICK_WATCHER;
26	our $NEXT_TICK;	28	our $NEXT_TICK;
		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
27		59
28	BEGIN {	60	BEGIN {
29	*CORE::GLOBAL::warn = sub {	61	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	62	my $msg = join "", @_;
31	$msg .= "\n"	63	$msg .= "\n"
…		…
34	print STDERR "cfperl: $msg";	66	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	67	LOG llevError, "cfperl: $msg";
36	};	68	};
37	}	69	}
38		70
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
41	# generate property mutators
42	sub prop_gen {
43	my ($prefix, $class) = @_;
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	71	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		72
75	# 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
76	# within the Safe compartment.	74	# within the Safe compartment.
77	for my $pkg (qw(cf::object 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)) {
78	no strict 'refs';	76	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	78	}
81		79
82	$Event::DIED = sub {	80	$Event::DIED = sub {
…		…
87	my @exts;	85	my @exts;
88	my @hook;	86	my @hook;
89	my %command;	87	my %command;
90	my %extcmd;	88	my %extcmd;
91		89
92	#############################################################################	90	=head2 UTILITY FUNCTIONS
93	# utility functions	91
		92	=over 4
		93
		94	=cut
94		95
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	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
96		103
97	sub from_json($) {	104	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	105	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	106	JSON::Syck::Load $_[0]
100	}	107	}
101		108
		109	=item $json = cf::to_json $ref
		110
		111	Converts a perl data structure into its JSON representation.
		112
		113	=cut
		114
102	sub to_json($) {	115	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	116	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	117	JSON::Syck::Dump $_[0]
105	}	118	}
106		119
107	#############################################################################	120	=back
108	# "new" plug-in system
109		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
110	=item $object->attach ($attachment, ...)	132	=item $object->detach ($attachment)
111		133
112	Attach a pre-registered attachment to an object.	134	Attach/detach a pre-registered attachment to an object.
113		135
		136	=item $player->attach ($attachment, key => $value...)
		137
114	=item $player->attach ($attachment, ...)	138	=item $player->detach ($attachment)
115		139
116	Attach a pre-registered attachment to a player.	140	Attach/detach a pre-registered attachment to a player.
117		141
118	=item $map->attach ($attachment, ...) # not yet persistent	142	=item $map->attach ($attachment, key => $value...)
119		143
		144	=item $map->detach ($attachment)
		145
120	Attach a pre-registered attachment to a map.	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.
121		155
122	=item cf::attach_global ...	156	=item cf::attach_global ...
123		157
124	Attach handlers for global events.	158	Attach handlers for global events.
125		159
…		…
173	=item cf::attach_to_maps ...	207	=item cf::attach_to_maps ...
174		208
175	Attach handlers to all maps.	209	Attach handlers to all maps.
176		210
177	=item cf:register_attachment $name, ...	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.
178		225
179	=cut	226	=cut
180		227
181	# 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
182	our @CB_GLOBAL = (); # registry for all global events	229	our @CB_GLOBAL = (); # registry for all global events
…		…
245		292
246	\%undo	293	\%undo
247	}	294	}
248		295
249	sub _attach_attachment {	296	sub _attach_attachment {
250	my ($obj, $name, @args) = @_;	297	my ($obj, $name, %arg) = @_;
		298
		299	return if exists $obj->{_attachment}{$name};
251		300
252	my $res;	301	my $res;
253		302
254	if (my $attach = $attachment{$name}) {	303	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	304	my $registry = $obj->registry;
…		…
257	for (@$attach) {	306	for (@$attach) {
258	my ($klass, @attach) = @$_;	307	my ($klass, @attach) = @$_;
259	$res = _attach @$registry, $klass, @attach;	308	$res = _attach @$registry, $klass, @attach;
260	}	309	}
261		310
262	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {	311	$obj->{$name} = \%arg;
263	for (@$cb) {
264	eval { $_->[1]->($obj, @args); };
265	if ($@) {
266	warn "$@";
267	warn "... while processing '$name' instantiate with args <@args>.\n";
268	}
269	}
270	}
271	} else {	312	} else {
272	warn "object uses attachment '$name' that is not available, postponing.\n";	313	warn "object uses attachment '$name' that is not available, postponing.\n";
273	}	314	}
274		315
275	push @{$obj->{_attachment}}, $name;	316	$obj->{_attachment}{$name} = undef;
276		317
277	$res->{attachment} = $name;	318	$res->{attachment} = $name;
278	$res	319	$res
279	}	320	}
280		321
281	sub cf::object::attach {	322	*cf::object::attach =
		323	*cf::player::attach =
		324	*cf::map::attach = sub {
282	my ($obj, $name, @args) = @_;	325	my ($obj, $name, %arg) = @_;
283		326
284	_attach_attachment $obj, $name, @args;	327	_attach_attachment $obj, $name, %arg;
285	}	328	};
286		329
		330	# all those should be optimised
		331	*cf::object::detach =
287	sub cf::player::attach {	332	*cf::player::detach =
		333	*cf::map::detach = sub {
288	my ($obj, $name, @args) = @_;	334	my ($obj, $name) = @_;
289		335
290	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	336	delete $obj->{_attachment}{$name};
291	}	337	reattach ($obj);
		338	};
292		339
293	sub cf::map::attach {	340	*cf::object::attached =
		341	*cf::player::attached =
		342	*cf::map::attached = sub {
294	my ($obj, $name, @args) = @_;	343	my ($obj, $name) = @_;
295		344
296	_attach_attachment KLASS_MAP, $obj, $name, @args;	345	exists $obj->{_attachment}{$name}
297	}	346	};
298		347
299	sub attach_global {	348	sub attach_global {
300	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	349	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
301	}	350	}
302		351
…		…
323	my $name = shift;	372	my $name = shift;
324		373
325	$attachment{$name} = [[KLASS_OBJECT, @_]];	374	$attachment{$name} = [[KLASS_OBJECT, @_]];
326	}	375	}
327		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
328	our $override;	389	our $override;
329	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	390	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
330		391
331	sub override {	392	sub override {
332	$override = 1;	393	$override = 1;
…		…
344	for (@$callbacks) {	405	for (@$callbacks) {
345	eval { &{$_->[1]} };	406	eval { &{$_->[1]} };
346		407
347	if ($@) {	408	if ($@) {
348	warn "$@";	409	warn "$@";
349	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	410	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
350	override;	411	override;
351	}	412	}
352		413
353	return 1 if $override;	414	return 1 if $override;
354	}	415	}
355		416
356	0	417	0
357	}	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;
358		459
359	#############################################################################	460	#############################################################################
360	# object support	461	# object support
361		462
362	sub instantiate {	463	sub instantiate {
…		…
364		465
365	$data = from_json $data;	466	$data = from_json $data;
366		467
367	for (@$data) {	468	for (@$data) {
368	my ($name, $args) = @$_;	469	my ($name, $args) = @$_;
369	attach $obj, $name, @{$args \|\| [] };	470
		471	$obj->attach ($name, %{$args \|\| {} });
370	}	472	}
371	}	473	}
372		474
373	# basically do the same as instantiate, without calling instantiate	475	# basically do the same as instantiate, without calling instantiate
374	sub reattach {	476	sub reattach {
375	my ($obj) = @_;	477	my ($obj) = @_;
376	my $registry = $obj->registry;	478	my $registry = $obj->registry;
377		479
378	@$registry = ();	480	@$registry = ();
379		481
		482	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		483
380	for my $name (@{ $obj->{_attachment} }) {	484	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
381	if (my $attach = $attachment{$name}) {	485	if (my $attach = $attachment{$name}) {
382	for (@$attach) {	486	for (@$attach) {
383	my ($klass, @attach) = @$_;	487	my ($klass, @attach) = @$_;
384	_attach @$registry, $klass, @attach;	488	_attach @$registry, $klass, @attach;
385	}	489	}
…		…
388	}	492	}
389	}	493	}
390	}	494	}
391		495
392	sub object_freezer_save {	496	sub object_freezer_save {
393	my ($filename, $objs) = @_;	497	my ($filename, $rdata, $objs) = @_;
394		498
395	$filename .= ".pst";	499	if (length $$rdata) {
		500	warn sprintf "saving %s (%d,%d)\n",
		501	$filename, length $$rdata, scalar @$objs;
396		502
397	if (@$objs) {
398	open my $fh, ">:raw", "$filename~";	503	if (open my $fh, ">:raw", "$filename~") {
399	chmod $fh, SAVE_MODE;	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;
400	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	510	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
401	close $fh;	511	close $fh;
		512	rename "$filename.pst~", "$filename.pst";
		513	} else {
		514	unlink "$filename.pst";
		515	}
		516
402	rename "$filename~", $filename;	517	rename "$filename~", $filename;
		518	} else {
		519	warn "FATAL: $filename~: $!\n";
		520	}
403	} else {	521	} else {
404	unlink $filename;	522	unlink $filename;
		523	unlink "$filename.pst";
405	}	524	}
406	}	525	}
407		526
408	sub object_thawer_load {	527	sub object_thawer_load {
409	my ($filename) = @_;	528	my ($filename) = @_;
410		529
		530	local $/;
		531
		532	my $av;
		533
		534	#TODO: use sysread etc.
		535	if (open my $data, "<:raw:perlio", $filename) {
		536	$data = <$data>;
411	open my $fh, "<:raw:perlio", "$filename.pst"	537	if (open my $pst, "<:raw:perlio", "$filename.pst") {
412	or return;	538	$av = eval { (Storable::thaw <$pst>)->{objs} };
		539	}
		540	return ($data, $av);
		541	}
413		542
414	eval { local $/; (Storable::thaw <$fh>)->{objs} }	543	()
415	}	544	}
416		545
417	attach_to_objects	546	attach_to_objects
418	prio => -1000000,	547	prio => -1000000,
419	on_clone => sub {	548	on_clone => sub {
…		…
421		550
422	@{$dst->registry} = @{$src->registry};	551	@{$dst->registry} = @{$src->registry};
423		552
424	%$dst = %$src;	553	%$dst = %$src;
425		554
426	$dst->{_attachment} = [@{ $src->{_attachment} }]	555	%{$dst->{_attachment}} = %{$src->{_attachment}}
427	if exists $src->{_attachment};	556	if exists $src->{_attachment};
428	},	557	},
429	;	558	;
430		559
431	#############################################################################	560	#############################################################################
…		…
565	load_extension $ext;	694	load_extension $ext;
566	1	695	1
567	} or warn "$ext not loaded: $@";	696	} or warn "$ext not loaded: $@";
568	}	697	}
569	}	698	}
570
571	sub _perl_reload(&) {
572	my ($msg) = @_;
573
574	$msg->("reloading...");
575
576	eval {
577	# 1. cancel all watchers
578	$_->cancel for Event::all_watchers;
579
580	# 2. unload all extensions
581	for (@exts) {
582	$msg->("unloading <$_>");
583	unload_extension $_;
584	}
585
586	# 3. unload all modules loaded from $LIBDIR
587	while (my ($k, $v) = each %INC) {
588	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
589
590	$msg->("removing <$k>");
591	delete $INC{$k};
592
593	$k =~ s/\.pm$//;
594	$k =~ s/\//::/g;
595
596	if (my $cb = $k->can ("unload_module")) {
597	$cb->();
598	}
599
600	Symbol::delete_package $k;
601	}
602
603	# 4. get rid of safe::, as good as possible
604	Symbol::delete_package "safe::$_"
605	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
606
607	# 5. remove register_script_function callbacks
608	# TODO
609
610	# 6. unload cf.pm "a bit"
611	delete $INC{"cf.pm"};
612
613	# don't, removes xs symbols, too,
614	# and global variables created in xs
615	#Symbol::delete_package __PACKAGE__;
616
617	# 7. reload cf.pm
618	$msg->("reloading cf.pm");
619	require cf;
620	};
621	$msg->($@) if $@;
622
623	$msg->("reloaded");
624	};
625
626	sub perl_reload() {
627	_perl_reload {
628	warn $_[0];
629	print "$_[0]\n";
630	};
631	}
632
633	register_command "perl-reload", 0, sub {
634	my ($who, $arg) = @_;
635
636	if ($who->flag (FLAG_WIZ)) {
637	_perl_reload {
638	warn $_[0];
639	$who->message ($_[0]);
640	};
641	}
642	};
643		699
644	#############################################################################	700	#############################################################################
645	# extcmd framework, basically convert ext <msg>	701	# extcmd framework, basically convert ext <msg>
646	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	702	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
647		703
…		…
672	my ($map) = @_;	728	my ($map) = @_;
673		729
674	my $path = $map->tmpname;	730	my $path = $map->tmpname;
675	defined $path or return;	731	defined $path or return;
676		732
677	unlink "$path.cfperl";
678	unlink "$path.pst";	733	unlink "$path.pst";
679	};	734	};
680		735
681	*cf::mapsupport::on_swapin =
682	*cf::mapsupport::on_load = sub {
683	my ($map) = @_;
684
685	my $path = $map->tmpname;
686	$path = $map->path unless defined $path;
687
688	open my $fh, "<:raw", "$path.cfperl"
689	or return; # no perl data
690
691	my $data = Storable::thaw do { local $/; <$fh> };
692
693	$data->{version} <= 1
694	or return; # too new
695
696	$map->_set_obs ($data->{obs});
697	};
698
699	attach_to_maps prio => -10000, package => cf::mapsupport::;	736	attach_to_maps prio => -10000, package => cf::mapsupport::;
700		737
701	#############################################################################	738	#############################################################################
702	# load/save perl data associated with player->ob objects	739	# load/save perl data associated with player->ob objects
703		740
704	sub all_objects(@) {	741	sub all_objects(@) {
705	@_, map all_objects ($_->inv), @_	742	@_, map all_objects ($_->inv), @_
706	}	743	}
707		744
		745	# TODO: compatibility cruft, remove when no longer needed
708	attach_to_players	746	attach_to_players
709	on_load => sub {	747	on_load => sub {
710	my ($pl, $path) = @_;	748	my ($pl, $path) = @_;
711		749
712	for my $o (all_objects $pl->ob) {	750	for my $o (all_objects $pl->ob) {
…		…
718	}	756	}
719	},	757	},
720	;	758	;
721		759
722	#############################################################################	760	#############################################################################
723	# core extensions - in perl	761
		762	=head2 CORE EXTENSIONS
		763
		764	Functions and methods that extend core crossfire objects.
		765
		766	=over 4
724		767
725	=item cf::player::exists $login	768	=item cf::player::exists $login
726		769
727	Returns true when the given account exists.	770	Returns true when the given account exists.
728		771
…		…
731	sub cf::player::exists($) {	774	sub cf::player::exists($) {
732	cf::player::find $_[0]	775	cf::player::find $_[0]
733	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;
734	}	777	}
735		778
736	=item $player->reply ($npc, $msg[, $flags])	779	=item $object->reply ($npc, $msg[, $flags])
737		780
738	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>
739	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
740	dialogue with the given NPC character.	783	dialogue with the given NPC character.
741		784
…		…
768	$msg{msgid} = $id;	811	$msg{msgid} = $id;
769		812
770	$self->send ("ext " . to_json \%msg);	813	$self->send ("ext " . to_json \%msg);
771	}	814	}
772		815
		816	=back
		817
		818	=cut
		819
773	#############################################################################	820	#############################################################################
774	# 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
775		831
776	our $safe = new Safe "safe";	832	our $safe = new Safe "safe";
777	our $safe_hole = new Safe::Hole;	833	our $safe_hole = new Safe::Hole;
778		834
779	$SIG{FPE} = 'IGNORE';	835	$SIG{FPE} = 'IGNORE';
780		836
781	$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));
782		838
783	# 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
784		850
785	for (	851	for (
786	["cf::object" => qw(contr pay_amount pay_player)],	852	["cf::object" => qw(contr pay_amount pay_player)],
787	["cf::object::player" => qw(player)],	853	["cf::object::player" => qw(player)],
788	["cf::player" => qw(peaceful)],	854	["cf::player" => qw(peaceful)],
…		…
791	my ($pkg, @funs) = @$_;	857	my ($pkg, @funs) = @$_;
792	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	858	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
793	for @funs;	859	for @funs;
794	}	860	}
795		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
796	sub safe_eval($;@) {	874	sub safe_eval($;@) {
797	my ($code, %vars) = @_;	875	my ($code, %vars) = @_;
798		876
799	my $qcode = $code;	877	my $qcode = $code;
800	$qcode =~ s/"/‟/g; # not allowed in #line filenames	878	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
822	}	900	}
823		901
824	wantarray ? @res : $res[0]	902	wantarray ? @res : $res[0]
825	}	903	}
826		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
827	sub register_script_function {	920	sub register_script_function {
828	my ($fun, $cb) = @_;	921	my ($fun, $cb) = @_;
829		922
830	no strict 'refs';	923	no strict 'refs';
831	*{"safe::$fun"} = $safe_hole->wrap ($cb);	924	*{"safe::$fun"} = $safe_hole->wrap ($cb);
832	}	925	}
833		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
834	#############################################################################	1035	#############################################################################
835	# the server's main()	1036	# the server's main()
836		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
837	sub main {	1046	sub main {
		1047	cfg_load;
		1048	db_load;
		1049	load_extensions;
838	Event::loop;	1050	Event::loop;
839	}	1051	}
840		1052
841	#############################################################################	1053	#############################################################################
842	# initialisation	1054	# initialisation
843		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
844	register "<global>", __PACKAGE__;	1144	register "<global>", __PACKAGE__;
845		1145
846	unshift @INC, $LIBDIR;	1146	unshift @INC, $LIBDIR;
847
848	load_extensions;
849		1147
850	$TICK_WATCHER = Event->timer (	1148	$TICK_WATCHER = Event->timer (
851	prio => 1,	1149	prio => 1,
852	at => $NEXT_TICK \|\| 1,	1150	at => $NEXT_TICK \|\| 1,
853	cb => sub {	1151	cb => sub {
…		…
862	$TICK_WATCHER->at ($NEXT_TICK);	1160	$TICK_WATCHER->at ($NEXT_TICK);
863	$TICK_WATCHER->start;	1161	$TICK_WATCHER->start;
864	},	1162	},
865	);	1163	);
866		1164
867	_reload_2;
868
869	1	1165	1
870		1166

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.47 by root, Sun Aug 27 13:02:04 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.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.76 by root, Mon Oct 2 15:28:36 2006 UTC