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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.51 by root, Mon Aug 28 14:05:24 2006 UTC vs.
Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.51 by root, Mon Aug 28 14:05:24 2006 UTC vs. Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.51 by root, Mon Aug 28 14:05:24 2006 UTC vs.
Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC