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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.56 by root, Wed Aug 30 08:28:33 2006 UTC vs.
Revision 1.91 by elmex, Sun Dec 17 22:03:44 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	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
17		22
18	our %COMMAND = ();	23	our %COMMAND = ();
		24	our %COMMAND_TIME = ();
		25	our %EXTCMD = ();
		26
		27	_init_vars;
		28
19	our @EVENT;	29	our @EVENT;
20	our %PROP_TYPE;	30	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		31
24	our $TICK = MAX_TIME * 1e-6;	32	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	33	our $TICK_WATCHER;
26	our $NEXT_TICK;	34	our $NEXT_TICK;
		35
		36	our %CFG;
		37
		38	our $UPTIME; $UPTIME \|\|= time;
		39
		40	#############################################################################
		41
		42	=head2 GLOBAL VARIABLES
		43
		44	=over 4
		45
		46	=item $cf::UPTIME
		47
		48	The timestamp of the server start (so not actually an uptime).
		49
		50	=item $cf::LIBDIR
		51
		52	The perl library directory, where extensions and cf-specific modules can
		53	be found. It will be added to C<@INC> automatically.
		54
		55	=item $cf::TICK
		56
		57	The interval between server ticks, in seconds.
		58
		59	=item %cf::CFG
		60
		61	Configuration for the server, loaded from C</etc/crossfire/config>, or
		62	from wherever your confdir points to.
		63
		64	=back
		65
		66	=cut
27		67
28	BEGIN {	68	BEGIN {
29	*CORE::GLOBAL::warn = sub {	69	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	70	my $msg = join "", @_;
31	$msg .= "\n"	71	$msg .= "\n"
…		…
34	print STDERR "cfperl: $msg";	74	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	75	LOG llevError, "cfperl: $msg";
36	};	76	};
37	}	77	}
38		78
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';	79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		80
75	# we bless all objects into (empty) derived classes to force a method lookup	81	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	82	# 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)) {	83	for my $pkg (qw(
		84	cf::object cf::object::player
		85	cf::client cf::player
		86	cf::arch cf::living
		87	cf::map cf::party cf::region
		88	)) {
78	no strict 'refs';	89	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	90	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	91	}
81		92
82	$Event::DIED = sub {	93	$Event::DIED = sub {
…		…
84	};	95	};
85		96
86	my %ext_pkg;	97	my %ext_pkg;
87	my @exts;	98	my @exts;
88	my @hook;	99	my @hook;
89	my %command;
90	my %extcmd;
91		100
92	#############################################################################	101	=head2 UTILITY FUNCTIONS
93	# utility functions	102
		103	=over 4
		104
		105	=cut
94		106
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	107	use JSON::Syck (); # TODO# replace by JSON::PC once working
		108
		109	=item $ref = cf::from_json $json
		110
		111	Converts a JSON string into the corresponding perl data structure.
		112
		113	=cut
96		114
97	sub from_json($) {	115	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	116	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	117	JSON::Syck::Load $_[0]
100	}	118	}
101		119
		120	=item $json = cf::to_json $ref
		121
		122	Converts a perl data structure into its JSON representation.
		123
		124	=cut
		125
102	sub to_json($) {	126	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	128	JSON::Syck::Dump $_[0]
105	}	129	}
106		130
		131	=back
		132
		133	=cut
		134
