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

Diff Legend

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