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

Diff Legend

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