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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.63 by root, Fri Sep 8 17:41:41 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 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
		21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		22
		23	our %COMMAND = ();
		24	our %COMMAND_TIME = ();
		25	our %EXTCMD = ();
		26
16	_init_vars;	27	_init_vars;
17		28
18	our %COMMAND = ();
19	our @EVENT;	29	our @EVENT;
20	our $LIBDIR = maps_directory "perl";	30	our $LIBDIR = datadir . "/ext";
21		31
22	our $TICK = MAX_TIME * 1e-6;	32	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	33	our $TICK_WATCHER;
24	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
25		67
26	BEGIN {	68	BEGIN {
27	*CORE::GLOBAL::warn = sub {	69	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	70	my $msg = join "", @_;
29	$msg .= "\n"	71	$msg .= "\n"
…		…
36		78
37	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38		80
39	# 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
40	# within the Safe compartment.	82	# within the Safe compartment.
41	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	)) {
42	no strict 'refs';	89	no strict 'refs';
43	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	90	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44	}	91	}
45		92
46	$Event::DIED = sub {	93	$Event::DIED = sub {
…		…
48	};	95	};
49		96
50	my %ext_pkg;	97	my %ext_pkg;
51	my @exts;	98	my @exts;
52	my @hook;	99	my @hook;
53	my %command;
54	my %extcmd;
55		100
56	#############################################################################	101	=head2 UTILITY FUNCTIONS
57	# utility functions	102
		103	=over 4
		104
		105	=cut
58		106
59	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
60		114
61	sub from_json($) {	115	sub from_json($) {
62	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	116	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63	JSON::Syck::Load $_[0]	117	JSON::Syck::Load $_[0]
64	}	118	}
65		119
		120	=item $json = cf::to_json $ref
		121
		122	Converts a perl data structure into its JSON representation.
		123
		124	=cut
		125
66	sub to_json($) {	126	sub to_json($) {
67	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68	JSON::Syck::Dump $_[0]	128	JSON::Syck::Dump $_[0]
69	}	129	}
70		130
		131	=back
		132
		133	=cut
		134
71	#############################################################################	135	#############################################################################
72	# "new" plug-in system
73		136
74	=head3 EVENTS AND OBJECT ATTACHMENTS	137	=head2 EVENTS AND OBJECT ATTACHMENTS
75		138
76	=over 4	139	=over 4
77		140
78	=item $object->attach ($attachment, key => $value...)	141	=item $object->attach ($attachment, key => $value...)
79		142
…		…
89		152
90	=item $map->attach ($attachment, key => $value...)	153	=item $map->attach ($attachment, key => $value...)
91		154
92	=item $map->detach ($attachment)	155	=item $map->detach ($attachment)
93		156
		157	Attach/detach a pre-registered attachment to a client.
		158
		159	=item $client->attach ($attachment, key => $value...)
		160
		161	=item $client->detach ($attachment)
		162
94	Attach/detach a pre-registered attachment to a map.	163	Attach/detach a pre-registered attachment to a map.
95		164
96	=item $bool = $object->attached ($name)	165	=item $bool = $object->attached ($name)
97		166
98	=item $bool = $player->attached ($name)	167	=item $bool = $player->attached ($name)
		168
		169	=item $bool = $client->attached ($name)
99		170
100	=item $bool = $map->attached ($name)	171	=item $bool = $map->attached ($name)
101		172
102	Checks wether the named attachment is currently attached to the object.	173	Checks wether the named attachment is currently attached to the object.
103		174
…		…
150		221
151	=item cf::attach_to_players ...	222	=item cf::attach_to_players ...
152		223
153	Attach handlers to all players.	224	Attach handlers to all players.
154		225
		226	=item cf::attach_to_clients ...
		227
		228	Attach handlers to all players.
		229