107	#############################################################################	135	#############################################################################
108	# "new" plug-in system
109		136
110	=head3 EVENTS AND OBJECT ATTACHMENTS	137	=head2 EVENTS AND OBJECT ATTACHMENTS
111		138
112	=over 4	139	=over 4
113		140
114	=item $object->attach ($attachment, key => $value...)	141	=item $object->attach ($attachment, key => $value...)
115		142
…		…
389	for (@$callbacks) {	416	for (@$callbacks) {
390	eval { &{$_->[1]} };	417	eval { &{$_->[1]} };
391		418
392	if ($@) {	419	if ($@) {
393	warn "$@";	420	warn "$@";
394	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	421	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
395	override;	422	override;
396	}	423	}
397		424
398	return 1 if $override;	425	return 1 if $override;
399	}	426	}
…		…
415	removed in future versions), and there is no public API to access override	442	removed in future versions), and there is no public API to access override
416	results (if you must, access C<@cf::invoke_results> directly).	443	results (if you must, access C<@cf::invoke_results> directly).
417		444
418	=back	445	=back
419		446
420	=head2 methods valid for all pointers	447	=cut
		448
		449	#############################################################################
		450
		451	=head2 METHODS VALID FOR ALL CORE OBJECTS
421		452
422	=over 4	453	=over 4
423		454
424	=item $object->valid	455	=item $object->valid, $player->valid, $map->valid
425
426	=item $player->valid
427
428	=item $map->valid
429		456
430	Just because you have a perl object does not mean that the corresponding	457	Just because you have a perl object does not mean that the corresponding
431	C-level object still exists. If you try to access an object that has no	458	C-level object still exists. If you try to access an object that has no
432	valid C counterpart anymore you get an exception at runtime. This method	459	valid C counterpart anymore you get an exception at runtime. This method
433	can be used to test for existence of the C object part without causing an	460	can be used to test for existence of the C object part without causing an
…		…
476	}	503	}
477	}	504	}
478	}	505	}
479		506
480	sub object_freezer_save {	507	sub object_freezer_save {
481	my ($filename, $objs) = @_;	508	my ($filename, $rdata, $objs) = @_;
482		509
483	if (@$objs) {	510	if (length $$rdata) {
		511	warn sprintf "saving %s (%d,%d)\n",
		512	$filename, length $$rdata, scalar @$objs;
		513
484	open my $fh, ">:raw", "$filename.pst~";	514	if (open my $fh, ">:raw", "$filename~") {
		515	chmod SAVE_MODE, $fh;
		516	syswrite $fh, $$rdata;
		517	close $fh;
		518
		519	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		520	chmod SAVE_MODE, $fh;
485	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
486	close $fh;	522	close $fh;
487	chmod SAVE_MODE, "$filename.pst~";
488	rename "$filename.pst~", "$filename.pst";	523	rename "$filename.pst~", "$filename.pst";
		524	} else {
		525	unlink "$filename.pst";
		526	}
		527
		528	rename "$filename~", $filename;
		529	} else {
		530	warn "FATAL: $filename~: $!\n";
		531	}
489	} else {	532	} else {
		533	unlink $filename;
490	unlink "$filename.pst";	534	unlink "$filename.pst";
491	}	535	}
		536	}
492		537
493	chmod SAVE_MODE, "$filename~";	538	sub object_freezer_as_string {
494	rename "$filename~", $filename;	539	my ($rdata, $objs) = @_;
		540
		541	use Data::Dumper;
		542
		543	$$rdata . Dumper $objs
495	}	544	}
496		545
497	sub object_thawer_load {	546	sub object_thawer_load {
498	my ($filename) = @_;	547	my ($filename) = @_;
499		548
		549	local $/;
		550
		551	my $av;
		552
		553	#TODO: use sysread etc.
		554	if (open my $data, "<:raw:perlio", $filename) {
		555	$data = <$data>;
500	open my $fh, "<:raw:perlio", "$filename.pst"	556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
501	or return;	557	$av = eval { (Storable::thaw <$pst>)->{objs} };
		558	}
		559	return ($data, $av);
		560	}
502		561
503	eval { local $/; (Storable::thaw <$fh>)->{objs} }	562	()
504	}	563	}
505		564
506	attach_to_objects	565	attach_to_objects
507	prio => -1000000,	566	prio => -1000000,
508	on_clone => sub {	567	on_clone => sub {
…		…
516	if exists $src->{_attachment};	575	if exists $src->{_attachment};
517	},	576	},
518	;	577	;
519		578
520	#############################################################################	579	#############################################################################
521	# old plug-in events	580	# command handling &c
522		581
523	sub inject_event {	582	=item cf::register_command $name => \&callback($ob,$args);
524	my $extension = shift;
525	my $event_code = shift;
526		583
527	my $cb = $hook[$event_code]{$extension}	584	Register a callback for execution when the client sends the user command
528	or return;	585	$name.
529		586
530	&$cb	587	=cut
531	}
532
533	sub inject_global_event {
534	my $event = shift;
535
536	my $cb = $hook[$event]
537	or return;
538
539	List::Util::max map &$_, values %$cb
540	}
541
542	sub inject_command {
543	my ($name, $obj, $params) = @_;
544
545	for my $cmd (@{ $command{$name} }) {
546	$cmd->[1]->($obj, $params);
547	}
548
549	-1
550	}
551		588
552	sub register_command {	589	sub register_command {
553	my ($name, $time, $cb) = @_;	590	my ($name, $cb) = @_;
554		591
555	my $caller = caller;	592	my $caller = caller;
556	#warn "registering command '$name/$time' to '$caller'";	593	#warn "registering command '$name/$time' to '$caller'";
557		594
558	push @{ $command{$name} }, [$time, $cb, $caller];	595	push @{ $COMMAND{$name} }, [$caller, $cb];
559	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
560	}	596	}
		597
		598	=item cf::register_extcmd $name => \&callback($pl,$packet);
		599
		600	Register a callbackf ro execution when the client sends an extcmd packet.
		601
		602	If the callback returns something, it is sent back as if reply was being
		603	called.
		604
		605	=cut
561		606
562	sub register_extcmd {	607	sub register_extcmd {
563	my ($name, $cb) = @_;	608	my ($name, $cb) = @_;
564		609
565	my $caller = caller;	610	my $caller = caller;
566	#warn "registering extcmd '$name' to '$caller'";	611	#warn "registering extcmd '$name' to '$caller'";
567		612
568	$extcmd{$name} = [$cb, $caller];	613	$EXTCMD{$name} = [$cb, $caller];
569	}	614	}
		615
		616	attach_to_players
		617	on_command => sub {
		618	my ($pl, $name, $params) = @_;
		619
		620	my $cb = $COMMAND{$name}
		621	or return;
		622
		623	for my $cmd (@$cb) {
		624	$cmd->[1]->($pl->ob, $params);
		625	}
		626
		627	cf::override;
		628	},
		629	on_extcmd => sub {
		630	my ($pl, $buf) = @_;
		631
		632	my $msg = eval { from_json $buf };
		633
		634	if (ref $msg) {
		635	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		636	if (my %reply = $cb->[0]->($pl, $msg)) {
		637	$pl->ext_reply ($msg->{msgid}, %reply);
		638	}
		639	}
		640	} else {
		641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		642	}
		643
		644	cf::override;
		645	},
		646	;
