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.18 by root, Tue Jul 11 14:24:15 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC

1	package cf;	1	package cf;
2		2
3	use Symbol;	3	use Symbol;
4	use List::Util;	4	use List::Util;
5	use Storable;	5	use Storable;
		6	use Opcode;
		7	use Safe;
		8	use Safe::Hole;
		9
		10	use IO::AIO ();
		11	use YAML::Syck ();
		12	use Time::HiRes;
6	use Event;	13	use Event;
		14	$Event::Eval = 1; # no idea why this is required, but it is
		15
		16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		17	$YAML::Syck::ImplicitUnicode = 1;
7		18
8	use strict;	19	use strict;
9		20
10	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
11	our @EVENT;	29	our @EVENT;
12	our %PROP_TYPE;	30	our $LIBDIR = datadir . "/ext";
13	our %PROP_IDX;	31
		32	our $TICK = MAX_TIME * 1e-6;
		33	our $TICK_WATCHER;
		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
14		67
15	BEGIN {	68	BEGIN {
16	@EVENT = map lc, @EVENT;
17
18	*CORE::GLOBAL::warn = sub {	69	*CORE::GLOBAL::warn = sub {
19	my $msg = join "", @_;	70	my $msg = join "", @_;
20	$msg .= "\n"	71	$msg .= "\n"
21	unless $msg =~ /\n$/;	72	unless $msg =~ /\n$/;
22		73
23	print STDERR "cfperl: $msg";	74	print STDERR "cfperl: $msg";
24	LOG llevError, "cfperl: $msg";	75	LOG llevError, "cfperl: $msg";
25	};	76	};
26	}	77	}
27		78
28	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';
29		80
30	# generate property mutators	81	# we bless all objects into (empty) derived classes to force a method lookup
31	sub prop_gen {	82	# within the Safe compartment.
32	my ($prefix, $class) = @_;	83	for my $pkg (qw(
33		84	cf::object cf::object::player
		85	cf::client cf::player
		86	cf::arch cf::living
		87	cf::map cf::party cf::region
		88	)) {
34	no strict 'refs';	89	no strict 'refs';
35		90	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
36	for my $prop (keys %PROP_TYPE) {
37	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
38	my $sub = lc $1;
39
40	my $type = $PROP_TYPE{$prop};
41	my $idx = $PROP_IDX {$prop};
42
43	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
44	$_[0]->get_property ($type, $idx)
45	};
46
47	*{"$class\::set_$sub"} = sub {
48	$_[0]->set_property ($type, $idx, $_[1]);
49	} unless $ignore_set{$prop};
50	}
51	}	91	}
52
53	# auto-generate most of the API
54
55	prop_gen OBJECT_PROP => "cf::object";
56	# CFAPI_OBJECT_ANIMATION?
57	prop_gen PLAYER_PROP => "cf::object::player";
58
59	prop_gen MAP_PROP => "cf::map";
60	prop_gen ARCH_PROP => "cf::arch";
61
62	# guessed hierarchies
63
64	@cf::object::player::ISA = 'cf::object';
65	@cf::object::map::ISA = 'cf::object';
66		92
67	$Event::DIED = sub {	93	$Event::DIED = sub {
68	warn "error in event callback: @_";	94	warn "error in event callback: @_";
69	};	95	};
70		96
71	my %ext_pkg;	97	my %ext_pkg;
72	my @exts;	98	my @exts;
73	my @hook;	99	my @hook;
74	my %command;
75	my %extcmd;
76		100
77	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 client.
		158
		159	=item $client->attach ($attachment, key => $value...)
		160
		161	=item $client->detach ($attachment)
		162
		163	Attach/detach a pre-registered attachment to a map.
		164
		165	=item $bool = $object->attached ($name)
		166
		167	=item $bool = $player->attached ($name)
		168
		169	=item $bool = $client->attached ($name)
		170
		171	=item $bool = $map->attached ($name)
		172
		173	Checks wether the named attachment is currently attached to the object.
		174
		175	=item cf::attach_global ...
		176
		177	Attach handlers for global events.
		178
		179	This and all following C<attach_*>-functions expect any number of the
		180	following handler/hook descriptions:
		181
		182	=over 4
		183
		184	=item prio => $number
		185
		186	Set the priority for all following handlers/hooks (unless overwritten
		187	by another C<prio> setting). Lower priority handlers get executed
		188	earlier. The default priority is C<0>, and many built-in handlers are
		189	registered at priority C<-1000>, so lower priorities should not be used
		190	unless you know what you are doing.
		191
		192	=item on_I<event> => \&cb
		193
		194	Call the given code reference whenever the named event happens (event is
		195	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		196	handlers are recognised generally depends on the type of object these
		197	handlers attach to).
		198
		199	See F<include/eventinc.h> for the full list of events supported, and their
		200	class.
		201
		202	=item package => package::
		203
		204	Look for sub functions of the name C<< on_I<event> >> in the given
		205	package and register them. Only handlers for eevents supported by the
		206	object/class are recognised.
		207
		208	=back
		209
		210	=item cf::attach_to_type $object_type, $subtype, ...
		211
		212	Attach handlers for a specific object type (e.g. TRANSPORT) and
		213	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		214	type.
		215
		216	=item cf::attach_to_objects ...
		217
		218	Attach handlers to all objects. Do not use this except for debugging or
		219	very rare events, as handlers are (obviously) called for I<all> objects in
		220	the game.
		221
		222	=item cf::attach_to_players ...
		223
		224	Attach handlers to all players.
		225
		226	=item cf::attach_to_clients ...
		227
		228	Attach handlers to all players.
		229
		230	=item cf::attach_to_maps ...
		231
		232	Attach handlers to all maps.
		233
		234	=item cf:register_attachment $name, ...
		235
		236	Register an attachment by name through which objects can refer to this
		237	attachment.
		238
		239	=item cf:register_player_attachment $name, ...
		240
		241	Register an attachment by name through which players can refer to this
		242	attachment.
		243
		244	=item cf:register_map_attachment $name, ...
		245
		246	Register an attachment by name through which maps can refer to this
		247	attachment.
		248
		249	=cut
		250
		251	# the following variables are defined in .xs and must not be re-created
		252	our @CB_GLOBAL = (); # registry for all global events
		253	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		254	our @CB_PLAYER = ();
		255	our @CB_CLIENT = ();
		256	our @CB_TYPE = (); # registry for type (cf-object class) based events
		257	our @CB_MAP = ();
		258
		259	my %attachment;
		260
		261	sub _attach_cb($\%$$$) {
		262	my ($registry, $undo, $event, $prio, $cb) = @_;
		263
		264	use sort 'stable';
		265
		266	$cb = [$prio, $cb];
		267
		268	@{$registry->[$event]} = sort
		269	{ $a->[0] cmp $b->[0] }
		270	@{$registry->[$event] || []}, $cb;
		271
		272	push @{$undo->{cb}}, [$event, $cb];
		273	}
		274
		275	# attach handles attaching event callbacks
		276	# the only thing the caller has to do is pass the correct
		277	# registry (== where the callback attaches to).
		278	sub _attach(\@$@) {
		279	my ($registry, $klass, @arg) = @_;
		280
		281	my $prio = 0;
		282
		283	my %undo = (
		284	registry => $registry,
		285	cb => [],
		286	);
		287
		288	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		289
		290	while (@arg) {
		291	my $type = shift @arg;
		292
		293	if ($type eq "prio") {
		294	$prio = shift @arg;
		295
		296	} elsif ($type eq "package") {
		297	my $pkg = shift @arg;
		298
		299	while (my ($name, $id) = each %cb_id) {
		300	if (my $cb = $pkg->can ($name)) {
		301	_attach_cb $registry, %undo, $id, $prio, $cb;
		302	}
		303	}
		304
		305	} elsif (exists $cb_id{$type}) {
		306	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
		307
		308	} elsif (ref $type) {
		309	warn "attaching objects not supported, ignoring.\n";
		310
		311	} else {
		312	shift @arg;
		313	warn "attach argument '$type' not supported, ignoring.\n";
		314	}
		315	}
		316
		317	\%undo
		318	}
		319
		320	sub _attach_attachment {
		321	my ($obj, $name, %arg) = @_;
		322
		323	return if exists $obj->{_attachment}{$name};
		324
		325	my $res;
		326
		327	if (my $attach = $attachment{$name}) {
		328	my $registry = $obj->registry;
		329
		330	for (@$attach) {
		331	my ($klass, @attach) = @$_;
		332	$res = _attach @$registry, $klass, @attach;
		333	}
		334
		335	$obj->{$name} = \%arg;
		336	} else {
		337	warn "object uses attachment '$name' that is not available, postponing.\n";
		338	}
		339
		340	$obj->{_attachment}{$name} = undef;
		341
		342	$res->{attachment} = $name;
		343	$res
		344	}
		345
		346	*cf::object::attach =
		347	*cf::player::attach =
		348	*cf::client::attach =
		349	*cf::map::attach = sub {
		350	my ($obj, $name, %arg) = @_;
		351
		352	_attach_attachment $obj, $name, %arg;
		353	};
		354
		355	# all those should be optimised
		356	*cf::object::detach =
		357	*cf::player::detach =
		358	*cf::client::detach =
		359	*cf::map::detach = sub {
		360	my ($obj, $name) = @_;
		361
		362	delete $obj->{_attachment}{$name};
		363	reattach ($obj);
		364	};
		365
		366	*cf::object::attached =
		367	*cf::player::attached =
		368	*cf::client::attached =
		369	*cf::map::attached = sub {
		370	my ($obj, $name) = @_;
		371
		372	exists $obj->{_attachment}{$name}
		373	};
		374
		375	sub attach_global {
		376	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
		377	}
		378
		379	sub attach_to_type {
78	my $extension = shift;	380	my $type = shift;
79	my $event_code = shift;	381	my $subtype = shift;
80		382
81	my $cb = $hook[$event_code]{$extension}	383	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
82	or return;
83
84	&$cb
85	}	384	}
86		385
87	sub inject_global_event {	386	sub attach_to_objects {
		387	_attach @CB_OBJECT, KLASS_OBJECT, @_
		388	}
		389
		390	sub attach_to_players {
		391	_attach @CB_PLAYER, KLASS_PLAYER, @_
		392	}
		393
		394	sub attach_to_clients {
		395	_attach @CB_CLIENT, KLASS_CLIENT, @_
		396	}
		397
		398	sub attach_to_maps {
		399	_attach @CB_MAP, KLASS_MAP, @_
		400	}
		401
		402	sub register_attachment {
		403	my $name = shift;
		404
		405	$attachment{$name} = [[KLASS_OBJECT, @_]];
		406	}
		407
		408	sub register_player_attachment {
		409	my $name = shift;
		410
		411	$attachment{$name} = [[KLASS_PLAYER, @_]];
		412	}
		413
		414	sub register_client_attachment {
		415	my $name = shift;
		416
		417	$attachment{$name} = [[KLASS_CLIENT, @_]];
		418	}
		419
		420	sub register_map_attachment {
		421	my $name = shift;
		422
		423	$attachment{$name} = [[KLASS_MAP, @_]];
		424	}
		425
		426	our $override;
		427	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		428
		429	sub override {
		430	$override = 1;
		431	@invoke_results = ();
		432	}
		433
		434	sub do_invoke {
88	my $event = shift;	435	my $event = shift;
		436	my $callbacks = shift;
89		437
90	my $cb = $hook[$event]	438	@invoke_results = ();
91	or return;
92		439
93	List::Util::max map &$_, values %$cb	440	local $override;
94	}
95		441
96	sub inject_command {	442	for (@$callbacks) {
		443	eval { &{$_->[1]} };
		444
		445	if ($@) {
		446	warn "$@";
		447	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		448	override;
		449	}
		450
		451	return 1 if $override;
		452	}
		453
		454	0
		455	}
		456
		457	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		458
		459	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		460
		461	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		462
		463	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
		464
		465	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		466
		467	Generate a global/object/player/map-specific event with the given arguments.
		468
		469	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		470	removed in future versions), and there is no public API to access override
		471	results (if you must, access C<@cf::invoke_results> directly).
		472
		473	=back
		474
		475	=cut
		476
		477	#############################################################################
		478
		479	=head2 METHODS VALID FOR ALL CORE OBJECTS
		480
		481	=over 4
		482
		483	=item $object->valid, $player->valid, $client->valid, $map->valid
		484
		485	Just because you have a perl object does not mean that the corresponding
		486	C-level object still exists. If you try to access an object that has no
		487	valid C counterpart anymore you get an exception at runtime. This method
		488	can be used to test for existence of the C object part without causing an
		489	exception.
		490
		491	=back
		492
		493	=cut
		494
		495	*cf::object::valid =
		496	*cf::player::valid =
		497	*cf::client::valid =
		498	*cf::map::valid = \&cf::_valid;
		499
		500	#############################################################################
		501	# object support
		502
		503	sub instantiate {
		504	my ($obj, $data) = @_;
		505
		506	$data = from_json $data;
		507
		508	for (@$data) {
97	my ($name, $obj, $params) = @_;	509	my ($name, $args) = @$_;
98		510
99	for my $cmd (@{ $command{$name} }) {	511	$obj->attach ($name, %{$args || {} });
100	$cmd->[1]->($obj, $params);	512	}
		513	}
		514
		515	# basically do the same as instantiate, without calling instantiate
		516	sub reattach {
		517	my ($obj) = @_;
		518	my $registry = $obj->registry;
		519
		520	@$registry = ();
		521
		522	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
		523
		524	for my $name (keys %{ $obj->{_attachment} || {} }) {
		525	if (my $attach = $attachment{$name}) {
		526	for (@$attach) {
		527	my ($klass, @attach) = @$_;
		528	_attach @$registry, $klass, @attach;
		529	}
		530	} else {
		531	warn "object uses attachment '$name' that is not available, postponing.\n";
		532	}
		533	}
		534	}
		535
		536	sub object_freezer_save {
		537	my ($filename, $rdata, $objs) = @_;
		538
		539	if (length $$rdata) {
		540	warn sprintf "saving %s (%d,%d)\n",
		541	$filename, length $$rdata, scalar @$objs;
		542
		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;
		550	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		551	close $fh;
		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	}
		561	} else {
		562	unlink $filename;
		563	unlink "$filename.pst";
		564	}
		565	}
		566
		567	sub object_freezer_as_string {
		568	my ($rdata, $objs) = @_;
		569
		570	use Data::Dumper;
		571
		572	$$rdata . Dumper $objs
		573	}
		574
		575	sub object_thawer_load {
		576	my ($filename) = @_;
		577
		578	local $/;
		579
		580	my $av;
		581
		582	#TODO: use sysread etc.
		583	if (open my $data, "<:raw:perlio", $filename) {
		584	$data = <$data>;
		585	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		586	$av = eval { (Storable::thaw <$pst>)->{objs} };
		587	}
		588	return ($data, $av);
		589	}
		590
		591	()
		592	}
		593
		594	attach_to_objects
		595	prio => -1000000,
		596	on_clone => sub {
		597	my ($src, $dst) = @_;
		598
		599	@{$dst->registry} = @{$src->registry};
		600
		601	%$dst = %$src;
		602
		603	%{$dst->{_attachment}} = %{$src->{_attachment}}
		604	if exists $src->{_attachment};
101	}	605	},
		606	;
102		607
103	-1	608	#############################################################################
104	}	609	# command handling &c
		610
		611	=item cf::register_command $name => \&callback($ob,$args);
		612
		613	Register a callback for execution when the client sends the user command
		614	$name.
		615
		616	=cut
105		617
106	sub register_command {	618	sub register_command {
107	my ($name, $time, $cb) = @_;	619	my ($name, $cb) = @_;
108		620
109	my $caller = caller;	621	my $caller = caller;
110	#warn "registering command '$name/$time' to '$caller'";	622	#warn "registering command '$name/$time' to '$caller'";
111		623
112	push @{ $command{$name} }, [$time, $cb, $caller];	624	push @{ $COMMAND{$name} }, [$caller, $cb];
113	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
114	}	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
115		635
116	sub register_extcmd {	636	sub register_extcmd {
117	my ($name, $cb) = @_;	637	my ($name, $cb) = @_;
118		638
119	my $caller = caller;	639	my $caller = caller;
120	#warn "registering extcmd '$name' to '$caller'";	640	#warn "registering extcmd '$name' to '$caller'";
121		641
122	$extcmd{$name} = [$cb, $caller];	642	$EXTCMD{$name} = [$cb, $caller];
123	}	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	;
124		676
125	sub register {	677	sub register {
126	my ($base, $pkg) = @_;	678	my ($base, $pkg) = @_;
127		679
128	for my $idx (0 .. $#EVENT) {	680	#TODO
129	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
130	#warn "registering $EVENT[$idx] hook to '$pkg'\n";
131	$hook[$idx]{$base} = $ref;
132	}
133	}
134	}	681	}
135		682
136	sub load_extension {	683	sub load_extension {
137	my ($path) = @_;	684	my ($path) = @_;
138		685
139	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	686	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
140	my $base = $1;	687	my $base = $1;
141	my $pkg = $1;	688	my $pkg = $1;
142	$pkg =~ s/[^[:word:]]/_/g;	689	$pkg =~ s/[^[:word:]]/_/g;
143	$pkg = "cf::ext::$pkg";	690	$pkg = "ext::$pkg";
144		691
145	warn "loading '$path' into '$pkg'\n";	692	warn "loading '$path' into '$pkg'\n";
146		693
147	open my $fh, "<:utf8", $path	694	open my $fh, "<:utf8", $path
148	or die "$path: $!";	695	or die "$path: $!";
…		…
152	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
153	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
154	. "\n};\n1";	701	. "\n};\n1";
155		702
156	eval $source	703	eval $source
157	or die "$path: $@";	704	or die $@ ? "$path: $@\n"
		705	: "extension disabled.\n";
158		706
159	push @exts, $pkg;	707	push @exts, $pkg;
160	$ext_pkg{$base} = $pkg;	708	$ext_pkg{$base} = $pkg;
161		709
162	# no strict 'refs';	710	# no strict 'refs';
163	# @{"$pkg\::ISA"} = cf::ext::;	711	# @{"$pkg\::ISA"} = ext::;
164		712
165	register $base, $pkg;	713	register $base, $pkg;
166	}	714	}
167		715
168	sub unload_extension {	716	sub unload_extension {
169	my ($pkg) = @_;	717	my ($pkg) = @_;
170		718
171	warn "removing extension $pkg\n";	719	warn "removing extension $pkg\n";
172		720
173	# remove hooks	721	# remove hooks
		722	#TODO
174	for my $idx (0 .. $#EVENT) {	723	# for my $idx (0 .. $#PLUGIN_EVENT) {
175	delete $hook[$idx]{$pkg};	724	# delete $hook[$idx]{$pkg};
176	}	725	# }
177		726
178	# remove commands	727	# remove commands
179	for my $name (keys %command) {	728	for my $name (keys %COMMAND) {
180	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	729	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
181		730
182	if (@cb) {	731	if (@cb) {
183	$command{$name} = \@cb;	732	$COMMAND{$name} = \@cb;
184	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
185	} else {	733	} else {
186	delete $command{$name};
187	delete $COMMAND{"$name\000"};	734	delete $COMMAND{$name};
188	}	735	}
189	}	736	}
190		737
191	# remove extcmds	738	# remove extcmds
192	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	739	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
193	delete $extcmd{$name};	740	delete $EXTCMD{$name};
		741	}
		742
		743	if (my $cb = $pkg->can ("unload")) {
		744	eval {
		745	$cb->($pkg);
		746	1
		747	} or warn "$pkg unloaded, but with errors: $@";
194	}	748	}
195		749
196	Symbol::delete_package $pkg;	750	Symbol::delete_package $pkg;
197	}	751	}
198		752
199	sub load_extensions {	753	sub load_extensions {
200	my $LIBDIR = maps_directory "perl";
201
202	for my $ext (<$LIBDIR/*.ext>) {	754	for my $ext (<$LIBDIR/*.ext>) {
203	next unless -r $ext;	755	next unless -r $ext;
204	eval {	756	eval {
205	load_extension $ext;	757	load_extension $ext;
206	1	758	1
207	} or warn "$ext not loaded: $@";	759	} or warn "$ext not loaded: $@";
208	}	760	}
209	}	761	}
210		762
211	register_command "perl-reload", 0, sub {
212	my ($who, $arg) = @_;
213
214	if ($who->flag (FLAG_WIZ)) {
215	$who->message ("reloading...");
216
217	warn "reloading...\n";
218	eval {
219	unload_extension $_ for @exts;
220	delete $INC{"cf.pm"};
221
222	# don't, removes xs symbols, too
223	#Symbol::delete_package $pkg;
224
225	require cf;
226	};
227	warn $@ if $@;
228	$who->message ($@) if $@;
229	warn "reloaded\n";
230
231	$who->message ("reloaded");
232	} else {
233	$who->message ("Intruder Alert!");
234	}
235	};
236
237	#############################################################################
238	# extcmd framework, basically convert ext <id> <pkg> arg1 args
239	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
240
241	sub on_extcmd {
242	my ($pl, $buf) = @_;
243
244	my ($type) = $buf =~ s/^(\S+) // ? $1 : "";
245
246	$extcmd{$type}[0]->($pl, $buf)
247	if $extcmd{$type};
248	}
249
250	#############################################################################	763	#############################################################################
251	# load/save/clean perl data associated with a map	764	# load/save/clean perl data associated with a map
252		765
253	*on_mapclean = sub {	766	*cf::mapsupport::on_clean = sub {
254	my ($map) = @_;	767	my ($map) = @_;
255		768
256	my $path = $map->tmpname;	769	my $path = $map->tmpname;
257	defined $path or return;	770	defined $path or return;
258		771
259	unlink "$path.cfperl";	772	unlink "$path.pst";
260	};	773	};
261		774
262	*on_mapin =	775	attach_to_maps prio => -10000, package => cf::mapsupport::;
263	*on_mapload = sub {
264	my ($map) = @_;
265
266	my $path = $map->tmpname;
267	$path = $map->path unless defined $path;
268
269	open my $fh, "<:raw", "$path.cfperl"
270	or return; # no perl data
271
272	my $data = Storable::thaw do { local $/; <$fh> };
273
274	$data->{version} <= 1
275	or return; # too new
276
277	$map->_set_obs ($data->{obs});
278	};
279
280	*on_mapout = sub {
281	my ($map) = @_;
282
283	my $path = $map->tmpname;
284	$path = $map->path unless defined $path;
285
286	my $obs = $map->_get_obs;
287
288	if (defined $obs) {
289	open my $fh, ">:raw", "$path.cfperl"
290	or die "$path.cfperl: $!";
291
292	stat $path;
293
294	print $fh Storable::nfreeze {
295	size => (stat _)[7],
296	time => (stat _)[9],
297	version => 1,
298	obs => $obs,
299	};
300
301	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
302	} else {
303	unlink "$path.cfperl";
304	}
305	};
306		776
307	#############################################################################	777	#############################################################################
308	# load/save perl data associated with player->ob objects	778	# load/save perl data associated with player->ob objects
309		779
310	*on_player_load = sub {	780	sub all_objects(@) {
		781	@_, map all_objects ($_->inv), @_
		782	}
		783
		784	# TODO: compatibility cruft, remove when no longer needed
		785	attach_to_players
		786	on_load => sub {
311	my ($ob, $path) = @_;	787	my ($pl, $path) = @_;
312		788
313	if (open my $fh, "<:raw", "$path.cfperl") {	789	for my $o (all_objects $pl->ob) {
314
315	#d##TODO#remove
316
317	my $data = Storable::thaw do { local $/; <$fh> };
318
319	$data->{version} <= 1
320	or return; # too new
321
322	%$ob = %{$data->{ob}};
323	return;
324	}
325
326	for my $o ($ob, $ob->inv) {
327	if (my $value = $o->get_ob_key_value ("_perl_data")) {	790	if (my $value = $o->get_ob_key_value ("_perl_data")) {
328	$o->set_ob_key_value ("_perl_data");	791	$o->set_ob_key_value ("_perl_data");
329		792
330	%$o = %{ Storable::thaw pack "H*", $value };	793	%$o = %{ Storable::thaw pack "H*", $value };
		794	}
		795	}
		796	},
		797	;
		798
		799	#############################################################################
		800
		801	=head2 CORE EXTENSIONS
		802
		803	Functions and methods that extend core crossfire objects.
		804
		805	=over 4
		806
		807	=item cf::player::exists $login
		808
		809	Returns true when the given account exists.
		810
		811	=cut
		812
		813	sub cf::player::exists($) {
		814	cf::player::find $_[0]
		815	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
		816	}
		817
		818	=item $player_object->reply ($npc, $msg[, $flags])
		819
		820	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
		821	can be C<undef>. Does the right thing when the player is currently in a
		822	dialogue with the given NPC character.
		823
		824	=cut
		825
		826	# rough implementation of a future "reply" method that works
		827	# with dialog boxes.
		828	sub cf::object::player::reply($$$;$) {
		829	my ($self, $npc, $msg, $flags) = @_;
		830
		831	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
		832
		833	if ($self->{record_replies}) {
		834	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		835	} else {
		836	$msg = $npc->name . " says: $msg" if $npc;
		837	$self->message ($msg, $flags);
		838	}
		839	}
		840
		841	=item $player->ext_reply ($msgid, $msgtype, %msg)
		842
		843	Sends an ext reply to the player.
		844
		845	=cut
		846
		847	sub cf::player::ext_reply($$$%) {
		848	my ($self, $id, %msg) = @_;
		849
		850	$msg{msgid} = $id;
		851
		852	$self->send ("ext " . to_json \%msg);
		853	}
		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
		873	#############################################################################
		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
		884
		885	our $safe = new Safe "safe";
		886	our $safe_hole = new Safe::Hole;
		887
		888	$SIG{FPE} = 'IGNORE';
		889
		890	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
		891
		892	# here we export the classes and methods available to script code
		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
		905	for (
		906	["cf::object" => qw(contr pay_amount pay_player map)],
		907	["cf::object::player" => qw(player)],
		908	["cf::player" => qw(peaceful)],
		909	["cf::map" => qw(trigger)],
		910	) {
		911	no strict 'refs';
		912	my ($pkg, @funs) = @$_;
		913	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
		914	for @funs;
		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
		928
		929	sub safe_eval($;@) {
		930	my ($code, %vars) = @_;
		931
		932	my $qcode = $code;
		933	$qcode =~ s/"/‟/g; # not allowed in #line filenames
		934	$qcode =~ s/\n/\\n/g;
		935
		936	local $_;
		937	local @safe::cf::_safe_eval_args = values %vars;
		938
		939	my $eval =
		940	"do {\n"
		941	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
		942	. "#line 0 \"{$qcode}\"\n"
		943	. $code
		944	. "\n}"
		945	;
		946
		947	sub_generation_inc;
		948	my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
		949	sub_generation_inc;
		950
		951	if ($@) {
		952	warn "$@";
		953	warn "while executing safe code '$code'\n";
		954	warn "with arguments " . (join " ", %vars) . "\n";
		955	}
		956
		957	wantarray ? @res : $res[0]
		958	}
		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
		975	sub register_script_function {
		976	my ($fun, $cb) = @_;
		977
		978	no strict 'refs';
		979	*{"safe::$fun"} = $safe_hole->wrap ($cb);
		980	}
		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;
331	}	1087	},
		1088	;
		1089	}
		1090
		1091	#############################################################################
		1092	# the server's main()
		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
		1102	sub main {
		1103	cfg_load;
		1104	db_load;
		1105	load_extensions;
		1106	Event::loop;
		1107	}
		1108
		1109	#############################################################################
		1110	# initialisation
		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;
332	}	1178	};
		1179	$msg->($@) if $@;
		1180
		1181	$msg->("reloaded");
333	};	1182	};
334		1183
335	*on_player_save = sub {	1184	sub perl_reload() {
		1185	_perl_reload {
		1186	warn $_[0];
		1187	print "$_[0]\n";
		1188	};
		1189	}
		1190
		1191	register "<global>", __PACKAGE__;
		1192
		1193	register_command "perl-reload" => sub {
336	my ($ob, $path) = @_;	1194	my ($who, $arg) = @_;
337		1195
338	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)	1196	if ($who->flag (FLAG_WIZ)) {
339	for grep %$_, $ob, $ob->inv;	1197	_perl_reload {
340		1198	warn $_[0];
341	unlink "$path.cfperl";#d##TODO#remove	1199	$who->message ($_[0]);
		1200	};
		1201	}
342	};	1202	};
343		1203
344	register "<global>", __PACKAGE__;	1204	unshift @INC, $LIBDIR;
345		1205
346	unshift @INC, maps_directory "perl";	1206	$TICK_WATCHER = Event->timer (
		1207	prio => 0,
		1208	at => $NEXT_TICK || 1,
		1209	data => WF_AUTOCANCEL,
		1210	cb => sub {
		1211	cf::server_tick; # one server iteration
347		1212
348	load_extensions;	1213	my $NOW = Event::time;
		1214	$NEXT_TICK += $TICK;
		1215
		1216	# if we are delayed by four ticks or more, skip them all
		1217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
		1218
		1219	$TICK_WATCHER->at ($NEXT_TICK);
		1220	$TICK_WATCHER->start;
		1221	},
		1222	);
		1223
		1224	IO::AIO::max_poll_time $TICK * 0.2;
		1225
		1226	Event->io (fd => IO::AIO::poll_fileno,
		1227	poll => 'r',
		1228	prio => 5,
		1229	data => WF_AUTOCANCEL,
		1230	cb => \&IO::AIO::poll_cb);
349		1231
350	1	1232	1
351		1233

Diff Legend

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