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

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.54 by root, Tue Aug 29 14:49:28 2006 UTC vs. Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.54 by root, Tue Aug 29 14:49:28 2006 UTC vs.
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC