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

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.83 by root, Mon Dec 11 01:30:41 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.83 by root, Mon Dec 11 01:30:41 2006 UTC