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.11 by root, Sun Mar 26 15:52:03 2006 UTC vs.
Revision 1.100 by root, Mon Dec 25 11:25:49 2006 UTC

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

Diff Legend

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