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

Diff Legend

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