570		647
571	sub register {	648	sub register {
572	my ($base, $pkg) = @_;	649	my ($base, $pkg) = @_;
573		650
574	#TODO	651	#TODO
…		…
593	. "#line 1 \"$path\"\n{\n"	670	. "#line 1 \"$path\"\n{\n"
594	. (do { local $/; <$fh> })	671	. (do { local $/; <$fh> })
595	. "\n};\n1";	672	. "\n};\n1";
596		673
597	eval $source	674	eval $source
598	or die "$path: $@";	675	or die $@ ? "$path: $@\n"
		676	: "extension disabled.\n";
599		677
600	push @exts, $pkg;	678	push @exts, $pkg;
601	$ext_pkg{$base} = $pkg;	679	$ext_pkg{$base} = $pkg;
602		680
603	# no strict 'refs';	681	# no strict 'refs';
…		…
616	# for my $idx (0 .. $#PLUGIN_EVENT) {	694	# for my $idx (0 .. $#PLUGIN_EVENT) {
617	# delete $hook[$idx]{$pkg};	695	# delete $hook[$idx]{$pkg};
618	# }	696	# }
619		697
620	# remove commands	698	# remove commands
621	for my $name (keys %command) {	699	for my $name (keys %COMMAND) {
622	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	700	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
623		701
624	if (@cb) {	702	if (@cb) {
625	$command{$name} = \@cb;	703	$COMMAND{$name} = \@cb;
626	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
627	} else {	704	} else {
628	delete $command{$name};
629	delete $COMMAND{"$name\000"};	705	delete $COMMAND{$name};
630	}	706	}
631	}	707	}
632		708
633	# remove extcmds	709	# remove extcmds
634	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	710	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
635	delete $extcmd{$name};	711	delete $EXTCMD{$name};
636	}	712	}
637		713
638	if (my $cb = $pkg->can ("unload")) {	714	if (my $cb = $pkg->can ("unload")) {
639	eval {	715	eval {
640	$cb->($pkg);	716	$cb->($pkg);
…		…
644		720
645	Symbol::delete_package $pkg;	721	Symbol::delete_package $pkg;
646	}	722	}
647		723
648	sub load_extensions {	724	sub load_extensions {
649	my $LIBDIR = maps_directory "perl";
650
651	for my $ext (<$LIBDIR/*.ext>) {	725	for my $ext (<$LIBDIR/*.ext>) {
652	next unless -r $ext;	726	next unless -r $ext;
653	eval {	727	eval {
654	load_extension $ext;	728	load_extension $ext;
655	1	729	1
656	} or warn "$ext not loaded: $@";	730	} or warn "$ext not loaded: $@";
657	}	731	}
658	}	732	}
659		733
660	sub _perl_reload(&) {
661	my ($msg) = @_;
662
663	$msg->("reloading...");
664
665	eval {
666	# 1. cancel all watchers
667	$_->cancel for Event::all_watchers;
668
669	# 2. unload all extensions
670	for (@exts) {
671	$msg->("unloading <$_>");
672	unload_extension $_;
673	}
674
675	# 3. unload all modules loaded from $LIBDIR
676	while (my ($k, $v) = each %INC) {
677	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
678
679	$msg->("removing <$k>");
680	delete $INC{$k};
681
682	$k =~ s/\.pm$//;
683	$k =~ s/\//::/g;
684
685	if (my $cb = $k->can ("unload_module")) {
686	$cb->();
687	}
688
689	Symbol::delete_package $k;
690	}
691
692	# 4. get rid of safe::, as good as possible
693	Symbol::delete_package "safe::$_"
694	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
695
696	# 5. remove register_script_function callbacks
697	# TODO
698
699	# 6. unload cf.pm "a bit"
700	delete $INC{"cf.pm"};
701
702	# don't, removes xs symbols, too,
703	# and global variables created in xs
704	#Symbol::delete_package __PACKAGE__;
705
706	# 7. reload cf.pm
707	$msg->("reloading cf.pm");
708	require cf;
709	};
710	$msg->($@) if $@;
711
712	$msg->("reloaded");
713	};
714
715	sub perl_reload() {
716	_perl_reload {
717	warn $_[0];
718	print "$_[0]\n";
719	};
720	}
721
722	register_command "perl-reload", 0, sub {
723	my ($who, $arg) = @_;
724
725	if ($who->flag (FLAG_WIZ)) {
726	_perl_reload {
727	warn $_[0];
728	$who->message ($_[0]);
729	};
730	}
731	};
732
733	#############################################################################
734	# extcmd framework, basically convert ext <msg>
735	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
736
737	attach_to_players
738	on_extcmd => sub {
739	my ($pl, $buf) = @_;
740
741	my $msg = eval { from_json $buf };
742
743	if (ref $msg) {
744	if (my $cb = $extcmd{$msg->{msgtype}}) {
745	if (my %reply = $cb->[0]->($pl, $msg)) {
746	$pl->ext_reply ($msg->{msgid}, %reply);
747	}
748	}
749	} else {
750	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
751	}
752
753	cf::override;
754	},
755	;
756
757	#############################################################################	734	#############################################################################
758	# load/save/clean perl data associated with a map	735	# load/save/clean perl data associated with a map
759		736
760	*cf::mapsupport::on_clean = sub {	737	*cf::mapsupport::on_clean = sub {
761	my ($map) = @_;	738	my ($map) = @_;
…		…
764	defined $path or return;	741	defined $path or return;
765		742
766	unlink "$path.pst";	743	unlink "$path.pst";
767	};	744	};
768		745
769	# old style persistent data, TODO: remove #d#
770	*cf::mapsupport::on_swapin = sub {
771	my ($map) = @_;
772
773	my $path = $map->tmpname;
774	$path = $map->path unless defined $path;
775
776	warn "$path.cfperl\n";#d#
777
778	open my $fh, "<:raw", "$path.cfperl"
779	or return; # no perl data
780
781	my $data = Storable::thaw do { local $/; <$fh> };
782
783	$data->{version} <= 1
784	or return; # too new
785
786	$map->_set_obs ($data->{obs});
787	$map->invoke (EVENT_MAP_UPGRADE);
788	};
789
790	attach_to_maps prio => -10000, package => cf::mapsupport::;	746	attach_to_maps prio => -10000, package => cf::mapsupport::;
791		747
792	#############################################################################	748	#############################################################################
793	# load/save perl data associated with player->ob objects	749	# load/save perl data associated with player->ob objects
794		750
795	sub all_objects(@) {	751	sub all_objects(@) {
796	@_, map all_objects ($_->inv), @_	752	@_, map all_objects ($_->inv), @_
797	}	753	}
798		754
		755	# TODO: compatibility cruft, remove when no longer needed
799	attach_to_players	756	attach_to_players
800	on_load => sub {	757	on_load => sub {
801	my ($pl, $path) = @_;	758	my ($pl, $path) = @_;
802		759
803	for my $o (all_objects $pl->ob) {	760	for my $o (all_objects $pl->ob) {
…		…
809	}	766	}
810	},	767	},
811	;	768	;
812		769
813	#############################################################################	770	#############################################################################
814	# core extensions - in perl	771
		772	=head2 CORE EXTENSIONS
		773
		774	Functions and methods that extend core crossfire objects.
		775
		776	=over 4
815		777
816	=item cf::player::exists $login	778	=item cf::player::exists $login
817		779
818	Returns true when the given account exists.	780	Returns true when the given account exists.
819		781
…		…
822	sub cf::player::exists($) {	784	sub cf::player::exists($) {
823	cf::player::find $_[0]	785	cf::player::find $_[0]
824	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	786	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
825	}	787	}
826		788
827	=item $player->reply ($npc, $msg[, $flags])	789	=item $player_object->reply ($npc, $msg[, $flags])
828		790
829	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	791	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
830	can be C<undef>. Does the right thing when the player is currently in a	792	can be C<undef>. Does the right thing when the player is currently in a
831	dialogue with the given NPC character.	793	dialogue with the given NPC character.
832		794
…		…
859	$msg{msgid} = $id;	821	$msg{msgid} = $id;
860		822
861	$self->send ("ext " . to_json \%msg);	823	$self->send ("ext " . to_json \%msg);
862	}	824	}
863		825
		826	=item $player_object->may ("access")
		827
		828	Returns wether the given player is authorized to access resource "access"
		829	(e.g. "command_wizcast").
		830
		831	=cut
		832
		833	sub cf::object::player::may {
		834	my ($self, $access) = @_;
		835
		836	$self->flag (cf::FLAG_WIZ) \|\|
		837	(ref $cf::CFG{"may_$access"}
		838	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		839	: $cf::CFG{"may_$access"})
		840	}
		841
		842	=cut
		843
864	#############################################################################	844	#############################################################################
865	# map scripting support	845
		846	=head2 SAFE SCRIPTING
		847
		848	Functions that provide a safe environment to compile and execute
		849	snippets of perl code without them endangering the safety of the server
		850	itself. Looping constructs, I/O operators and other built-in functionality
		851	is not available in the safe scripting environment, and the number of
		852	functions and methods that can be called is greatly reduced.
		853
		854	=cut
866		855
867	our $safe = new Safe "safe";	856	our $safe = new Safe "safe";
868	our $safe_hole = new Safe::Hole;	857	our $safe_hole = new Safe::Hole;
869		858
870	$SIG{FPE} = 'IGNORE';	859	$SIG{FPE} = 'IGNORE';
871		860
872	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	861	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
873		862
874	# here we export the classes and methods available to script code	863	# here we export the classes and methods available to script code
875		864
		865	=pod
		866
		867	The following fucntions and emthods are available within a safe environment:
		868
		869	cf::object contr pay_amount pay_player map
		870	cf::object::player player
		871	cf::player peaceful
		872	cf::map trigger
		873
		874	=cut
		875
876	for (	876	for (
877	["cf::object" => qw(contr pay_amount pay_player)],	877	["cf::object" => qw(contr pay_amount pay_player map)],
878	["cf::object::player" => qw(player)],	878	["cf::object::player" => qw(player)],
879	["cf::player" => qw(peaceful)],	879	["cf::player" => qw(peaceful)],
		880	["cf::map" => qw(trigger)],
880	) {	881	) {
881	no strict 'refs';	882	no strict 'refs';
882	my ($pkg, @funs) = @$_;	883	my ($pkg, @funs) = @$_;
883	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
884	for @funs;	885	for @funs;
885	}	886	}
		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
886		899
887	sub safe_eval($;@) {	900	sub safe_eval($;@) {
888	my ($code, %vars) = @_;	901	my ($code, %vars) = @_;
889		902
890	my $qcode = $code;	903	my $qcode = $code;
…		…
913	}	926	}
914		927
915	wantarray ? @res : $res[0]	928	wantarray ? @res : $res[0]
916	}	929	}
917		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
918	sub register_script_function {	946	sub register_script_function {
919	my ($fun, $cb) = @_;	947	my ($fun, $cb) = @_;
920		948
921	no strict 'refs';	949	no strict 'refs';
922	*{"safe::$fun"} = $safe_hole->wrap ($cb);	950	*{"safe::$fun"} = $safe_hole->wrap ($cb);
923	}	951	}
924		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, data => WF_AUTOCANCEL, 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
925	#############################################################################	1062	#############################################################################
926	# the server's main()	1063	# the server's main()
927		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
928	sub main {	1073	sub main {
		1074	cfg_load;
		1075	db_load;
		1076	load_extensions;
929	Event::loop;	1077	Event::loop;
930	}	1078	}
931		1079
932	#############################################################################	1080	#############################################################################
933	# initialisation	1081	# initialisation
934		1082
		1083	sub _perl_reload(&) {
		1084	my ($msg) = @_;
		1085
		1086	$msg->("reloading...");
		1087
		1088	eval {
		1089	# cancel all watchers
		1090	for (Event::all_watchers) {
		1091	$_->cancel if $_->data & WF_AUTOCANCEL;
		1092	}
		1093
		1094	# unload all extensions
		1095	for (@exts) {
		1096	$msg->("unloading <$_>");
		1097	unload_extension $_;
		1098	}
		1099
		1100	# unload all modules loaded from $LIBDIR
		1101	while (my ($k, $v) = each %INC) {
		1102	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1103
		1104	$msg->("removing <$k>");
		1105	delete $INC{$k};
		1106
		1107	$k =~ s/\.pm$//;
		1108	$k =~ s/\//::/g;
		1109
		1110	if (my $cb = $k->can ("unload_module")) {
		1111	$cb->();
		1112	}
		1113
		1114	Symbol::delete_package $k;
		1115	}
		1116
		1117	# sync database to disk
		1118	cf::db_sync;
		1119
		1120	# get rid of safe::, as good as possible
		1121	Symbol::delete_package "safe::$_"
		1122	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1123
		1124	# remove register_script_function callbacks
		1125	# TODO
		1126
		1127	# unload cf.pm "a bit"
		1128	delete $INC{"cf.pm"};
		1129
		1130	# don't, removes xs symbols, too,
		1131	# and global variables created in xs
		1132	#Symbol::delete_package __PACKAGE__;
		1133
		1134	# reload cf.pm
		1135	$msg->("reloading cf.pm");
		1136	require cf;
		1137
		1138	# load config and database again
		1139	cf::cfg_load;
		1140	cf::db_load;
		1141
		1142	# load extensions
		1143	$msg->("load extensions");
		1144	cf::load_extensions;
		1145
		1146	# reattach attachments to objects
		1147	$msg->("reattach");
		1148	_global_reattach;
		1149	};
		1150	$msg->($@) if $@;
		1151
		1152	$msg->("reloaded");
		1153	};
		1154
		1155	sub perl_reload() {
		1156	_perl_reload {
		1157	warn $_[0];
		1158	print "$_[0]\n";
		1159	};
		1160	}
		1161
935	register "<global>", __PACKAGE__;	1162	register "<global>", __PACKAGE__;
936		1163
		1164	register_command "perl-reload" => sub {
		1165	my ($who, $arg) = @_;
		1166
		1167	if ($who->flag (FLAG_WIZ)) {
		1168	_perl_reload {
		1169	warn $_[0];
		1170	$who->message ($_[0]);
		1171	};
		1172	}
		1173	};
		1174
937	unshift @INC, $LIBDIR;	1175	unshift @INC, $LIBDIR;
938		1176
939	load_extensions;
940
941	$TICK_WATCHER = Event->timer (	1177	$TICK_WATCHER = Event->timer (
942	prio => 1,	1178	prio => 0,
943	at => $NEXT_TICK \|\| 1,	1179	at => $NEXT_TICK \|\| 1,
		1180	data => WF_AUTOCANCEL,
944	cb => sub {	1181	cb => sub {
945	cf::server_tick; # one server iteration	1182	cf::server_tick; # one server iteration
946		1183
947	my $NOW = Event::time;	1184	my $NOW = Event::time;
948	$NEXT_TICK += $TICK;	1185	$NEXT_TICK += $TICK;
949		1186
950	# if we are delayed by four ticks, skip them all	1187	# if we are delayed by four ticks or more, skip them all
951	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1188	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
952		1189
953	$TICK_WATCHER->at ($NEXT_TICK);	1190	$TICK_WATCHER->at ($NEXT_TICK);
954	$TICK_WATCHER->start;	1191	$TICK_WATCHER->start;
955	},	1192	},
956	);	1193	);
957		1194
958	_reload_2;	1195	IO::AIO::max_poll_time $TICK * 0.2;
		1196
		1197	Event->io (fd => IO::AIO::poll_fileno,
		1198	poll => 'r',
		1199	prio => 5,
		1200	data => WF_AUTOCANCEL,
		1201	cb => \&IO::AIO::poll_cb);
959		1202
960	1	1203	1
961		1204

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.56 by root, Wed Aug 30 08:28:33 2006 UTC vs. Revision 1.91 by elmex, Sun Dec 17 22:03:44 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.56 by root, Wed Aug 30 08:28:33 2006 UTC vs.
Revision 1.91 by elmex, Sun Dec 17 22:03:44 2006 UTC