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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.58 by root, Wed Aug 30 12:08:15 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
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
…		…
125		152
126	=item $map->attach ($attachment, key => $value...)	153	=item $map->attach ($attachment, key => $value...)
127		154
128	=item $map->detach ($attachment)	155	=item $map->detach ($attachment)
129		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
130	Attach/detach a pre-registered attachment to a map.	163	Attach/detach a pre-registered attachment to a map.
131		164
132	=item $bool = $object->attached ($name)	165	=item $bool = $object->attached ($name)
133		166
134	=item $bool = $player->attached ($name)	167	=item $bool = $player->attached ($name)
		168
		169	=item $bool = $client->attached ($name)
135		170
136	=item $bool = $map->attached ($name)	171	=item $bool = $map->attached ($name)
137		172
138	Checks wether the named attachment is currently attached to the object.	173	Checks wether the named attachment is currently attached to the object.
139		174
…		…
186		221
187	=item cf::attach_to_players ...	222	=item cf::attach_to_players ...
188		223
189	Attach handlers to all players.	224	Attach handlers to all players.
190		225
		226	=item cf::attach_to_clients ...
		227
		228	Attach handlers to all players.
		229
191	=item cf::attach_to_maps ...	230	=item cf::attach_to_maps ...
192		231
193	Attach handlers to all maps.	232	Attach handlers to all maps.
194		233
195	=item cf:register_attachment $name, ...	234	=item cf:register_attachment $name, ...
…		…
211		250
212	# 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
213	our @CB_GLOBAL = (); # registry for all global events	252	our @CB_GLOBAL = (); # registry for all global events
214	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)
215	our @CB_PLAYER = ();	254	our @CB_PLAYER = ();
		255	our @CB_CLIENT = ();
216	our @CB_TYPE = (); # registry for type (cf-object class) based events	256	our @CB_TYPE = (); # registry for type (cf-object class) based events
217	our @CB_MAP = ();	257	our @CB_MAP = ();
218		258
219	my %attachment;	259	my %attachment;
220		260
…		…
303	$res	343	$res
304	}	344	}
305		345
306	*cf::object::attach =	346	*cf::object::attach =
307	*cf::player::attach =	347	*cf::player::attach =
		348	*cf::client::attach =
308	*cf::map::attach = sub {	349	*cf::map::attach = sub {
309	my ($obj, $name, %arg) = @_;	350	my ($obj, $name, %arg) = @_;
310		351
311	_attach_attachment $obj, $name, %arg;	352	_attach_attachment $obj, $name, %arg;
312	};	353	};
313		354
314	# all those should be optimised	355	# all those should be optimised
315	*cf::object::detach =	356	*cf::object::detach =
316	*cf::player::detach =	357	*cf::player::detach =
		358	*cf::client::detach =
317	*cf::map::detach = sub {	359	*cf::map::detach = sub {
318	my ($obj, $name) = @_;	360	my ($obj, $name) = @_;
319		361
320	delete $obj->{_attachment}{$name};	362	delete $obj->{_attachment}{$name};
321	reattach ($obj);	363	reattach ($obj);
322	};	364	};
323		365
324	*cf::object::attached =	366	*cf::object::attached =
325	*cf::player::attached =	367	*cf::player::attached =
		368	*cf::client::attached =
326	*cf::map::attached = sub {	369	*cf::map::attached = sub {
327	my ($obj, $name) = @_;	370	my ($obj, $name) = @_;
328		371
329	exists $obj->{_attachment}{$name}	372	exists $obj->{_attachment}{$name}
330	};	373	};
…		…
346		389
347	sub attach_to_players {	390	sub attach_to_players {
348	_attach @CB_PLAYER, KLASS_PLAYER, @_	391	_attach @CB_PLAYER, KLASS_PLAYER, @_
349	}	392	}
350		393
		394	sub attach_to_clients {
		395	_attach @CB_CLIENT, KLASS_CLIENT, @_
		396	}
		397
351	sub attach_to_maps {	398	sub attach_to_maps {
352	_attach @CB_MAP, KLASS_MAP, @_	399	_attach @CB_MAP, KLASS_MAP, @_
353	}	400	}
354		401
355	sub register_attachment {	402	sub register_attachment {
…		…
360		407
361	sub register_player_attachment {	408	sub register_player_attachment {
362	my $name = shift;	409	my $name = shift;
363		410
364	$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, @_]];
365	}	418	}
366		419
367	sub register_map_attachment {	420	sub register_map_attachment {
368	my $name = shift;	421	my $name = shift;
369		422
…		…
389	for (@$callbacks) {	442	for (@$callbacks) {
390	eval { &{$_->[1]} };	443	eval { &{$_->[1]} };
391		444
392	if ($@) {	445	if ($@) {
393	warn "$@";	446	warn "$@";
394	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	447	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
395	override;	448	override;
396	}	449	}
397		450
398	return 1 if $override;	451	return 1 if $override;
399	}	452	}
…		…
404	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	457	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
405		458
406	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)	459	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407		460
408	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)	461	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		462
		463	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
409		464
410	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)	465	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411		466
412	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.
413		468
…		…
415	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
416	results (if you must, access C<@cf::invoke_results> directly).	471	results (if you must, access C<@cf::invoke_results> directly).
417		472
418	=back	473	=back
419		474
420	=head2 methods valid for all pointers	475	=cut
		476
		477	#############################################################################
		478
		479	=head2 METHODS VALID FOR ALL CORE OBJECTS
421		480
422	=over 4	481	=over 4
423		482
424	=item $object->valid	483	=item $object->valid, $player->valid, $client->valid, $map->valid
425
426	=item $player->valid
427
428	=item $map->valid
429		484
430	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
431	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
432	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
433	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
…		…
437		492
438	=cut	493	=cut
439		494
440	*cf::object::valid =	495	*cf::object::valid =
441	*cf::player::valid =	496	*cf::player::valid =
		497	*cf::client::valid =
442	*cf::map::valid = \&cf::_valid;	498	*cf::map::valid = \&cf::_valid;
443		499
444	#############################################################################	500	#############################################################################
445	# object support	501	# object support
446		502
…		…
476	}	532	}
477	}	533	}
478	}	534	}
479		535
480	sub object_freezer_save {	536	sub object_freezer_save {
481	my ($filename, $objs) = @_;	537	my ($filename, $rdata, $objs) = @_;
482		538
483	if (@$objs) {	539	if (length $$rdata) {
		540	warn sprintf "saving %s (%d,%d)\n",
		541	$filename, length $$rdata, scalar @$objs;
		542
484	open my $fh, ">:raw", "$filename.pst~";	543	if (open my $fh, ">:raw", "$filename~") {
		544	chmod SAVE_MODE, $fh;
		545	syswrite $fh, $$rdata;
		546	close $fh;
		547
		548	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		549	chmod SAVE_MODE, $fh;
485	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	550	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
486	close $fh;	551	close $fh;
487	chmod SAVE_MODE, "$filename.pst~";
488	rename "$filename.pst~", "$filename.pst";	552	rename "$filename.pst~", "$filename.pst";
		553	} else {
		554	unlink "$filename.pst";
		555	}
		556
		557	rename "$filename~", $filename;
		558	} else {
		559	warn "FATAL: $filename~: $!\n";
		560	}
489	} else {	561	} else {
		562	unlink $filename;
490	unlink "$filename.pst";	563	unlink "$filename.pst";
491	}	564	}
		565	}
