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

Diff Legend

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