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

Diff Legend

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