155	=item cf::attach_to_maps ...	230	=item cf::attach_to_maps ...
156		231
157	Attach handlers to all maps.	232	Attach handlers to all maps.
158		233
159	=item cf:register_attachment $name, ...	234	=item cf:register_attachment $name, ...
…		…
175		250
176	# the following variables are defined in .xs and must not be re-created	251	# the following variables are defined in .xs and must not be re-created
177	our @CB_GLOBAL = (); # registry for all global events	252	our @CB_GLOBAL = (); # registry for all global events
178	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	253	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179	our @CB_PLAYER = ();	254	our @CB_PLAYER = ();
		255	our @CB_CLIENT = ();
180	our @CB_TYPE = (); # registry for type (cf-object class) based events	256	our @CB_TYPE = (); # registry for type (cf-object class) based events
181	our @CB_MAP = ();	257	our @CB_MAP = ();
182		258
183	my %attachment;	259	my %attachment;
184		260
…		…
267	$res	343	$res
268	}	344	}
269		345
270	*cf::object::attach =	346	*cf::object::attach =
271	*cf::player::attach =	347	*cf::player::attach =
		348	*cf::client::attach =
272	*cf::map::attach = sub {	349	*cf::map::attach = sub {
273	my ($obj, $name, %arg) = @_;	350	my ($obj, $name, %arg) = @_;
274		351
275	_attach_attachment $obj, $name, %arg;	352	_attach_attachment $obj, $name, %arg;
276	};	353	};
277		354
278	# all those should be optimised	355	# all those should be optimised
279	*cf::object::detach =	356	*cf::object::detach =
280	*cf::player::detach =	357	*cf::player::detach =
		358	*cf::client::detach =
281	*cf::map::detach = sub {	359	*cf::map::detach = sub {
282	my ($obj, $name) = @_;	360	my ($obj, $name) = @_;
283		361
284	delete $obj->{_attachment}{$name};	362	delete $obj->{_attachment}{$name};
285	reattach ($obj);	363	reattach ($obj);
286	};	364	};
287		365
288	*cf::object::attached =	366	*cf::object::attached =
289	*cf::player::attached =	367	*cf::player::attached =
		368	*cf::client::attached =
290	*cf::map::attached = sub {	369	*cf::map::attached = sub {
291	my ($obj, $name) = @_;	370	my ($obj, $name) = @_;
292		371
293	exists $obj->{_attachment}{$name}	372	exists $obj->{_attachment}{$name}
294	};	373	};
…		…
310		389
311	sub attach_to_players {	390	sub attach_to_players {
312	_attach @CB_PLAYER, KLASS_PLAYER, @_	391	_attach @CB_PLAYER, KLASS_PLAYER, @_
313	}	392	}
314		393
		394	sub attach_to_clients {
		395	_attach @CB_CLIENT, KLASS_CLIENT, @_
		396	}
		397
315	sub attach_to_maps {	398	sub attach_to_maps {
316	_attach @CB_MAP, KLASS_MAP, @_	399	_attach @CB_MAP, KLASS_MAP, @_
317	}	400	}
318		401
319	sub register_attachment {	402	sub register_attachment {
…		…
324		407
325	sub register_player_attachment {	408	sub register_player_attachment {
326	my $name = shift;	409	my $name = shift;
327		410
328	$attachment{$name} = [[KLASS_PLAYER, @_]];	411	$attachment{$name} = [[KLASS_PLAYER, @_]];
		412	}
		413
		414	sub register_client_attachment {
		415	my $name = shift;
		416
		417	$attachment{$name} = [[KLASS_CLIENT, @_]];
329	}	418	}
330		419
331	sub register_map_attachment {	420	sub register_map_attachment {
332	my $name = shift;	421	my $name = shift;
333		422
…		…
353	for (@$callbacks) {	442	for (@$callbacks) {
354	eval { &{$_->[1]} };	443	eval { &{$_->[1]} };
355		444
356	if ($@) {	445	if ($@) {
357	warn "$@";	446	warn "$@";
358	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	447	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
359	override;	448	override;
360	}	449	}
361		450
362	return 1 if $override;	451	return 1 if $override;
363	}	452	}
…		…
368	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	457	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
369		458
370	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)	459	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371		460
372	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)	461	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		462
		463	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
373		464
374	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)	465	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375		466
376	Generate a global/object/player/map-specific event with the given arguments.	467	Generate a global/object/player/map-specific event with the given arguments.
377		468
…		…
379	removed in future versions), and there is no public API to access override	470	removed in future versions), and there is no public API to access override
380	results (if you must, access C<@cf::invoke_results> directly).	471	results (if you must, access C<@cf::invoke_results> directly).
381		472
382	=back	473	=back
383		474
384	=head2 methods valid for all pointers	475	=cut
		476
		477	#############################################################################
		478
		479	=head2 METHODS VALID FOR ALL CORE OBJECTS
385		480
386	=over 4	481	=over 4
387		482
388	=item $object->valid	483	=item $object->valid, $player->valid, $client->valid, $map->valid
389
390	=item $player->valid
391
392	=item $map->valid
393		484
394	Just because you have a perl object does not mean that the corresponding	485	Just because you have a perl object does not mean that the corresponding
395	C-level object still exists. If you try to access an object that has no	486	C-level object still exists. If you try to access an object that has no
396	valid C counterpart anymore you get an exception at runtime. This method	487	valid C counterpart anymore you get an exception at runtime. This method
397	can be used to test for existence of the C object part without causing an	488	can be used to test for existence of the C object part without causing an
…		…
401		492
402	=cut	493	=cut
403		494
404	*cf::object::valid =	495	*cf::object::valid =
405	*cf::player::valid =	496	*cf::player::valid =
		497	*cf::client::valid =
406	*cf::map::valid = \&cf::_valid;	498	*cf::map::valid = \&cf::_valid;
407		499
408	#############################################################################	500	#############################################################################
409	# object support	501	# object support
410		502
…		…
470	unlink $filename;	562	unlink $filename;
471	unlink "$filename.pst";	563	unlink "$filename.pst";
472	}	564	}
473	}	565	}
474		566
		567	sub object_freezer_as_string {
		568	my ($rdata, $objs) = @_;
		569
		570	use Data::Dumper;
		571
		572	$$rdata . Dumper $objs
		573	}
		574
475	sub object_thawer_load {	575	sub object_thawer_load {
476	my ($filename) = @_;	576	my ($filename) = @_;
477		577
478	local $/;	578	local $/;
479		579
…		…
504	if exists $src->{_attachment};	604	if exists $src->{_attachment};
505	},	605	},
506	;	606	;
507		607
508	#############################################################################	608	#############################################################################
509	# old plug-in events	609	# command handling &c
510		610
511	sub inject_event {	611	=item cf::register_command $name => \&callback($ob,$args);
512	my $extension = shift;
513	my $event_code = shift;
514		612
515	my $cb = $hook[$event_code]{$extension}	613	Register a callback for execution when the client sends the user command
516	or return;	614	$name.
517		615
518	&$cb	616	=cut
519	}
520
521	sub inject_global_event {
522	my $event = shift;
523
524	my $cb = $hook[$event]
525	or return;
526
527	List::Util::max map &$_, values %$cb
528	}
529
530	sub inject_command {
531	my ($name, $obj, $params) = @_;
532
533	for my $cmd (@{ $command{$name} }) {
534	$cmd->[1]->($obj, $params);
535	}
536
537	-1
538	}
539		617
540	sub register_command {	618	sub register_command {
541	my ($name, $time, $cb) = @_;	619	my ($name, $cb) = @_;
542		620
543	my $caller = caller;	621	my $caller = caller;
544	#warn "registering command '$name/$time' to '$caller'";	622	#warn "registering command '$name/$time' to '$caller'";
545		623
546	push @{ $command{$name} }, [$time, $cb, $caller];	624	push @{ $COMMAND{$name} }, [$caller, $cb];
547	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548	}	625	}
		626
		627	=item cf::register_extcmd $name => \&callback($pl,$packet);
		628
		629	Register a callbackf ro execution when the client sends an extcmd packet.
		630
		631	If the callback returns something, it is sent back as if reply was being
		632	called.
		633
		634	=cut
549		635
550	sub register_extcmd {	636	sub register_extcmd {
551	my ($name, $cb) = @_;	637	my ($name, $cb) = @_;
552		638
553	my $caller = caller;	639	my $caller = caller;
554	#warn "registering extcmd '$name' to '$caller'";	640	#warn "registering extcmd '$name' to '$caller'";
555		641
556	$extcmd{$name} = [$cb, $caller];	642	$EXTCMD{$name} = [$cb, $caller];
557	}	643	}
		644
		645	attach_to_players
		646	on_command => sub {
		647	my ($pl, $name, $params) = @_;
		648
		649	my $cb = $COMMAND{$name}
		650	or return;
		651
		652	for my $cmd (@$cb) {
		653	$cmd->[1]->($pl->ob, $params);
		654	}
		655
		656	cf::override;
		657	},
		658	on_extcmd => sub {
		659	my ($pl, $buf) = @_;
		660
		661	my $msg = eval { from_json $buf };
		662
		663	if (ref $msg) {
		664	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		665	if (my %reply = $cb->[0]->($pl, $msg)) {
		666	$pl->ext_reply ($msg->{msgid}, %reply);
		667	}
		668	}
		669	} else {
		670	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		671	}
		672
		673	cf::override;
		674	},
		675	;
558		676
559	sub register {	677	sub register {
560	my ($base, $pkg) = @_;	678	my ($base, $pkg) = @_;
561		679
562	#TODO	680	#TODO
…		…
581	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
582	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
583	. "\n};\n1";	701	. "\n};\n1";
584		702
585	eval $source	703	eval $source
586	or die "$path: $@";	704	or die $@ ? "$path: $@\n"
		705	: "extension disabled.\n";
587		706
588	push @exts, $pkg;	707	push @exts, $pkg;
589	$ext_pkg{$base} = $pkg;	708	$ext_pkg{$base} = $pkg;
590		709
591	# no strict 'refs';	710	# no strict 'refs';
…		…
604	# for my $idx (0 .. $#PLUGIN_EVENT) {	723	# for my $idx (0 .. $#PLUGIN_EVENT) {
605	# delete $hook[$idx]{$pkg};	724	# delete $hook[$idx]{$pkg};
606	# }	725	# }
607		726
608	# remove commands	727	# remove commands
609	for my $name (keys %command) {	728	for my $name (keys %COMMAND) {
610	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	729	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611		730
612	if (@cb) {	731	if (@cb) {
613	$command{$name} = \@cb;	732	$COMMAND{$name} = \@cb;
614	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615	} else {	733	} else {
616	delete $command{$name};
617	delete $COMMAND{"$name\000"};	734	delete $COMMAND{$name};
618	}	735	}
619	}	736	}
620		737
621	# remove extcmds	738	# remove extcmds
622	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	739	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623	delete $extcmd{$name};	740	delete $EXTCMD{$name};
624	}	741	}
625		742
626	if (my $cb = $pkg->can ("unload")) {	743	if (my $cb = $pkg->can ("unload")) {
627	eval {	744	eval {
628	$cb->($pkg);	745	$cb->($pkg);
…		…
632		749
633	Symbol::delete_package $pkg;	750	Symbol::delete_package $pkg;
634	}	751	}
635		752
636	sub load_extensions {	753	sub load_extensions {
637	my $LIBDIR = maps_directory "perl";
638
639	for my $ext (<$LIBDIR/*.ext>) {	754	for my $ext (<$LIBDIR/*.ext>) {
640	next unless -r $ext;	755	next unless -r $ext;
641	eval {	756	eval {
642	load_extension $ext;	757	load_extension $ext;
643	1	758	1
644	} or warn "$ext not loaded: $@";	759	} or warn "$ext not loaded: $@";
645	}	760	}
646	}	761	}
647		762
648	sub _perl_reload(&) {
649	my ($msg) = @_;
650
651	$msg->("reloading...");
652
653	eval {
654	# 1. cancel all watchers
655	$_->cancel for Event::all_watchers;
656
657	# 2. unload all extensions
658	for (@exts) {
659	$msg->("unloading <$_>");
660	unload_extension $_;
661	}
662
663	# 3. unload all modules loaded from $LIBDIR
664	while (my ($k, $v) = each %INC) {
665	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
666
667	$msg->("removing <$k>");
668	delete $INC{$k};
669
670	$k =~ s/\.pm$//;
671	$k =~ s/\//::/g;
672
673	if (my $cb = $k->can ("unload_module")) {
674	$cb->();
675	}
676
677	Symbol::delete_package $k;
678	}
679
680	# 4. get rid of safe::, as good as possible
681	Symbol::delete_package "safe::$_"
682	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
683
684	# 5. remove register_script_function callbacks
685	# TODO
686
687	# 6. unload cf.pm "a bit"
688	delete $INC{"cf.pm"};
689
690	# don't, removes xs symbols, too,
691	# and global variables created in xs
692	#Symbol::delete_package __PACKAGE__;
693
694	# 7. reload cf.pm
695	$msg->("reloading cf.pm");
696	require cf;
697
698	$msg->("load extensions");
699	cf::load_extensions;
700
701	$msg->("reattach");
702	_global_reattach;
703	};
704	$msg->($@) if $@;
705
706	$msg->("reloaded");
707	};
708
709	sub perl_reload() {
710	_perl_reload {
711	warn $_[0];
712	print "$_[0]\n";
713	};
714	}
715
716	register_command "perl-reload", 0, sub {
717	my ($who, $arg) = @_;
718
719	if ($who->flag (FLAG_WIZ)) {
720	_perl_reload {
721	warn $_[0];
722	$who->message ($_[0]);
723	};
724	}
725	};
726
727	#############################################################################
728	# extcmd framework, basically convert ext <msg>
729	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
730
731	attach_to_players
732	on_extcmd => sub {
733	my ($pl, $buf) = @_;
734
735	my $msg = eval { from_json $buf };
736
737	if (ref $msg) {
738	if (my $cb = $extcmd{$msg->{msgtype}}) {
739	if (my %reply = $cb->[0]->($pl, $msg)) {
740	$pl->ext_reply ($msg->{msgid}, %reply);
741	}
742	}
743	} else {
744	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
745	}
746
747	cf::override;
748	},
749	;
750
751	#############################################################################	763	#############################################################################
752	# load/save/clean perl data associated with a map	764	# load/save/clean perl data associated with a map
753		765
754	*cf::mapsupport::on_clean = sub {	766	*cf::mapsupport::on_clean = sub {
755	my ($map) = @_;	767	my ($map) = @_;
…		…
783	}	795	}
784	},	796	},
785	;	797	;
786		798
787	#############################################################################	799	#############################################################################
788	# core extensions - in perl	800
		801	=head2 CORE EXTENSIONS
		802
		803	Functions and methods that extend core crossfire objects.
		804
		805	=over 4
789		806
790	=item cf::player::exists $login	807	=item cf::player::exists $login
791		808
792	Returns true when the given account exists.	809	Returns true when the given account exists.
793		810
…		…
796	sub cf::player::exists($) {	813	sub cf::player::exists($) {
797	cf::player::find $_[0]	814	cf::player::find $_[0]
798	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	815	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
799	}	816	}
800		817
801	=item $player->reply ($npc, $msg[, $flags])	818	=item $player_object->reply ($npc, $msg[, $flags])
802		819
803	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	820	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
804	can be C<undef>. Does the right thing when the player is currently in a	821	can be C<undef>. Does the right thing when the player is currently in a
805	dialogue with the given NPC character.	822	dialogue with the given NPC character.
806		823
…		…
833	$msg{msgid} = $id;	850	$msg{msgid} = $id;
834		851
835	$self->send ("ext " . to_json \%msg);	852	$self->send ("ext " . to_json \%msg);
836	}	853	}
837		854
		855	=item $player_object->may ("access")
		856
		857	Returns wether the given player is authorized to access resource "access"
		858	(e.g. "command_wizcast").
		859
		860	=cut
		861
		862	sub cf::object::player::may {
		863	my ($self, $access) = @_;
		864
		865	$self->flag (cf::FLAG_WIZ) \|\|
		866	(ref $cf::CFG{"may_$access"}
		867	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		868	: $cf::CFG{"may_$access"})
		869	}
		870
		871	=cut
		872
838	#############################################################################	873	#############################################################################
839	# map scripting support	874
		875	=head2 SAFE SCRIPTING
		876
		877	Functions that provide a safe environment to compile and execute
		878	snippets of perl code without them endangering the safety of the server
		879	itself. Looping constructs, I/O operators and other built-in functionality
		880	is not available in the safe scripting environment, and the number of
		881	functions and methods that can be called is greatly reduced.
		882
		883	=cut
840		884
841	our $safe = new Safe "safe";	885	our $safe = new Safe "safe";
842	our $safe_hole = new Safe::Hole;	886	our $safe_hole = new Safe::Hole;
843		887
844	$SIG{FPE} = 'IGNORE';	888	$SIG{FPE} = 'IGNORE';
845		889
846	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	890	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
847		891
848	# here we export the classes and methods available to script code	892	# here we export the classes and methods available to script code
849		893
		894	=pod
		895
		896	The following fucntions and emthods are available within a safe environment:
		897
		898	cf::object contr pay_amount pay_player map
		899	cf::object::player player
		900	cf::player peaceful
		901	cf::map trigger
		902
		903	=cut
		904
850	for (	905	for (
851	["cf::object" => qw(contr pay_amount pay_player)],	906	["cf::object" => qw(contr pay_amount pay_player map)],
852	["cf::object::player" => qw(player)],	907	["cf::object::player" => qw(player)],
853	["cf::player" => qw(peaceful)],	908	["cf::player" => qw(peaceful)],
		909	["cf::map" => qw(trigger)],
854	) {	910	) {
855	no strict 'refs';	911	no strict 'refs';
856	my ($pkg, @funs) = @$_;	912	my ($pkg, @funs) = @$_;
857	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	913	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
858	for @funs;	914	for @funs;
859	}	915	}
		916
		917	=over 4
		918
		919	=item @retval = safe_eval $code, [var => value, ...]
		920
		921	Compiled and executes the given perl code snippet. additional var/value
		922	pairs result in temporary local (my) scalar variables of the given name
		923	that are available in the code snippet. Example:
		924
		925	my $five = safe_eval '$first + $second', first => 1, second => 4;
		926
		927	=cut
860		928
861	sub safe_eval($;@) {	929	sub safe_eval($;@) {
862	my ($code, %vars) = @_;	930	my ($code, %vars) = @_;
863		931
864	my $qcode = $code;	932	my $qcode = $code;
…		…
887	}	955	}
888		956
889	wantarray ? @res : $res[0]	957	wantarray ? @res : $res[0]
890	}	958	}
891		959
		960	=item cf::register_script_function $function => $cb
		961
		962	Register a function that can be called from within map/npc scripts. The
		963	function should be reasonably secure and should be put into a package name
		964	like the extension.
		965
		966	Example: register a function that gets called whenever a map script calls
		967	C<rent::overview>, as used by the C<rent> extension.
		968
		969	cf::register_script_function "rent::overview" => sub {
		970	...
		971	};
		972
		973	=cut
		974
892	sub register_script_function {	975	sub register_script_function {
893	my ($fun, $cb) = @_;	976	my ($fun, $cb) = @_;
894		977
895	no strict 'refs';	978	no strict 'refs';
896	*{"safe::$fun"} = $safe_hole->wrap ($cb);	979	*{"safe::$fun"} = $safe_hole->wrap ($cb);
897	}	980	}
898		981
		982	=back
		983
		984	=cut
		985
		986	#############################################################################
		987
		988	=head2 EXTENSION DATABASE SUPPORT
		989
		990	Crossfire maintains a very simple database for extension use. It can
		991	currently store anything that can be serialised using Storable, which
		992	excludes objects.
		993
		994	The parameter C<$family> should best start with the name of the extension
		995	using it, it should be unique.
		996
		997	=over 4
		998
		999	=item $hashref = cf::db_get $family
		1000
		1001	Return a hashref for use by the extension C<$family>, which can be
		1002	modified. After modifications, you have to call C<cf::db_dirty> or
		1003	C<cf::db_sync>.
		1004
		1005	=item $value = cf::db_get $family => $key
		1006
		1007	Returns a single value from the database
		1008
		1009	=item cf::db_put $family => $hashref
		1010
		1011	Stores the given family hashref into the database. Updates are delayed, if
		1012	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1013
		1014	=item cf::db_put $family => $key => $value
		1015
		1016	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1017	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1018
		1019	=item cf::db_dirty
		1020
		1021	Marks the database as dirty, to be updated at a later time.
		1022
		1023	=item cf::db_sync
		1024
		1025	Immediately write the database to disk I<if it is dirty>.
		1026
		1027	=cut
		1028
		1029	our $DB;
		1030
		1031	{
		1032	my $path = cf::localdir . "/database.pst";
		1033
		1034	sub db_load() {
		1035	warn "loading database $path\n";#d# remove later
		1036	$DB = stat $path ? Storable::retrieve $path : { };
		1037	}
		1038
		1039	my $pid;
		1040
		1041	sub db_save() {
		1042	warn "saving database $path\n";#d# remove later
		1043	waitpid $pid, 0 if $pid;
		1044	if (0 == ($pid = fork)) {
		1045	$DB->{_meta}{version} = 1;
		1046	Storable::nstore $DB, "$path~";
		1047	rename "$path~", $path;
		1048	cf::_exit 0 if defined $pid;
		1049	}
		1050	}
		1051
		1052	my $dirty;
		1053
		1054	sub db_sync() {
		1055	db_save if $dirty;
		1056	undef $dirty;
		1057	}
		1058
		1059	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1060	db_sync;
		1061	});
		1062
		1063	sub db_dirty() {
		1064	$dirty = 1;
		1065	$idle->start;
		1066	}
		1067
		1068	sub db_get($;$) {
		1069	@_ >= 2
		1070	? $DB->{$_[0]}{$_[1]}
		1071	: ($DB->{$_[0]} \|\|= { })
		1072	}
		1073
		1074	sub db_put($$;$) {
		1075	if (@_ >= 3) {
		1076	$DB->{$_[0]}{$_[1]} = $_[2];
		1077	} else {
		1078	$DB->{$_[0]} = $_[1];
		1079	}
		1080	db_dirty;
		1081	}
		1082
		1083	attach_global
		1084	prio => 10000,
		1085	on_cleanup => sub {
		1086	db_sync;
		1087	},
		1088	;
		1089	}
		1090
899	#############################################################################	1091	#############################################################################
900	# the server's main()	1092	# the server's main()
901		1093
		1094	sub cfg_load {
		1095	open my $fh, "<:utf8", cf::confdir . "/config"
		1096	or return;
		1097
		1098	local $/;
		1099	*CFG = YAML::Syck::Load <$fh>;
		1100	}
		1101
902	sub main {	1102	sub main {
		1103	cfg_load;
		1104	db_load;
903	load_extensions;	1105	load_extensions;
904	Event::loop;	1106	Event::loop;
905	}	1107	}
906		1108
907	#############################################################################	1109	#############################################################################
908	# initialisation	1110	# initialisation
909		1111
		1112	sub _perl_reload(&) {
		1113	my ($msg) = @_;
		1114
		1115	$msg->("reloading...");
		1116
		1117	eval {
		1118	# cancel all watchers
		1119	for (Event::all_watchers) {
		1120	$_->cancel if $_->data & WF_AUTOCANCEL;
		1121	}
		1122
		1123	# unload all extensions
		1124	for (@exts) {
		1125	$msg->("unloading <$_>");
		1126	unload_extension $_;
		1127	}
		1128
		1129	# unload all modules loaded from $LIBDIR
		1130	while (my ($k, $v) = each %INC) {
		1131	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1132
		1133	$msg->("removing <$k>");
		1134	delete $INC{$k};
		1135
		1136	$k =~ s/\.pm$//;
		1137	$k =~ s/\//::/g;
		1138
		1139	if (my $cb = $k->can ("unload_module")) {
		1140	$cb->();
		1141	}
		1142
		1143	Symbol::delete_package $k;
		1144	}
		1145
		1146	# sync database to disk
		1147	cf::db_sync;
		1148
		1149	# get rid of safe::, as good as possible
		1150	Symbol::delete_package "safe::$_"
		1151	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1152
		1153	# remove register_script_function callbacks
		1154	# TODO
		1155
		1156	# unload cf.pm "a bit"
		1157	delete $INC{"cf.pm"};
		1158
		1159	# don't, removes xs symbols, too,
		1160	# and global variables created in xs
		1161	#Symbol::delete_package __PACKAGE__;
		1162
		1163	# reload cf.pm
		1164	$msg->("reloading cf.pm");
		1165	require cf;
		1166
		1167	# load config and database again
		1168	cf::cfg_load;
		1169	cf::db_load;
		1170
		1171	# load extensions
		1172	$msg->("load extensions");
		1173	cf::load_extensions;
		1174
		1175	# reattach attachments to objects
		1176	$msg->("reattach");
		1177	_global_reattach;
		1178	};
		1179	$msg->($@) if $@;
		1180
		1181	$msg->("reloaded");
		1182	};
		1183
		1184	sub perl_reload() {
		1185	_perl_reload {
		1186	warn $_[0];
		1187	print "$_[0]\n";
		1188	};
		1189	}
		1190
910	register "<global>", __PACKAGE__;	1191	register "<global>", __PACKAGE__;
911		1192
		1193	register_command "perl-reload" => sub {
		1194	my ($who, $arg) = @_;
		1195
		1196	if ($who->flag (FLAG_WIZ)) {
		1197	_perl_reload {
		1198	warn $_[0];
		1199	$who->message ($_[0]);
		1200	};
		1201	}
		1202	};
		1203
912	unshift @INC, $LIBDIR;	1204	unshift @INC, $LIBDIR;
913		1205
914	$TICK_WATCHER = Event->timer (	1206	$TICK_WATCHER = Event->timer (
915	prio => 1,	1207	prio => 0,
916	at => $NEXT_TICK \|\| 1,	1208	at => $NEXT_TICK \|\| 1,
		1209	data => WF_AUTOCANCEL,
917	cb => sub {	1210	cb => sub {
918	cf::server_tick; # one server iteration	1211	cf::server_tick; # one server iteration
919		1212
920	my $NOW = Event::time;	1213	my $NOW = Event::time;
921	$NEXT_TICK += $TICK;	1214	$NEXT_TICK += $TICK;
922		1215
923	# if we are delayed by four ticks, skip them all	1216	# if we are delayed by four ticks or more, skip them all
924	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
925		1218
926	$TICK_WATCHER->at ($NEXT_TICK);	1219	$TICK_WATCHER->at ($NEXT_TICK);
927	$TICK_WATCHER->start;	1220	$TICK_WATCHER->start;
928	},	1221	},
929	);	1222	);
930		1223
		1224	IO::AIO::max_poll_time $TICK * 0.2;
		1225
		1226	Event->io (fd => IO::AIO::poll_fileno,
		1227	poll => 'r',
		1228	prio => 5,
		1229	data => WF_AUTOCANCEL,
		1230	cb => \&IO::AIO::poll_cb);
		1231
931	1	1232	1
932		1233

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.63 by root, Fri Sep 8 17:41:41 2006 UTC vs. Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.63 by root, Fri Sep 8 17:41:41 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC