ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.38 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.85 by root, Mon Dec 11 22:56:57 2006 UTC

…		…
5	use Storable;	5	use Storable;
6	use Opcode;	6	use Opcode;
7	use Safe;	7	use Safe;
8	use Safe::Hole;	8	use Safe::Hole;
9		9
		10	use IO::AIO ();
		11	use YAML::Syck ();
10	use Time::HiRes;	12	use Time::HiRes;
11	use Event;	13	use Event;
12	$Event::Eval = 1; # no idea why this is required, but it is	14	$Event::Eval = 1; # no idea why this is required, but it is
13		15
		16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		17	$YAML::Syck::ImplicitUnicode = 1;
		18
14	use strict;	19	use strict;
15		20
16	our %COMMAND;	21	our %COMMAND = ();
		22	our %COMMAND_TIME = ();
		23	our %EXTCMD = ();
		24
		25	_init_vars;
		26
17	our @EVENT;	27	our @EVENT;
18	our @PLUGIN_EVENT;
19	our %PROP_TYPE;
20	our %PROP_IDX;
21	our $LIBDIR = maps_directory "perl";	28	our $LIBDIR = maps_directory "perl";
22		29
23	our $TICK = MAX_TIME * 1e-6;	30	our $TICK = MAX_TIME * 1e-6;
24	our $TICK_WATCHER;	31	our $TICK_WATCHER;
25	our $NEXT_TICK;	32	our $NEXT_TICK;
26		33
		34	our %CFG;
		35
		36	our $UPTIME; $UPTIME ||= time;
		37
		38	#############################################################################
		39
		40	=head2 GLOBAL VARIABLES
		41
		42	=over 4
		43
		44	=item $cf::UPTIME
		45
		46	The timestamp of the server start (so not actually an uptime).
		47
		48	=item $cf::LIBDIR
		49
		50	The perl library directory, where extensions and cf-specific modules can
		51	be found. It will be added to C<@INC> automatically.
		52
		53	=item $cf::TICK
		54
		55	The interval between server ticks, in seconds.
		56
		57	=item %cf::CFG
		58
		59	Configuration for the server, loaded from C</etc/crossfire/config>, or
		60	from wherever your confdir points to.
		61
		62	=back
		63
		64	=cut
		65
27	BEGIN {	66	BEGIN {
28	@PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30	*CORE::GLOBAL::warn = sub {	67	*CORE::GLOBAL::warn = sub {
31	my $msg = join "", @_;	68	my $msg = join "", @_;
32	$msg .= "\n"	69	$msg .= "\n"
33	unless $msg =~ /\n$/;	70	unless $msg =~ /\n$/;
34		71
35	print STDERR "cfperl: $msg";	72	print STDERR "cfperl: $msg";
36	LOG llevError, "cfperl: $msg";	73	LOG llevError, "cfperl: $msg";
37	};	74	};
38	}	75	}
39		76
40	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	77	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
41		78
42	# generate property mutators	79	# we bless all objects into (empty) derived classes to force a method lookup
43	sub prop_gen {	80	# within the Safe compartment.
44	my ($prefix, $class) = @_;	81	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
45
46	no strict 'refs';	82	no strict 'refs';
47
48	for my $prop (keys %PROP_TYPE) {
49	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
50	my $sub = lc $1;
51
52	my $type = $PROP_TYPE{$prop};
53	my $idx = $PROP_IDX {$prop};
54
55	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
56	$_[0]->get_property ($type, $idx)
57	};
58
59	*{"$class\::set_$sub"} = sub {
60	$_[0]->set_property ($type, $idx, $_[1]);
61	} unless $ignore_set{$prop};
62	}
63	}
64
65	# auto-generate most of the API
66
67	prop_gen OBJECT_PROP => "cf::object";
68	# CFAPI_OBJECT_ANIMATION?
69	prop_gen PLAYER_PROP => "cf::object::player";
70
71	prop_gen MAP_PROP => "cf::map";
72	prop_gen ARCH_PROP => "cf::arch";
73
74	# guessed hierarchies
75
76	@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
77	@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78
79	# we bless all objects into derived classes to force a method lookup
80	# within the Safe compartment.
81	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
82	no strict 'refs';
83	@{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	84	}
85		85
86	$Event::DIED = sub {	86	$Event::DIED = sub {
87	warn "error in event callback: @_";	87	warn "error in event callback: @_";
88	};	88	};
89		89
90	my %ext_pkg;	90	my %ext_pkg;
91	my @exts;	91	my @exts;
92	my @hook;	92	my @hook;
93	my %command;
94	my %extcmd;
95		93
96	sub inject_event {	94	=head2 UTILITY FUNCTIONS
		95
		96	=over 4
		97
		98	=cut
		99
		100	use JSON::Syck (); # TODO# replace by JSON::PC once working
		101
		102	=item $ref = cf::from_json $json
		103
		104	Converts a JSON string into the corresponding perl data structure.
		105
		106	=cut
		107
		108	sub from_json($) {
		109	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
		110	JSON::Syck::Load $_[0]
		111	}
		112
		113	=item $json = cf::to_json $ref
		114
		115	Converts a perl data structure into its JSON representation.
		116
		117	=cut
		118
		119	sub to_json($) {
		120	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
		121	JSON::Syck::Dump $_[0]
		122	}
		123
		124	=back
		125
		126	=cut
		127
		128	#############################################################################
		129
		130	=head2 EVENTS AND OBJECT ATTACHMENTS
		131
		132	=over 4
		133
		134	=item $object->attach ($attachment, key => $value...)
		135
		136	=item $object->detach ($attachment)
		137
		138	Attach/detach a pre-registered attachment to an object.
		139
		140	=item $player->attach ($attachment, key => $value...)
		141
		142	=item $player->detach ($attachment)
		143
		144	Attach/detach a pre-registered attachment to a player.
		145
		146	=item $map->attach ($attachment, key => $value...)
		147
		148	=item $map->detach ($attachment)
		149
		150	Attach/detach a pre-registered attachment to a map.
		151
		152	=item $bool = $object->attached ($name)
		153
		154	=item $bool = $player->attached ($name)
		155
		156	=item $bool = $map->attached ($name)
		157
		158	Checks wether the named attachment is currently attached to the object.
		159
		160	=item cf::attach_global ...
		161
		162	Attach handlers for global events.
		163
		164	This and all following C<attach_*>-functions expect any number of the
		165	following handler/hook descriptions:
		166
		167	=over 4
		168
		169	=item prio => $number
		170
		171	Set the priority for all following handlers/hooks (unless overwritten
		172	by another C<prio> setting). Lower priority handlers get executed
		173	earlier. The default priority is C<0>, and many built-in handlers are
		174	registered at priority C<-1000>, so lower priorities should not be used
		175	unless you know what you are doing.
		176
		177	=item on_I<event> => \&cb
		178
		179	Call the given code reference whenever the named event happens (event is
		180	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		181	handlers are recognised generally depends on the type of object these
		182	handlers attach to).
		183
		184	See F<include/eventinc.h> for the full list of events supported, and their
		185	class.
		186
		187	=item package => package::
		188
		189	Look for sub functions of the name C<< on_I<event> >> in the given
		190	package and register them. Only handlers for eevents supported by the
		191	object/class are recognised.
		192
		193	=back
		194
		195	=item cf::attach_to_type $object_type, $subtype, ...
		196
		197	Attach handlers for a specific object type (e.g. TRANSPORT) and
		198	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		199	type.
		200
		201	=item cf::attach_to_objects ...
		202
		203	Attach handlers to all objects. Do not use this except for debugging or
		204	very rare events, as handlers are (obviously) called for I<all> objects in
		205	the game.
		206
		207	=item cf::attach_to_players ...
		208
		209	Attach handlers to all players.
		210
		211	=item cf::attach_to_maps ...
		212
		213	Attach handlers to all maps.
		214
		215	=item cf:register_attachment $name, ...
		216
		217	Register an attachment by name through which objects can refer to this
		218	attachment.
		219
		220	=item cf:register_player_attachment $name, ...
		221
		222	Register an attachment by name through which players can refer to this
		223	attachment.
		224
		225	=item cf:register_map_attachment $name, ...
		226
		227	Register an attachment by name through which maps can refer to this
		228	attachment.
		229
		230	=cut
		231
		232	# the following variables are defined in .xs and must not be re-created
		233	our @CB_GLOBAL = (); # registry for all global events
		234	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		235	our @CB_PLAYER = ();
		236	our @CB_TYPE = (); # registry for type (cf-object class) based events
		237	our @CB_MAP = ();
		238
		239	my %attachment;
		240
		241	sub _attach_cb($\%$$$) {
		242	my ($registry, $undo, $event, $prio, $cb) = @_;
		243
		244	use sort 'stable';
		245
		246	$cb = [$prio, $cb];
		247
		248	@{$registry->[$event]} = sort
		249	{ $a->[0] cmp $b->[0] }
		250	@{$registry->[$event] || []}, $cb;
		251
		252	push @{$undo->{cb}}, [$event, $cb];
		253	}
		254
		255	# attach handles attaching event callbacks
		256	# the only thing the caller has to do is pass the correct
		257	# registry (== where the callback attaches to).
		258	sub _attach(\@$@) {
		259	my ($registry, $klass, @arg) = @_;
		260
		261	my $prio = 0;
		262
		263	my %undo = (
		264	registry => $registry,
		265	cb => [],
		266	);
		267
		268	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		269
		270	while (@arg) {
		271	my $type = shift @arg;
		272
		273	if ($type eq "prio") {
		274	$prio = shift @arg;
		275
		276	} elsif ($type eq "package") {
		277	my $pkg = shift @arg;
		278
		279	while (my ($name, $id) = each %cb_id) {
		280	if (my $cb = $pkg->can ($name)) {
		281	_attach_cb $registry, %undo, $id, $prio, $cb;
		282	}
		283	}
		284
		285	} elsif (exists $cb_id{$type}) {
		286	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
		287
		288	} elsif (ref $type) {
		289	warn "attaching objects not supported, ignoring.\n";
		290
		291	} else {
		292	shift @arg;
		293	warn "attach argument '$type' not supported, ignoring.\n";
		294	}
		295	}
		296
		297	\%undo
		298	}
		299
		300	sub _attach_attachment {
		301	my ($obj, $name, %arg) = @_;
		302
		303	return if exists $obj->{_attachment}{$name};
		304
		305	my $res;
		306
		307	if (my $attach = $attachment{$name}) {
		308	my $registry = $obj->registry;
		309
		310	for (@$attach) {
		311	my ($klass, @attach) = @$_;
		312	$res = _attach @$registry, $klass, @attach;
		313	}
		314
		315	$obj->{$name} = \%arg;
		316	} else {
		317	warn "object uses attachment '$name' that is not available, postponing.\n";
		318	}
		319
		320	$obj->{_attachment}{$name} = undef;
		321
		322	$res->{attachment} = $name;
		323	$res
		324	}
		325
		326	*cf::object::attach =
		327	*cf::player::attach =
		328	*cf::map::attach = sub {
		329	my ($obj, $name, %arg) = @_;
		330
		331	_attach_attachment $obj, $name, %arg;
		332	};
		333
		334	# all those should be optimised
		335	*cf::object::detach =
		336	*cf::player::detach =
		337	*cf::map::detach = sub {
		338	my ($obj, $name) = @_;
		339
		340	delete $obj->{_attachment}{$name};
		341	reattach ($obj);
		342	};
		343
		344	*cf::object::attached =
		345	*cf::player::attached =
		346	*cf::map::attached = sub {
		347	my ($obj, $name) = @_;
		348
		349	exists $obj->{_attachment}{$name}
		350	};
		351
		352	sub attach_global {
		353	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
		354	}
		355
		356	sub attach_to_type {
97	my $extension = shift;	357	my $type = shift;
98	my $event_code = shift;	358	my $subtype = shift;
99		359
100	my $cb = $hook[$event_code]{$extension}	360	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
101	or return;
102
103	&$cb
104	}	361	}
105		362
106	sub inject_global_event {	363	sub attach_to_objects {
		364	_attach @CB_OBJECT, KLASS_OBJECT, @_
		365	}
		366
		367	sub attach_to_players {
		368	_attach @CB_PLAYER, KLASS_PLAYER, @_
		369	}
		370
		371	sub attach_to_maps {
		372	_attach @CB_MAP, KLASS_MAP, @_
		373	}
		374
		375	sub register_attachment {
		376	my $name = shift;
		377
		378	$attachment{$name} = [[KLASS_OBJECT, @_]];
		379	}
		380
		381	sub register_player_attachment {
		382	my $name = shift;
		383
		384	$attachment{$name} = [[KLASS_PLAYER, @_]];
		385	}
		386
		387	sub register_map_attachment {
		388	my $name = shift;
		389
		390	$attachment{$name} = [[KLASS_MAP, @_]];
		391	}
		392
		393	our $override;
		394	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		395
		396	sub override {
		397	$override = 1;
		398	@invoke_results = ();
		399	}
		400
		401	sub do_invoke {
107	my $event = shift;	402	my $event = shift;
		403	my $callbacks = shift;
108		404
109	my $cb = $hook[$event]	405	@invoke_results = ();
110	or return;
111		406
112	List::Util::max map &$_, values %$cb	407	local $override;
113	}
114		408
115	sub inject_command {	409	for (@$callbacks) {
		410	eval { &{$_->[1]} };
		411
		412	if ($@) {
		413	warn "$@";
		414	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		415	override;
		416	}
		417
		418	return 1 if $override;
		419	}
		420
		421	0
		422	}
		423
		424	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		425
		426	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		427
		428	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		429
		430	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		431
		432	Generate a global/object/player/map-specific event with the given arguments.
		433
		434	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		435	removed in future versions), and there is no public API to access override
		436	results (if you must, access C<@cf::invoke_results> directly).
		437
		438	=back
		439
		440	=cut
		441
		442	#############################################################################
		443
		444	=head2 METHODS VALID FOR ALL CORE OBJECTS
		445
		446	=over 4
		447
		448	=item $object->valid, $player->valid, $map->valid
		449
		450	Just because you have a perl object does not mean that the corresponding
		451	C-level object still exists. If you try to access an object that has no
		452	valid C counterpart anymore you get an exception at runtime. This method
		453	can be used to test for existence of the C object part without causing an
		454	exception.
		455
		456	=back
		457
		458	=cut
		459
		460	*cf::object::valid =
		461	*cf::player::valid =
		462	*cf::map::valid = \&cf::_valid;
		463
		464	#############################################################################
		465	# object support
		466
		467	sub instantiate {
		468	my ($obj, $data) = @_;
		469
		470	$data = from_json $data;
		471
		472	for (@$data) {
116	my ($name, $obj, $params) = @_;	473	my ($name, $args) = @$_;
117		474
118	for my $cmd (@{ $command{$name} }) {	475	$obj->attach ($name, %{$args || {} });
119	$cmd->[1]->($obj, $params);	476	}
		477	}
		478
		479	# basically do the same as instantiate, without calling instantiate
		480	sub reattach {
		481	my ($obj) = @_;
		482	my $registry = $obj->registry;
		483
		484	@$registry = ();
		485
		486	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		487
		488	for my $name (keys %{ $obj->{_attachment} || {} }) {
		489	if (my $attach = $attachment{$name}) {
		490	for (@$attach) {
		491	my ($klass, @attach) = @$_;
		492	_attach @$registry, $klass, @attach;
		493	}
		494	} else {
		495	warn "object uses attachment '$name' that is not available, postponing.\n";
		496	}
		497	}
		498	}
		499
		500	sub object_freezer_save {
		501	my ($filename, $rdata, $objs) = @_;
		502
		503	if (length $$rdata) {
		504	warn sprintf "saving %s (%d,%d)\n",
		505	$filename, length $$rdata, scalar @$objs;
		506
		507	if (open my $fh, ">:raw", "$filename~") {
		508	chmod SAVE_MODE, $fh;
		509	syswrite $fh, $$rdata;
		510	close $fh;
		511
		512	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		513	chmod SAVE_MODE, $fh;
		514	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		515	close $fh;
		516	rename "$filename.pst~", "$filename.pst";
		517	} else {
		518	unlink "$filename.pst";
		519	}
		520
		521	rename "$filename~", $filename;
		522	} else {
		523	warn "FATAL: $filename~: $!\n";
		524	}
		525	} else {
		526	unlink $filename;
		527	unlink "$filename.pst";
		528	}
		529	}
		530
		531	sub object_freezer_as_string {
		532	my ($rdata, $objs) = @_;
		533
		534	use Data::Dumper;
		535
		536	$$rdata . Dumper $objs
		537	}
		538
		539	sub object_thawer_load {
		540	my ($filename) = @_;
		541
		542	local $/;
		543
		544	my $av;
		545
		546	#TODO: use sysread etc.
		547	if (open my $data, "<:raw:perlio", $filename) {
		548	$data = <$data>;
		549	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		550	$av = eval { (Storable::thaw <$pst>)->{objs} };
		551	}
		552	return ($data, $av);
		553	}
		554
		555	()
		556	}
		557
		558	attach_to_objects
		559	prio => -1000000,
		560	on_clone => sub {
		561	my ($src, $dst) = @_;
		562
		563	@{$dst->registry} = @{$src->registry};
		564
		565	%$dst = %$src;
		566
		567	%{$dst->{_attachment}} = %{$src->{_attachment}}
		568	if exists $src->{_attachment};
120	}	569	},
		570	;
121		571
122	-1	572	#############################################################################
123	}	573	# command handling &c
		574
		575	=item cf::register_command $name => \&callback($ob,$args);
		576
		577	Register a callback for execution when the client sends the user command
		578	$name.
		579
		580	=cut
124		581
125	sub register_command {	582	sub register_command {
126	my ($name, $time, $cb) = @_;	583	my ($name, $cb) = @_;
127		584
128	my $caller = caller;	585	my $caller = caller;
129	#warn "registering command '$name/$time' to '$caller'";	586	#warn "registering command '$name/$time' to '$caller'";
130		587
131	push @{ $command{$name} }, [$time, $cb, $caller];	588	push @{ $COMMAND{$name} }, [$caller, $cb];
132	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
133	}	589	}
		590
		591	=item cf::register_extcmd $name => \&callback($pl,$packet);
		592
		593	Register a callbackf ro execution when the client sends an extcmd packet.
		594
		595	If the callback returns something, it is sent back as if reply was being
		596	called.
		597
		598	=cut
134		599
135	sub register_extcmd {	600	sub register_extcmd {
136	my ($name, $cb) = @_;	601	my ($name, $cb) = @_;
137		602
138	my $caller = caller;	603	my $caller = caller;
139	#warn "registering extcmd '$name' to '$caller'";	604	#warn "registering extcmd '$name' to '$caller'";
140		605
141	$extcmd{$name} = [$cb, $caller];	606	$EXTCMD{$name} = [$cb, $caller];
142	}	607	}
		608
		609	attach_to_players
		610	on_command => sub {
		611	my ($pl, $name, $params) = @_;
		612
		613	my $cb = $COMMAND{$name}
		614	or return;
		615
		616	for my $cmd (@$cb) {
		617	$cmd->[1]->($pl->ob, $params);
		618	}
		619
		620	cf::override;
		621	},
		622	on_extcmd => sub {
		623	my ($pl, $buf) = @_;
		624
		625	my $msg = eval { from_json $buf };
		626
		627	if (ref $msg) {
		628	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		629	if (my %reply = $cb->[0]->($pl, $msg)) {
		630	$pl->ext_reply ($msg->{msgid}, %reply);
		631	}
		632	}
		633	} else {
		634	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		635	}
		636
		637	cf::override;
		638	},
		639	;
143		640
144	sub register {	641	sub register {
145	my ($base, $pkg) = @_;	642	my ($base, $pkg) = @_;
146		643
147	for my $idx (0 .. $#PLUGIN_EVENT) {	644	#TODO
148	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
149	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
150	$hook[$idx]{$base} = $ref;
151	}
152	}
153	}	645	}
154		646
155	sub load_extension {	647	sub load_extension {
156	my ($path) = @_;	648	my ($path) = @_;
157		649
158	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	650	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
159	my $base = $1;	651	my $base = $1;
160	my $pkg = $1;	652	my $pkg = $1;
161	$pkg =~ s/[^[:word:]]/_/g;	653	$pkg =~ s/[^[:word:]]/_/g;
162	$pkg = "cf::ext::$pkg";	654	$pkg = "ext::$pkg";
163		655
164	warn "loading '$path' into '$pkg'\n";	656	warn "loading '$path' into '$pkg'\n";
165		657
166	open my $fh, "<:utf8", $path	658	open my $fh, "<:utf8", $path
167	or die "$path: $!";	659	or die "$path: $!";
…		…
171	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
172	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
173	. "\n};\n1";	665	. "\n};\n1";
174		666
175	eval $source	667	eval $source
176	or die "$path: $@";	668	or die $@ ? "$path: $@\n"
		669	: "extension disabled.\n";
177		670
178	push @exts, $pkg;	671	push @exts, $pkg;
179	$ext_pkg{$base} = $pkg;	672	$ext_pkg{$base} = $pkg;
180		673
181	# no strict 'refs';	674	# no strict 'refs';
…		…
188	my ($pkg) = @_;	681	my ($pkg) = @_;
189		682
190	warn "removing extension $pkg\n";	683	warn "removing extension $pkg\n";
191		684
192	# remove hooks	685	# remove hooks
		686	#TODO
193	for my $idx (0 .. $#PLUGIN_EVENT) {	687	# for my $idx (0 .. $#PLUGIN_EVENT) {
194	delete $hook[$idx]{$pkg};	688	# delete $hook[$idx]{$pkg};
195	}	689	# }
196		690
197	# remove commands	691	# remove commands
198	for my $name (keys %command) {	692	for my $name (keys %COMMAND) {
199	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	693	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
200		694
201	if (@cb) {	695	if (@cb) {
202	$command{$name} = \@cb;	696	$COMMAND{$name} = \@cb;
203	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
204	} else {	697	} else {
205	delete $command{$name};
206	delete $COMMAND{"$name\000"};	698	delete $COMMAND{$name};
207	}	699	}
208	}	700	}
209		701
210	# remove extcmds	702	# remove extcmds
211	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	703	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
212	delete $extcmd{$name};	704	delete $EXTCMD{$name};
213	}	705	}
214		706
215	if (my $cb = $pkg->can ("on_unload")) {	707	if (my $cb = $pkg->can ("unload")) {
216	eval {	708	eval {
217	$cb->($pkg);	709	$cb->($pkg);
218	1	710	1
219	} or warn "$pkg unloaded, but with errors: $@";	711	} or warn "$pkg unloaded, but with errors: $@";
220	}	712	}
…		…
232	1	724	1
233	} or warn "$ext not loaded: $@";	725	} or warn "$ext not loaded: $@";
234	}	726	}
235	}	727	}
236		728
237	sub _perl_reload(&) {
238	my ($msg) = @_;
239
240	$msg->("reloading...");
241
242	eval {
243	# 1. cancel all watchers
244	$_->cancel for Event::all_watchers;
245
246	# 2. unload all extensions
247	for (@exts) {
248	$msg->("unloading <$_>");
249	unload_extension $_;
250	}
251
252	# 3. unload all modules loaded from $LIBDIR
253	while (my ($k, $v) = each %INC) {
254	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
255
256	$msg->("removing <$k>");
257	delete $INC{$k};
258
259	$k =~ s/\.pm$//;
260	$k =~ s/\//::/g;
261
262	if (my $cb = $k->can ("unload_module")) {
263	$cb->();
264	}
265
266	Symbol::delete_package $k;
267	}
268
269	# 4. get rid of ext::, as good as possible
270	Symbol::delete_package "ext::$_"
271	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
272
273	# 5. remove register_script_function callbacks
274	# TODO
275
276	# 6. unload cf.pm "a bit"
277	delete $INC{"cf.pm"};
278
279	# don't, removes xs symbols, too
280	#Symbol::delete_package __PACKAGE__;
281
282	# 7. reload cf.pm
283	$msg->("reloading cf.pm");
284	require cf;
285	};
286	$msg->($@) if $@;
287
288	$msg->("reloaded");
289	};
290
291	sub perl_reload() {
292	_perl_reload {
293	warn $_[0];
294	print "$_[0]\n";
295	};
296	}
297
298	register_command "perl-reload", 0, sub {
299	my ($who, $arg) = @_;
300
301	if ($who->flag (FLAG_WIZ)) {
302	_perl_reload {
303	warn $_[0];
304	$who->message ($_[0]);
305	};
306	}
307	};
308
309	#############################################################################
310	# utility functions
311
312	use JSON::Syck (); # TODO# replace by JSON::PC once working
313
314	sub from_json($) {
315	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
316	JSON::Syck::Load $_[0]
317	}
318
319	sub to_json($) {
320	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
321	JSON::Syck::Dump $_[0]
322	}
323
324	#############################################################################
325	# extcmd framework, basically convert ext <msg>
326	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
327
328	sub on_extcmd {
329	my ($pl, $buf) = @_;
330
331	my $msg = eval { from_json $buf };
332
333	if (ref $msg) {
334	if (my $cb = $extcmd{$msg->{msgtype}}) {
335	if (my %reply = $cb->[0]->($pl, $msg)) {
336	$pl->ext_reply ($msg->{msgid}, %reply);
337	}
338	}
339	} else {
340	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
341	}
342
343	1
344	}
345
346	#############################################################################	729	#############################################################################
347	# load/save/clean perl data associated with a map	730	# load/save/clean perl data associated with a map
348		731
349	*on_mapclean = sub {	732	*cf::mapsupport::on_clean = sub {
350	my ($map) = @_;	733	my ($map) = @_;
351		734
352	my $path = $map->tmpname;	735	my $path = $map->tmpname;
353	defined $path or return;	736	defined $path or return;
354		737
355	unlink "$path.cfperl";	738	unlink "$path.pst";
356	};	739	};
357		740
358	*on_mapin =	741	attach_to_maps prio => -10000, package => cf::mapsupport::;
359	*on_mapload = sub {
360	my ($map) = @_;
361
362	my $path = $map->tmpname;
363	$path = $map->path unless defined $path;
364
365	open my $fh, "<:raw", "$path.cfperl"
366	or return; # no perl data
367
368	my $data = Storable::thaw do { local $/; <$fh> };
369
370	$data->{version} <= 1
371	or return; # too new
372
373	$map->_set_obs ($data->{obs});
374	};
375
376	*on_mapout = sub {
377	my ($map) = @_;
378
379	my $path = $map->tmpname;
380	$path = $map->path unless defined $path;
381
382	my $obs = $map->_get_obs;
383
384	if (defined $obs) {
385	open my $fh, ">:raw", "$path.cfperl"
386	or die "$path.cfperl: $!";
387
388	stat $path;
389
390	print $fh Storable::nfreeze {
391	size => (stat _)[7],
392	time => (stat _)[9],
393	version => 1,
394	obs => $obs,
395	};
396
397	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
398	} else {
399	unlink "$path.cfperl";
400	}
401	};
402		742
403	#############################################################################	743	#############################################################################
404	# load/save perl data associated with player->ob objects	744	# load/save perl data associated with player->ob objects
405		745
406	sub all_objects(@) {	746	sub all_objects(@) {
407	@_, map all_objects ($_->inv), @_	747	@_, map all_objects ($_->inv), @_
408	}	748	}
409		749
410	*on_player_load = sub {	750	# TODO: compatibility cruft, remove when no longer needed
		751	attach_to_players
		752	on_load => sub {
411	my ($ob, $path) = @_;	753	my ($pl, $path) = @_;
412		754
413	for my $o (all_objects $ob) {	755	for my $o (all_objects $pl->ob) {
414	if (my $value = $o->get_ob_key_value ("_perl_data")) {	756	if (my $value = $o->get_ob_key_value ("_perl_data")) {
415	$o->set_ob_key_value ("_perl_data");	757	$o->set_ob_key_value ("_perl_data");
416		758
417	%$o = %{ Storable::thaw pack "H*", $value };	759	%$o = %{ Storable::thaw pack "H*", $value };
418	}	760	}
		761	}
419	}	762	},
420	};	763	;
421
422	*on_player_save = sub {
423	my ($ob, $path) = @_;
424
425	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
426	for grep %$_, all_objects $ob;
427	};
428		764
429	#############################################################################	765	#############################################################################
430	# core extensions - in perl	766
		767	=head2 CORE EXTENSIONS
		768
		769	Functions and methods that extend core crossfire objects.
		770
		771	=over 4
431		772
432	=item cf::player::exists $login	773	=item cf::player::exists $login
433		774
434	Returns true when the given account exists.	775	Returns true when the given account exists.
435		776
…		…
438	sub cf::player::exists($) {	779	sub cf::player::exists($) {
439	cf::player::find $_[0]	780	cf::player::find $_[0]
440	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	781	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
441	}	782	}
442		783
443	=item $player->reply ($npc, $msg[, $flags])	784	=item $player_object->reply ($npc, $msg[, $flags])
444		785
445	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	786	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
446	can be C<undef>. Does the right thing when the player is currently in a	787	can be C<undef>. Does the right thing when the player is currently in a
447	dialogue with the given NPC character.	788	dialogue with the given NPC character.
448		789
…		…
475	$msg{msgid} = $id;	816	$msg{msgid} = $id;
476		817
477	$self->send ("ext " . to_json \%msg);	818	$self->send ("ext " . to_json \%msg);
478	}	819	}
479		820
		821	=item $player_object->may ("access")
		822
		823	Returns wether the given player is authorized to access resource "access"
		824	(e.g. "command_wizcast").
		825
		826	=cut
		827
		828	sub cf::object::player::may {
		829	my ($self, $access) = @_;
		830
		831	$self->flag (cf::FLAG_WIZ) ||
		832	(ref $cf::CFG{"may_$access"}
		833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		834	: $cf::CFG{"may_$access"})
		835	}
		836
		837	=cut
		838
480	#############################################################################	839	#############################################################################
481	# map scripting support
482		840
		841	=head2 SAFE SCRIPTING
		842
		843	Functions that provide a safe environment to compile and execute
		844	snippets of perl code without them endangering the safety of the server
		845	itself. Looping constructs, I/O operators and other built-in functionality
		846	is not available in the safe scripting environment, and the number of
		847	functions and methods that can be called is greatly reduced.
		848
		849	=cut
		850
483	our $safe = new Safe "ext";	851	our $safe = new Safe "safe";
484	our $safe_hole = new Safe::Hole;	852	our $safe_hole = new Safe::Hole;
485		853
486	$SIG{FPE} = 'IGNORE';	854	$SIG{FPE} = 'IGNORE';
487		855
488	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	856	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
489		857
490	# here we export the classes and methods available to script code	858	# here we export the classes and methods available to script code
		859
		860	=pod
		861
		862	The following fucntions and emthods are available within a safe environment:
		863
		864	cf::object contr pay_amount pay_player
		865	cf::object::player player
		866	cf::player peaceful
		867
		868	=cut
491		869
492	for (	870	for (
493	["cf::object" => qw(contr pay_amount pay_player)],	871	["cf::object" => qw(contr pay_amount pay_player)],
494	["cf::object::player" => qw(player)],	872	["cf::object::player" => qw(player)],
495	["cf::player" => qw(peaceful)],	873	["cf::player" => qw(peaceful)],
496	) {	874	) {
497	no strict 'refs';	875	no strict 'refs';
498	my ($pkg, @funs) = @$_;	876	my ($pkg, @funs) = @$_;
499	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
500	for @funs;	878	for @funs;
501	}	879	}
		880
		881	=over 4
		882
		883	=item @retval = safe_eval $code, [var => value, ...]
		884
		885	Compiled and executes the given perl code snippet. additional var/value
		886	pairs result in temporary local (my) scalar variables of the given name
		887	that are available in the code snippet. Example:
		888
		889	my $five = safe_eval '$first + $second', first => 1, second => 4;
		890
		891	=cut
502		892
503	sub safe_eval($;@) {	893	sub safe_eval($;@) {
504	my ($code, %vars) = @_;	894	my ($code, %vars) = @_;
505		895
506	my $qcode = $code;	896	my $qcode = $code;
507	$qcode =~ s/"/‟/g; # not allowed in #line filenames	897	$qcode =~ s/"/‟/g; # not allowed in #line filenames
508	$qcode =~ s/\n/\\n/g;	898	$qcode =~ s/\n/\\n/g;
509		899
510	local $_;	900	local $_;
511	local @ext::cf::_safe_eval_args = values %vars;	901	local @safe::cf::_safe_eval_args = values %vars;
512		902
513	$code =	903	my $eval =
514	"do {\n"	904	"do {\n"
515	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"	905	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
516	. "#line 0 \"{$qcode}\"\n"	906	. "#line 0 \"{$qcode}\"\n"
517	. $code	907	. $code
518	. "\n}"	908	. "\n}"
519	;	909	;
520		910
521	sub_generation_inc;	911	sub_generation_inc;
522	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);	912	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
523	sub_generation_inc;	913	sub_generation_inc;
524		914
		915	if ($@) {
		916	warn "$@";
		917	warn "while executing safe code '$code'\n";
		918	warn "with arguments " . (join " ", %vars) . "\n";
		919	}
		920
525	wantarray ? @res : $res[0]	921	wantarray ? @res : $res[0]
526	}	922	}
		923
		924	=item cf::register_script_function $function => $cb
		925
		926	Register a function that can be called from within map/npc scripts. The
		927	function should be reasonably secure and should be put into a package name
		928	like the extension.
		929
		930	Example: register a function that gets called whenever a map script calls
		931	C<rent::overview>, as used by the C<rent> extension.
		932
		933	cf::register_script_function "rent::overview" => sub {
		934	...
		935	};
		936
		937	=cut
527		938
528	sub register_script_function {	939	sub register_script_function {
529	my ($fun, $cb) = @_;	940	my ($fun, $cb) = @_;
530		941
531	no strict 'refs';	942	no strict 'refs';
532	*{"ext::$fun"} = $safe_hole->wrap ($cb);	943	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		944	}
		945
		946	=back
		947
		948	=cut
		949
		950	#############################################################################
		951
		952	=head2 EXTENSION DATABASE SUPPORT
		953
		954	Crossfire maintains a very simple database for extension use. It can
		955	currently store anything that can be serialised using Storable, which
		956	excludes objects.
		957
		958	The parameter C<$family> should best start with the name of the extension
		959	using it, it should be unique.
		960
		961	=over 4
		962
		963	=item $hashref = cf::db_get $family
		964
		965	Return a hashref for use by the extension C<$family>, which can be
		966	modified. After modifications, you have to call C<cf::db_dirty> or
		967	C<cf::db_sync>.
		968
		969	=item $value = cf::db_get $family => $key
		970
		971	Returns a single value from the database
		972
		973	=item cf::db_put $family => $hashref
		974
		975	Stores the given family hashref into the database. Updates are delayed, if
		976	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		977
		978	=item cf::db_put $family => $key => $value
		979
		980	Stores the given C<$value> in the family hash. Updates are delayed, if you
		981	want the data to be synced to disk immediately, use C<cf::db_sync>.
		982
		983	=item cf::db_dirty
		984
		985	Marks the database as dirty, to be updated at a later time.
		986
		987	=item cf::db_sync
		988
		989	Immediately write the database to disk I<if it is dirty>.
		990
		991	=cut
		992
		993	our $DB;
		994
		995	{
		996	my $path = cf::localdir . "/database.pst";
		997
		998	sub db_load() {
		999	warn "loading database $path\n";#d# remove later
		1000	$DB = stat $path ? Storable::retrieve $path : { };
		1001	}
		1002
		1003	my $pid;
		1004
		1005	sub db_save() {
		1006	warn "saving database $path\n";#d# remove later
		1007	waitpid $pid, 0 if $pid;
		1008	if (0 == ($pid = fork)) {
		1009	$DB->{_meta}{version} = 1;
		1010	Storable::nstore $DB, "$path~";
		1011	rename "$path~", $path;
		1012	cf::_exit 0 if defined $pid;
		1013	}
		1014	}
		1015
		1016	my $dirty;
		1017
		1018	sub db_sync() {
		1019	db_save if $dirty;
		1020	undef $dirty;
		1021	}
		1022
		1023	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		1024	db_sync;
		1025	});
		1026
		1027	sub db_dirty() {
		1028	$dirty = 1;
		1029	$idle->start;
		1030	}
		1031
		1032	sub db_get($;$) {
		1033	@_ >= 2
		1034	? $DB->{$_[0]}{$_[1]}
		1035	: ($DB->{$_[0]} ||= { })
		1036	}
		1037
		1038	sub db_put($$;$) {
		1039	if (@_ >= 3) {
		1040	$DB->{$_[0]}{$_[1]} = $_[2];
		1041	} else {
		1042	$DB->{$_[0]} = $_[1];
		1043	}
		1044	db_dirty;
		1045	}
		1046
		1047	attach_global
		1048	prio => 10000,
		1049	on_cleanup => sub {
		1050	db_sync;
		1051	},
		1052	;
533	}	1053	}
534		1054
535	#############################################################################	1055	#############################################################################
536	# the server's main()	1056	# the server's main()
537		1057
538	sub run {	1058	sub cfg_load {
		1059	open my $fh, "<:utf8", cf::confdir . "/config"
		1060	or return;
		1061
		1062	local $/;
		1063	*CFG = YAML::Syck::Load <$fh>;
		1064	}
		1065
		1066	sub main {
		1067	cfg_load;
		1068	db_load;
		1069	load_extensions;
539	Event::loop;	1070	Event::loop;
540	}	1071	}
541		1072
542	#############################################################################	1073	#############################################################################
543	# initialisation	1074	# initialisation
544		1075
		1076	sub _perl_reload(&) {
		1077	my ($msg) = @_;
		1078
		1079	$msg->("reloading...");
		1080
		1081	eval {
		1082	# cancel all watchers
		1083	$_->cancel for Event::all_watchers;
		1084
		1085	# unload all extensions
		1086	for (@exts) {
		1087	$msg->("unloading <$_>");
		1088	unload_extension $_;
		1089	}
		1090
		1091	# unload all modules loaded from $LIBDIR
		1092	while (my ($k, $v) = each %INC) {
		1093	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1094
		1095	$msg->("removing <$k>");
		1096	delete $INC{$k};
		1097
		1098	$k =~ s/\.pm$//;
		1099	$k =~ s/\//::/g;
		1100
		1101	if (my $cb = $k->can ("unload_module")) {
		1102	$cb->();
		1103	}
		1104
		1105	Symbol::delete_package $k;
		1106	}
		1107
		1108	# sync database to disk
		1109	cf::db_sync;
		1110
		1111	# get rid of safe::, as good as possible
		1112	Symbol::delete_package "safe::$_"
		1113	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1114
		1115	# remove register_script_function callbacks
		1116	# TODO
		1117
		1118	# unload cf.pm "a bit"
		1119	delete $INC{"cf.pm"};
		1120
		1121	# don't, removes xs symbols, too,
		1122	# and global variables created in xs
		1123	#Symbol::delete_package __PACKAGE__;
		1124
		1125	# reload cf.pm
		1126	$msg->("reloading cf.pm");
		1127	require cf;
		1128
		1129	# load config and database again
		1130	cf::cfg_load;
		1131	cf::db_load;
		1132
		1133	# load extensions
		1134	$msg->("load extensions");
		1135	cf::load_extensions;
		1136
		1137	# reattach attachments to objects
		1138	$msg->("reattach");
		1139	_global_reattach;
		1140	};
		1141	$msg->($@) if $@;
		1142
		1143	$msg->("reloaded");
		1144	};
		1145
		1146	sub perl_reload() {
		1147	_perl_reload {
		1148	warn $_[0];
		1149	print "$_[0]\n";
		1150	};
		1151	}
		1152
545	register "<global>", __PACKAGE__;	1153	register "<global>", __PACKAGE__;
546		1154
		1155	register_command "perl-reload" => sub {
		1156	my ($who, $arg) = @_;
		1157
		1158	if ($who->flag (FLAG_WIZ)) {
		1159	_perl_reload {
		1160	warn $_[0];
		1161	$who->message ($_[0]);
		1162	};
		1163	}
		1164	};
		1165
547	unshift @INC, $LIBDIR;	1166	unshift @INC, $LIBDIR;
548		1167
549	load_extensions;
550
551	$TICK_WATCHER = Event->timer (	1168	$TICK_WATCHER = Event->timer (
552	prio => 1,	1169	prio => 1,
		1170	async => 1,
553	at => $NEXT_TICK || 1,	1171	at => $NEXT_TICK || 1,
554	cb => sub {	1172	cb => sub {
555	cf::server_tick; # one server iteration	1173	cf::server_tick; # one server iteration
556		1174
557	my $NOW = Event::time;	1175	my $NOW = Event::time;
558	$NEXT_TICK += $TICK;	1176	$NEXT_TICK += $TICK;
559		1177
560	# if we are delayed by four ticks, skip them all	1178	# if we are delayed by four ticks or more, skip them all
561	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1179	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
562		1180
563	$TICK_WATCHER->at ($NEXT_TICK);	1181	$TICK_WATCHER->at ($NEXT_TICK);
564	$TICK_WATCHER->start;	1182	$TICK_WATCHER->start;
565	},	1183	},
566	);	1184	);
567		1185
		1186	IO::AIO::max_poll_time $TICK * 0.2;
		1187
		1188	Event->io (fd => IO::AIO::poll_fileno,
		1189	poll => 'r',
		1190	prio => 5,
		1191	cb => \&IO::AIO::poll_cb);
		1192
568	1	1193	1
569		1194

Diff Legend

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