492		566
493	chmod SAVE_MODE, "$filename~";	567	sub object_freezer_as_string {
494	rename "$filename~", $filename;	568	my ($rdata, $objs) = @_;
		569
		570	use Data::Dumper;
		571
		572	$$rdata . Dumper $objs
495	}	573	}
496		574
497	sub object_thawer_load {	575	sub object_thawer_load {
498	my ($filename) = @_;	576	my ($filename) = @_;
499		577
		578	local $/;
		579
		580	my $av;
		581
		582	#TODO: use sysread etc.
		583	if (open my $data, "<:raw:perlio", $filename) {
		584	$data = <$data>;
500	open my $fh, "<:raw:perlio", "$filename.pst"	585	if (open my $pst, "<:raw:perlio", "$filename.pst") {
501	or return;	586	$av = eval { (Storable::thaw <$pst>)->{objs} };
		587	}
		588	return ($data, $av);
		589	}
502		590
503	eval { local $/; (Storable::thaw <$fh>)->{objs} }	591	()
504	}	592	}
505		593
506	attach_to_objects	594	attach_to_objects
507	prio => -1000000,	595	prio => -1000000,
508	on_clone => sub {	596	on_clone => sub {
…		…
516	if exists $src->{_attachment};	604	if exists $src->{_attachment};
517	},	605	},
518	;	606	;
519		607
520	#############################################################################	608	#############################################################################
521	# old plug-in events	609	# command handling &c
522		610
523	sub inject_event {	611	=item cf::register_command $name => \&callback($ob,$args);
524	my $extension = shift;
525	my $event_code = shift;
526		612
527	my $cb = $hook[$event_code]{$extension}	613	Register a callback for execution when the client sends the user command
528	or return;	614	$name.
529		615
530	&$cb	616	=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		617
552	sub register_command {	618	sub register_command {
553	my ($name, $time, $cb) = @_;	619	my ($name, $cb) = @_;
554		620
555	my $caller = caller;	621	my $caller = caller;
556	#warn "registering command '$name/$time' to '$caller'";	622	#warn "registering command '$name/$time' to '$caller'";
557		623
558	push @{ $command{$name} }, [$time, $cb, $caller];	624	push @{ $COMMAND{$name} }, [$caller, $cb];
559	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
560	}	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
561		635
562	sub register_extcmd {	636	sub register_extcmd {
563	my ($name, $cb) = @_;	637	my ($name, $cb) = @_;
564		638
565	my $caller = caller;	639	my $caller = caller;
566	#warn "registering extcmd '$name' to '$caller'";	640	#warn "registering extcmd '$name' to '$caller'";
567		641
568	$extcmd{$name} = [$cb, $caller];	642	$EXTCMD{$name} = [$cb, $caller];
569	}	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	;
570		676
571	sub register {	677	sub register {
572	my ($base, $pkg) = @_;	678	my ($base, $pkg) = @_;
573		679
574	#TODO	680	#TODO
…		…
593	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
594	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
595	. "\n};\n1";	701	. "\n};\n1";
596		702
597	eval $source	703	eval $source
598	or die "$path: $@";	704	or die $@ ? "$path: $@\n"
		705	: "extension disabled.\n";
599		706
600	push @exts, $pkg;	707	push @exts, $pkg;
601	$ext_pkg{$base} = $pkg;	708	$ext_pkg{$base} = $pkg;
602		709
603	# no strict 'refs';	710	# no strict 'refs';
…		…
616	# for my $idx (0 .. $#PLUGIN_EVENT) {	723	# for my $idx (0 .. $#PLUGIN_EVENT) {
617	# delete $hook[$idx]{$pkg};	724	# delete $hook[$idx]{$pkg};
618	# }	725	# }
619		726
620	# remove commands	727	# remove commands
621	for my $name (keys %command) {	728	for my $name (keys %COMMAND) {
622	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	729	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
623		730
624	if (@cb) {	731	if (@cb) {
625	$command{$name} = \@cb;	732	$COMMAND{$name} = \@cb;
626	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
627	} else {	733	} else {
628	delete $command{$name};
629	delete $COMMAND{"$name\000"};	734	delete $COMMAND{$name};
630	}	735	}
631	}	736	}
632		737
633	# remove extcmds	738	# remove extcmds
634	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	739	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
635	delete $extcmd{$name};	740	delete $EXTCMD{$name};
636	}	741	}
637		742
638	if (my $cb = $pkg->can ("unload")) {	743	if (my $cb = $pkg->can ("unload")) {
639	eval {	744	eval {
640	$cb->($pkg);	745	$cb->($pkg);
…		…
644		749
645	Symbol::delete_package $pkg;	750	Symbol::delete_package $pkg;
646	}	751	}
647		752
648	sub load_extensions {	753	sub load_extensions {
649	my $LIBDIR = maps_directory "perl";
650
651	for my $ext (<$LIBDIR/*.ext>) {	754	for my $ext (<$LIBDIR/*.ext>) {
652	next unless -r $ext;	755	next unless -r $ext;
653	eval {	756	eval {
654	load_extension $ext;	757	load_extension $ext;
655	1	758	1
656	} or warn "$ext not loaded: $@";	759	} or warn "$ext not loaded: $@";
657	}	760	}
658	}	761	}
659		762
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	#############################################################################	763	#############################################################################
758	# load/save/clean perl data associated with a map	764	# load/save/clean perl data associated with a map
759		765
760	*cf::mapsupport::on_clean = sub {	766	*cf::mapsupport::on_clean = sub {
761	my ($map) = @_;	767	my ($map) = @_;
…		…
773		779
774	sub all_objects(@) {	780	sub all_objects(@) {
775	@_, map all_objects ($_->inv), @_	781	@_, map all_objects ($_->inv), @_
776	}	782	}
777		783
		784	# TODO: compatibility cruft, remove when no longer needed
778	attach_to_players	785	attach_to_players
779	on_load => sub {	786	on_load => sub {
780	my ($pl, $path) = @_;	787	my ($pl, $path) = @_;
781		788
782	for my $o (all_objects $pl->ob) {	789	for my $o (all_objects $pl->ob) {
…		…
788	}	795	}
789	},	796	},
790	;	797	;
791		798
792	#############################################################################	799	#############################################################################
793	# core extensions - in perl	800
		801	=head2 CORE EXTENSIONS
		802
		803	Functions and methods that extend core crossfire objects.
		804
		805	=over 4
794		806
795	=item cf::player::exists $login	807	=item cf::player::exists $login
796		808
797	Returns true when the given account exists.	809	Returns true when the given account exists.
798		810
…		…
801	sub cf::player::exists($) {	813	sub cf::player::exists($) {
802	cf::player::find $_[0]	814	cf::player::find $_[0]
803	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;
804	}	816	}
805		817
806	=item $player->reply ($npc, $msg[, $flags])	818	=item $player_object->reply ($npc, $msg[, $flags])
807		819
808	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>
809	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
810	dialogue with the given NPC character.	822	dialogue with the given NPC character.
811		823
…		…
838	$msg{msgid} = $id;	850	$msg{msgid} = $id;
839		851
840	$self->send ("ext " . to_json \%msg);	852	$self->send ("ext " . to_json \%msg);
841	}	853	}
842		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
843	#############################################################################	873	#############################################################################
844	# 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
845		884
846	our $safe = new Safe "safe";	885	our $safe = new Safe "safe";
847	our $safe_hole = new Safe::Hole;	886	our $safe_hole = new Safe::Hole;
848		887
849	$SIG{FPE} = 'IGNORE';	888	$SIG{FPE} = 'IGNORE';
850		889
851	$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));
852		891
853	# here we export the classes and methods available to script code	892	# here we export the classes and methods available to script code
854		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
855	for (	905	for (
856	["cf::object" => qw(contr pay_amount pay_player)],	906	["cf::object" => qw(contr pay_amount pay_player map)],
857	["cf::object::player" => qw(player)],	907	["cf::object::player" => qw(player)],
858	["cf::player" => qw(peaceful)],	908	["cf::player" => qw(peaceful)],
		909	["cf::map" => qw(trigger)],
859	) {	910	) {
860	no strict 'refs';	911	no strict 'refs';
861	my ($pkg, @funs) = @$_;	912	my ($pkg, @funs) = @$_;
862	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	913	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
863	for @funs;	914	for @funs;
864	}	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
865		928
866	sub safe_eval($;@) {	929	sub safe_eval($;@) {
867	my ($code, %vars) = @_;	930	my ($code, %vars) = @_;
868		931
869	my $qcode = $code;	932	my $qcode = $code;
…		…
892	}	955	}
893		956
894	wantarray ? @res : $res[0]	957	wantarray ? @res : $res[0]
895	}	958	}
896		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
897	sub register_script_function {	975	sub register_script_function {
898	my ($fun, $cb) = @_;	976	my ($fun, $cb) = @_;
899		977
900	no strict 'refs';	978	no strict 'refs';
901	*{"safe::$fun"} = $safe_hole->wrap ($cb);	979	*{"safe::$fun"} = $safe_hole->wrap ($cb);
902	}	980	}
903		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
904	#############################################################################	1091	#############################################################################
905	# the server's main()	1092	# the server's main()
906		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
907	sub main {	1102	sub main {
		1103	cfg_load;
		1104	db_load;
		1105	load_extensions;
908	Event::loop;	1106	Event::loop;
909	}	1107	}
910		1108
911	#############################################################################	1109	#############################################################################
912	# initialisation	1110	# initialisation
913		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
914	register "<global>", __PACKAGE__;	1191	register "<global>", __PACKAGE__;
915		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
916	unshift @INC, $LIBDIR;	1204	unshift @INC, $LIBDIR;
917		1205
918	load_extensions;
919
920	$TICK_WATCHER = Event->timer (	1206	$TICK_WATCHER = Event->timer (
921	prio => 1,	1207	prio => 0,
922	at => $NEXT_TICK \|\| 1,	1208	at => $NEXT_TICK \|\| 1,
		1209	data => WF_AUTOCANCEL,
923	cb => sub {	1210	cb => sub {
924	cf::server_tick; # one server iteration	1211	cf::server_tick; # one server iteration
925		1212
926	my $NOW = Event::time;	1213	my $NOW = Event::time;
927	$NEXT_TICK += $TICK;	1214	$NEXT_TICK += $TICK;
928		1215
929	# if we are delayed by four ticks, skip them all	1216	# if we are delayed by four ticks or more, skip them all
930	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
931		1218
932	$TICK_WATCHER->at ($NEXT_TICK);	1219	$TICK_WATCHER->at ($NEXT_TICK);
933	$TICK_WATCHER->start;	1220	$TICK_WATCHER->start;
934	},	1221	},
935	);	1222	);
936		1223
937	_reload_2;	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);
938		1231
939	1	1232	1
940		1233

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.58 by root, Wed Aug 30 12:08:15 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.58 by root, Wed Aug 30 12:08:15 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC