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.34 by root, Thu Aug 24 13:13:49 2006 UTC vs.
Revision 1.91 by elmex, Sun Dec 17 22:03:44 2006 UTC

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

Diff Legend

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