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.52 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.122 by root, Tue Jan 2 17:32:24 2007 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
16	_reload_1;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		34
18	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
19	our @EVENT;	39	our @EVENT;
20	our %PROP_TYPE;	40	our $LIBDIR = datadir . "/ext";
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";
23		41
24	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	43	our $TICK_WATCHER;
26	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	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		78
		79	#############################################################################
		80
		81	=head2 GLOBAL VARIABLES
		82
		83	=over 4
		84
		85	=item $cf::UPTIME
		86
		87	The timestamp of the server start (so not actually an uptime).
		88
		89	=item $cf::RUNTIME
		90
		91	The time this server has run, starts at 0 and is increased by $cf::TICK on
		92	every server tick.
		93
		94	=item $cf::LIBDIR
		95
		96	The perl library directory, where extensions and cf-specific modules can
		97	be found. It will be added to C<@INC> automatically.
		98
		99	=item $cf::NOW
		100
		101	The time of the last (current) server tick.
		102
		103	=item $cf::TICK
		104
		105	The interval between server ticks, in seconds.
		106
		107	=item %cf::CFG
		108
		109	Configuration for the server, loaded from C</etc/crossfire/config>, or
		110	from wherever your confdir points to.
		111
		112	=back
		113
		114	=cut
27		115
28	BEGIN {	116	BEGIN {
29	*CORE::GLOBAL::warn = sub {	117	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	118	my $msg = join "", @_;
		119	utf8::encode $msg;
		120
31	$msg .= "\n"	121	$msg .= "\n"
32	unless $msg =~ /\n$/;	122	unless $msg =~ /\n$/;
33		123
34	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	124	LOG llevError, "cfperl: $msg";
36	};	125	};
37	}	126	}
38		127
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!	128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40		129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41	# generate property mutators	130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42	sub prop_gen {	131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43	my ($prefix, $class) = @_;	132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	*{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		134
75	# we bless all objects into (empty) derived classes to force a method lookup	135	# we bless all objects into (empty) derived classes to force a method lookup
76	# within the Safe compartment.	136	# within the Safe compartment.
77	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	137	for my $pkg (qw(
		138	cf::global cf::attachable
		139	cf::object cf::object::player
		140	cf::client cf::player
		141	cf::arch cf::living
		142	cf::map cf::party cf::region
		143	)) {
78	no strict 'refs';	144	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	146	}
81		147
82	$Event::DIED = sub {	148	$Event::DIED = sub {
…		…
84	};	150	};
85		151
86	my %ext_pkg;	152	my %ext_pkg;
87	my @exts;	153	my @exts;
88	my @hook;	154	my @hook;
89	my %command;
90	my %extcmd;
91		155
92	#############################################################################	156	=head2 UTILITY FUNCTIONS
93	# utility functions	157
		158	=over 4
		159
		160	=cut
94		161
95	use JSON::Syck (); # TODO# replace by JSON::PC once working	162	use JSON::Syck (); # TODO# replace by JSON::PC once working
		163
		164	=item $ref = cf::from_json $json
		165
		166	Converts a JSON string into the corresponding perl data structure.
		167
		168	=cut
96		169
97	sub from_json($) {	170	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	171	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	172	JSON::Syck::Load $_[0]
100	}	173	}
101		174
		175	=item $json = cf::to_json $ref
		176
		177	Converts a perl data structure into its JSON representation.
		178
		179	=cut
		180
102	sub to_json($) {	181	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
105	}	184	}
106		185
		186	=item my $guard = cf::guard { BLOCK }
		187
		188	Run the given callback when the guard object gets destroyed (useful for
		189	coroutine cancellations).
		190
		191	You can call C<< ->cancel >> on the guard object to stop the block from
		192	being executed.
		193
		194	=cut
		195
		196	sub guard(&) {
		197	bless \(my $cb = $_[0]), cf::guard::;
		198	}
		199
		200	sub cf::guard::cancel {
		201	${$_[0]} = sub { };
		202	}
		203
		204	sub cf::guard::DESTROY {
		205	${$_[0]}->();
		206	}
		207
		208	=item cf::lock_wait $string
		209
		210	Wait until the given lock is available. See cf::lock_acquire.
		211
		212	=item my $lock = cf::lock_acquire $string
		213
		214	Wait until the given lock is available and then acquires it and returns
		215	a guard object. If the guard object gets destroyed (goes out of scope,
		216	for example when the coroutine gets canceled), the lock is automatically
		217	returned.
		218
		219	Lock names should begin with a unique identifier (for example, find_map
		220	uses map_find and load_map uses map_load).
		221
		222	=cut
		223
		224	our %LOCK;
		225
		226	sub lock_wait($) {
		227	my ($key) = @_;
		228
		229	# wait for lock, if any
		230	while ($LOCK{$key}) {
		231	push @{ $LOCK{$key} }, $Coro::current;
		232	Coro::schedule;
		233	}
		234	}
		235
		236	sub lock_acquire($) {
		237	my ($key) = @_;
		238
		239	# wait, to be sure we are not locked
		240	lock_wait $key;
		241
		242	$LOCK{$key} = [];
		243
		244	cf::guard {
		245	# wake up all waiters, to be on the safe side
		246	$_->ready for @{ delete $LOCK{$key} };
		247	}
		248	}
		249
		250	=item cf::sync_job { BLOCK }
		251
		252	The design of crossfire+ requires that the main coro ($Coro::main) is
		253	always able to handle events or runnable, as crossfire+ is only partly
		254	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		255
		256	If it must be done, put the blocking parts into C<sync_job>. This will run
		257	the given BLOCK in another coroutine while waiting for the result. The
		258	server will be frozen during this time, so the block should either finish
		259	fast or be very important.
		260
		261	=cut
		262
		263	sub sync_job(&) {
		264	my ($job) = @_;
		265
		266	if ($Coro::current == $Coro::main) {
		267	# this is the main coro, too bad, we have to block
		268	# till the operation succeeds, freezing the server :/
		269
		270	# TODO: use suspend/resume instead
		271	# (but this is cancel-safe)
		272	local $FREEZE = 1;
		273
		274	my $busy = 1;
		275	my @res;
		276
		277	(Coro::async {
		278	@res = eval { $job->() };
		279	warn $@ if $@;
		280	undef $busy;
		281	})->prio (Coro::PRIO_MAX);
		282
		283	while ($busy) {
		284	Coro::cede_notself;
		285	Event::one_event unless Coro::nready;
		286	}
		287
		288	wantarray ? @res : $res[0]
		289	} else {
		290	# we are in another coroutine, how wonderful, everything just works
		291
		292	$job->()
		293	}
		294	}
		295
		296	=item $coro = cf::coro { BLOCK }
		297
		298	Creates and returns a new coro. This coro is automcatially being canceled
		299	when the extension calling this is being unloaded.
		300
		301	=cut
		302
		303	sub coro(&) {
		304	my $cb = shift;
		305
		306	my $coro; $coro = async {
		307	eval {
		308	$cb->();
		309	};
		310	warn $@ if $@;
		311	};
		312
		313	$coro->on_destroy (sub {
		314	delete $EXT_CORO{$coro+0};
		315	});
		316	$EXT_CORO{$coro+0} = $coro;
		317
		318	$coro
		319	}
		320
		321	sub write_runtime {
		322	my $runtime = cf::localdir . "/runtime";
		323
		324	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		325	or return;
		326
		327	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		328	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		329	and return;
		330
		331	aio_fsync $fh
		332	and return;
		333
		334	close $fh
		335	or return;
		336
		337	aio_rename "$runtime~", $runtime
		338	and return;
		339
		340	1
		341	}
		342
		343	=back
		344
		345	=cut
		346
107	#############################################################################	347	#############################################################################
108	# "new" plug-in system
109		348
		349	package cf::path;
		350
		351	sub new {
		352	my ($class, $path, $base) = @_;
		353
		354	$path = $path->as_string if ref $path;
		355
		356	my $self = bless { }, $class;
		357
		358	# {... are special paths that are not touched
		359	# ?xxx/... are special absolute paths
		360	# ?random/... random maps
		361	# /! non-realised random map exit
		362	# /... normal maps
		363	# ~/... per-player maps without a specific player (DO NOT USE)
		364	# ~user/... per-player map of a specific user
		365
		366	if ($path =~ /^{/) {
		367	# fine as it is
		368	} elsif ($path =~ s{^\?random/}{}) {
		369	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		370	$self->{random} = cf::from_json $data;
		371	} else {
		372	if ($path =~ s{^~([^/]+)?}{}) {
		373	$self->{user_rel} = 1;
		374
		375	if (defined $1) {
		376	$self->{user} = $1;
		377	} elsif ($base =~ m{^~([^/]+)/}) {
		378	$self->{user} = $1;
		379	} else {
		380	warn "cannot resolve user-relative path without user <$path,$base>\n";
		381	}
		382	} elsif ($path =~ /^\//) {
		383	# already absolute
		384	} else {
		385	$base =~ s{[^/]+/?$}{};
		386	return $class->new ("$base/$path");
		387	}
		388
		389	for ($path) {
		390	redo if s{/\.?/}{/};
		391	redo if s{/[^/]+/\.\./}{/};
		392	}
		393	}
		394
		395	$self->{path} = $path;
		396
		397	$self
		398	}
		399
		400	# the name / primary key / in-game path
		401	sub as_string {
		402	my ($self) = @_;
		403
		404	$self->{user_rel} ? "~$self->{user}$self->{path}"
		405	: $self->{random} ? "?random/$self->{path}"
		406	: $self->{path}
		407	}
		408
		409	# the displayed name, this is a one way mapping
		410	sub visible_name {
		411	my ($self) = @_;
		412
		413	# if (my $rmp = $self->{random}) {
		414	# # todo: be more intelligent about this
		415	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		416	# } else {
		417	$self->as_string
		418	# }
		419	}
		420
		421	# escape the /'s in the path
		422	sub _escaped_path {
		423	# ∕ is U+2215
		424	(my $path = $_[0]{path}) =~ s/\//∕/g;
		425	$path
		426	}
		427
		428	# the original (read-only) location
		429	sub load_path {
		430	my ($self) = @_;
		431
		432	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		433	}
		434
		435	# the temporary/swap location
		436	sub save_path {
		437	my ($self) = @_;
		438
		439	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		440	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		441	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		442	}
		443
		444	# the unique path, might be eq to save_path
		445	sub uniq_path {
		446	my ($self) = @_;
		447
		448	$self->{user_rel} || $self->{random}
		449	? undef
		450	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		451	}
		452
		453	# return random map parameters, or undef
		454	sub random_map_params {
		455	my ($self) = @_;
		456
		457	$self->{random}
		458	}
		459
		460	# this is somewhat ugly, but style maps do need special treatment
		461	sub is_style_map {
		462	$_[0]{path} =~ m{^/styles/}
		463	}
		464
		465	package cf;
		466
		467	#############################################################################
		468
		469	=head2 ATTACHABLE OBJECTS
		470
		471	Many objects in crossfire are so-called attachable objects. That means you can
		472	attach callbacks/event handlers (a collection of which is called an "attachment")
		473	to it. All such attachable objects support the following methods.
		474
		475	In the following description, CLASS can be any of C<global>, C<object>
		476	C<player>, C<client> or C<map> (i.e. the attachable objects in
		477	crossfire+).
		478
		479	=over 4
		480
110	=item $object->attach ($attachment, key => $value...)	481	=item $attachable->attach ($attachment, key => $value...)
111		482
112	Attach a pre-registered attachment to an object.	483	=item $attachable->detach ($attachment)
113		484
114	=item $player->attach ($attachment, key => $value...)	485	Attach/detach a pre-registered attachment to a specific object and give it
		486	the specified key/value pairs as arguments.
115		487
116	Attach a pre-registered attachment to a player.	488	Example, attach a minesweeper attachment to the given object, making it a
		489	10x10 minesweeper game:
117		490
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	491	$obj->attach (minesweeper => width => 10, height => 10);
119		492
120	Attach a pre-registered attachment to a map.	493	=item $bool = $attachable->attached ($name)
121		494
122	=item cf::attach_global ...	495	Checks wether the named attachment is currently attached to the object.
123		496
124	Attach handlers for global events.	497	=item cf::CLASS->attach ...
125		498
126	This and all following C<attach_*>-functions expect any number of the	499	=item cf::CLASS->detach ...
127	following handler/hook descriptions:	500
		501	Define an anonymous attachment and attach it to all objects of the given
		502	CLASS. See the next function for an explanation of its arguments.
		503
		504	You can attach to global events by using the C<cf::global> class.
		505
		506	Example, log all player logins:
		507
		508	cf::player->attach (
		509	on_login => sub {
		510	my ($pl) = @_;
		511	...
		512	},
		513	);
		514
		515	Example, attach to the jeweler skill:
		516
		517	cf::object->attach (
		518	type => cf::SKILL,
		519	subtype => cf::SK_JEWELER,
		520	on_use_skill => sub {
		521	my ($sk, $ob, $part, $dir, $msg) = @_;
		522	...
		523	},
		524	);
		525
		526	=item cf::CLASS::attachment $name, ...
		527
		528	Register an attachment by C<$name> through which attachable objects of the
		529	given CLASS can refer to this attachment.
		530
		531	Some classes such as crossfire maps and objects can specify attachments
		532	that are attached at load/instantiate time, thus the need for a name.
		533
		534	These calls expect any number of the following handler/hook descriptions:
128		535
129	=over 4	536	=over 4
130		537
131	=item prio => $number	538	=item prio => $number
132		539
…		…
134	by another C<prio> setting). Lower priority handlers get executed	541	by another C<prio> setting). Lower priority handlers get executed
135	earlier. The default priority is C<0>, and many built-in handlers are	542	earlier. The default priority is C<0>, and many built-in handlers are
136	registered at priority C<-1000>, so lower priorities should not be used	543	registered at priority C<-1000>, so lower priorities should not be used
137	unless you know what you are doing.	544	unless you know what you are doing.
138		545
		546	=item type => $type
		547
		548	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		549	given type of objects only (the additional parameter C<subtype> can be
		550	used to further limit to the given subtype).
		551
139	=item on_I<event> => \&cb	552	=item on_I<event> => \&cb
140		553
141	Call the given code reference whenever the named event happens (event is	554	Call the given code reference whenever the named event happens (event is
142	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	555	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
143	handlers are recognised generally depends on the type of object these	556	handlers are recognised generally depends on the type of object these
…		…
152	package and register them. Only handlers for eevents supported by the	565	package and register them. Only handlers for eevents supported by the
153	object/class are recognised.	566	object/class are recognised.
154		567
155	=back	568	=back
156		569
157	=item cf::attach_to_type $object_type, $subtype, ...	570	Example, define an attachment called "sockpuppet" that calls the given
		571	event handler when a monster attacks:
158		572
159	Attach handlers for a specific object type (e.g. TRANSPORT) and	573	cf::object::attachment sockpuppet =>
160	subtype. If C<$subtype> is zero or undef, matches all objects of the given	574	on_skill_attack => sub {
161	type.	575	my ($self, $victim) = @_;
		576	...
		577	}
		578	}
162		579
163	=item cf::attach_to_objects ...	580	=item $attachable->valid
164		581
165	Attach handlers to all objects. Do not use this except for debugging or	582	Just because you have a perl object does not mean that the corresponding
166	very rare events, as handlers are (obviously) called for I<all> objects in	583	C-level object still exists. If you try to access an object that has no
167	the game.	584	valid C counterpart anymore you get an exception at runtime. This method
168		585	can be used to test for existence of the C object part without causing an
169	=item cf::attach_to_players ...	586	exception.
170
171	Attach handlers to all players.
172
173	=item cf::attach_to_maps ...
174
175	Attach handlers to all maps.
176
177	=item cf:register_attachment $name, ...
178
179	Register an attachment by name through which objects can refer to this
180	attachment.
181
182	=item cf:register_map_attachment $name, ...
183
184	Register an attachment by name through which maps can refer to this
185	attachment.
186		587
187	=cut	588	=cut
188		589
189	# the following variables are defined in .xs and must not be re-created	590	# the following variables are defined in .xs and must not be re-created
190	our @CB_GLOBAL = (); # registry for all global events	591	our @CB_GLOBAL = (); # registry for all global events
		592	our @CB_ATTACHABLE = (); # registry for all attachables
191	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	593	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
192	our @CB_PLAYER = ();	594	our @CB_PLAYER = ();
		595	our @CB_CLIENT = ();
193	our @CB_TYPE = (); # registry for type (cf-object class) based events	596	our @CB_TYPE = (); # registry for type (cf-object class) based events
194	our @CB_MAP = ();	597	our @CB_MAP = ();
195		598
196	my %attachment;	599	my %attachment;
197		600
198	sub _attach_cb($\%$$$) {	601	sub _attach_cb($$$$) {
199	my ($registry, $undo, $event, $prio, $cb) = @_;	602	my ($registry, $event, $prio, $cb) = @_;
200		603
201	use sort 'stable';	604	use sort 'stable';
202		605
203	$cb = [$prio, $cb];	606	$cb = [$prio, $cb];
204		607
205	@{$registry->[$event]} = sort	608	@{$registry->[$event]} = sort
206	{ $a->[0] cmp $b->[0] }	609	{ $a->[0] cmp $b->[0] }
207	@{$registry->[$event] || []}, $cb;	610	@{$registry->[$event] || []}, $cb;
208
209	push @{$undo->{cb}}, [$event, $cb];
210	}	611	}
		612
		613	# hack
		614	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
211		615
212	# attach handles attaching event callbacks	616	# attach handles attaching event callbacks
213	# the only thing the caller has to do is pass the correct	617	# the only thing the caller has to do is pass the correct
214	# registry (== where the callback attaches to).	618	# registry (== where the callback attaches to).
215	sub _attach(\@$@) {	619	sub _attach {
216	my ($registry, $klass, @arg) = @_;	620	my ($registry, $klass, @arg) = @_;
217		621
		622	my $object_type;
218	my $prio = 0;	623	my $prio = 0;
219
220	my %undo = (
221	registry => $registry,
222	cb => [],
223	);
224
225	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	624	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		625
		626	#TODO: get rid of this hack
		627	if ($attachable_klass{$klass}) {
		628	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		629	}
226		630
227	while (@arg) {	631	while (@arg) {
228	my $type = shift @arg;	632	my $type = shift @arg;
229		633
230	if ($type eq "prio") {	634	if ($type eq "prio") {
231	$prio = shift @arg;	635	$prio = shift @arg;
232		636
		637	} elsif ($type eq "type") {
		638	$object_type = shift @arg;
		639	$registry = $CB_TYPE[$object_type] ||= [];
		640
		641	} elsif ($type eq "subtype") {
		642	defined $object_type or Carp::croak "subtype specified without type";
		643	my $object_subtype = shift @arg;
		644	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		645
233	} elsif ($type eq "package") {	646	} elsif ($type eq "package") {
234	my $pkg = shift @arg;	647	my $pkg = shift @arg;
235		648
236	while (my ($name, $id) = each %cb_id) {	649	while (my ($name, $id) = each %cb_id) {
237	if (my $cb = $pkg->can ($name)) {	650	if (my $cb = $pkg->can ($name)) {
238	_attach_cb $registry, %undo, $id, $prio, $cb;	651	_attach_cb $registry, $id, $prio, $cb;
239	}	652	}
240	}	653	}
241		654
242	} elsif (exists $cb_id{$type}) {	655	} elsif (exists $cb_id{$type}) {
243	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	656	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
244		657
245	} elsif (ref $type) {	658	} elsif (ref $type) {
246	warn "attaching objects not supported, ignoring.\n";	659	warn "attaching objects not supported, ignoring.\n";
247		660
248	} else {	661	} else {
249	shift @arg;	662	shift @arg;
250	warn "attach argument '$type' not supported, ignoring.\n";	663	warn "attach argument '$type' not supported, ignoring.\n";
251	}	664	}
252	}	665	}
253
254	\%undo
255	}	666	}
256		667
257	sub _attach_attachment {	668	sub _object_attach {
258	my ($obj, $name, %arg) = @_;	669	my ($obj, $name, %arg) = @_;
259		670
260	my $res;	671	return if exists $obj->{_attachment}{$name};
261		672
262	if (my $attach = $attachment{$name}) {	673	if (my $attach = $attachment{$name}) {
263	my $registry = $obj->registry;	674	my $registry = $obj->registry;
264		675
265	for (@$attach) {	676	for (@$attach) {
266	my ($klass, @attach) = @$_;	677	my ($klass, @attach) = @$_;
267	$res = _attach @$registry, $klass, @attach;	678	_attach $registry, $klass, @attach;
268	}	679	}
269		680
270	$obj->{$name} = \%arg;	681	$obj->{$name} = \%arg;
271	} else {	682	} else {
272	warn "object uses attachment '$name' that is not available, postponing.\n";	683	warn "object uses attachment '$name' that is not available, postponing.\n";
273	}	684	}
274		685
275	$obj->{_attachment}{$name} = undef;	686	$obj->{_attachment}{$name} = undef;
276
277	$res->{attachment} = $name;
278	$res
279	}	687	}
280		688
281	sub cf::object::attach {	689	sub cf::attachable::attach {
		690	if (ref $_[0]) {
		691	_object_attach @_;
		692	} else {
		693	_attach shift->_attach_registry, @_;
		694	}
		695	};
		696
		697	# all those should be optimised
		698	sub cf::attachable::detach {
282	my ($obj, $name, %arg) = @_;	699	my ($obj, $name) = @_;
283		700
284	_attach_attachment $obj, $name, %arg;	701	if (ref $obj) {
285	}	702	delete $obj->{_attachment}{$name};
		703	reattach ($obj);
		704	} else {
		705	Carp::croak "cannot, currently, detach class attachments";
		706	}
		707	};
286		708
287	sub cf::player::attach {	709	sub cf::attachable::attached {
288	my ($obj, $name, %arg) = @_;	710	my ($obj, $name) = @_;
289		711
290	_attach_attachment $obj, $name, %arg;	712	exists $obj->{_attachment}{$name}
291	}	713	}
292		714
293	sub cf::map::attach {	715	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
294	my ($obj, $name, %arg) = @_;	716	eval "#line " . __LINE__ . " 'cf.pm'
		717	sub cf::\L$klass\E::_attach_registry {
		718	(\\\@CB_$klass, KLASS_$klass)
		719	}
295		720
296	_attach_attachment $obj, $name, %arg;	721	sub cf::\L$klass\E::attachment {
297	}
298
299	sub attach_global {
300	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
301	}
302
303	sub attach_to_type {
304	my $type = shift;
305	my $subtype = shift;
306
307	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
308	}
309
310	sub attach_to_objects {
311	_attach @CB_OBJECT, KLASS_OBJECT, @_
312	}
313
314	sub attach_to_players {
315	_attach @CB_PLAYER, KLASS_PLAYER, @_
316	}
317
318	sub attach_to_maps {
319	_attach @CB_MAP, KLASS_MAP, @_
320	}
321
322	sub register_attachment {
323	my $name = shift;	722	my \$name = shift;
324		723
325	$attachment{$name} = [[KLASS_OBJECT, @_]];
326	}
327
328	sub register_map_attachment {
329	my $name = shift;
330
331	$attachment{$name} = [[KLASS_MAP, @_]];	724	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		725	}
		726	";
		727	die if $@;
332	}	728	}
333		729
334	our $override;	730	our $override;
335	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	731	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
336		732
…		…
350	for (@$callbacks) {	746	for (@$callbacks) {
351	eval { &{$_->[1]} };	747	eval { &{$_->[1]} };
352		748
353	if ($@) {	749	if ($@) {
354	warn "$@";	750	warn "$@";
355	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	751	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
356	override;	752	override;
357	}	753	}
358		754
359	return 1 if $override;	755	return 1 if $override;
360	}	756	}
361		757
362	0	758	0
363	}	759	}
		760
		761	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		762
		763	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		764
		765	Generate an object-specific event with the given arguments.
		766
		767	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		768	removed in future versions), and there is no public API to access override
		769	results (if you must, access C<@cf::invoke_results> directly).
		770
		771	=back
		772
		773	=cut
364		774
365	#############################################################################	775	#############################################################################
366	# object support	776	# object support
367		777
368	sub instantiate {
369	my ($obj, $data) = @_;
370
371	$data = from_json $data;
372
373	for (@$data) {
374	my ($name, $args) = @$_;
375
376	$obj->attach ($name, %{$args || {} });
377	}
378	}
379
380	# basically do the same as instantiate, without calling instantiate
381	sub reattach {	778	sub reattach {
		779	# basically do the same as instantiate, without calling instantiate
382	my ($obj) = @_;	780	my ($obj) = @_;
		781
383	my $registry = $obj->registry;	782	my $registry = $obj->registry;
384		783
385	@$registry = ();	784	@$registry = ();
386		785
387	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	786	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
388		787
389	for my $name (keys %{ $obj->{_attachment} || {} }) {	788	for my $name (keys %{ $obj->{_attachment} || {} }) {
390	if (my $attach = $attachment{$name}) {	789	if (my $attach = $attachment{$name}) {
391	for (@$attach) {	790	for (@$attach) {
392	my ($klass, @attach) = @$_;	791	my ($klass, @attach) = @$_;
393	_attach @$registry, $klass, @attach;	792	_attach $registry, $klass, @attach;
394	}	793	}
395	} else {	794	} else {
396	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' that is not available, postponing.\n";
397	}	796	}
398	}	797	}
399	}	798	}
400		799
401	sub object_freezer_save {	800	cf::attachable->attach (
402	my ($filename, $objs) = @_;
403
404	if (@$objs) {
405	open my $fh, ">:raw", "$filename.pst~";
406	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
407	close $fh;
408	chmod SAVE_MODE, "$filename.pst~";
409	rename "$filename.pst~", "$filename.pst";
410	} else {
411	unlink "$filename.pst";
412	}
413
414	chmod SAVE_MODE, "$filename~";
415	rename "$filename~", $filename;
416	}
417
418	sub object_thawer_load {
419	my ($filename) = @_;
420
421	open my $fh, "<:raw:perlio", "$filename.pst"
422	or return;
423
424	eval { local $/; (Storable::thaw <$fh>)->{objs} }
425	}
426
427	attach_to_objects
428	prio => -1000000,	801	prio => -1000000,
		802	on_instantiate => sub {
		803	my ($obj, $data) = @_;
		804
		805	$data = from_json $data;
		806
		807	for (@$data) {
		808	my ($name, $args) = @$_;
		809
		810	$obj->attach ($name, %{$args || {} });
		811	}
		812	},
		813	on_reattach => \&reattach,
429	on_clone => sub {	814	on_clone => sub {
430	my ($src, $dst) = @_;	815	my ($src, $dst) = @_;
431		816
432	@{$dst->registry} = @{$src->registry};	817	@{$dst->registry} = @{$src->registry};
433		818
434	%$dst = %$src;	819	%$dst = %$src;
435		820
436	%{$dst->{_attachment}} = %{$src->{_attachment}}	821	%{$dst->{_attachment}} = %{$src->{_attachment}}
437	if exists $src->{_attachment};	822	if exists $src->{_attachment};
438	},	823	},
439	;	824	);
		825
		826	sub object_freezer_save {
		827	my ($filename, $rdata, $objs) = @_;
		828
		829	sync_job {
		830	if (length $$rdata) {
		831	warn sprintf "saving %s (%d,%d)\n",
		832	$filename, length $$rdata, scalar @$objs;
		833
		834	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		835	chmod SAVE_MODE, $fh;
		836	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		837	aio_fsync $fh;
		838	close $fh;
		839
		840	if (@$objs) {
		841	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		842	chmod SAVE_MODE, $fh;
		843	my $data = Storable::nfreeze { version => 1, objs => $objs };
		844	aio_write $fh, 0, (length $data), $data, 0;
		845	aio_fsync $fh;
		846	close $fh;
		847	aio_rename "$filename.pst~", "$filename.pst";
		848	}
		849	} else {
		850	aio_unlink "$filename.pst";
		851	}
		852
		853	aio_rename "$filename~", $filename;
		854	} else {
		855	warn "FATAL: $filename~: $!\n";
		856	}
		857	} else {
		858	aio_unlink $filename;
		859	aio_unlink "$filename.pst";
		860	}
		861	}
		862	}
		863
		864	sub object_freezer_as_string {
		865	my ($rdata, $objs) = @_;
		866
		867	use Data::Dumper;
		868
		869	$$rdata . Dumper $objs
		870	}
		871
		872	sub object_thawer_load {
		873	my ($filename) = @_;
		874
		875	my ($data, $av);
		876
		877	(aio_load $filename, $data) >= 0
		878	or return;
		879
		880	unless (aio_stat "$filename.pst") {
		881	(aio_load "$filename.pst", $av) >= 0
		882	or return;
		883	$av = eval { (Storable::thaw $av)->{objs} };
		884	}
		885
		886	warn sprintf "loading %s (%d)\n",
		887	$filename, length $data, scalar @{$av || []};#d#
		888	return ($data, $av);
		889	}
440		890
441	#############################################################################	891	#############################################################################
442	# old plug-in events	892	# command handling &c
443		893
444	sub inject_event {	894	=item cf::register_command $name => \&callback($ob,$args);
445	my $extension = shift;
446	my $event_code = shift;
447		895
448	my $cb = $hook[$event_code]{$extension}	896	Register a callback for execution when the client sends the user command
449	or return;	897	$name.
450		898
451	&$cb	899	=cut
452	}
453
454	sub inject_global_event {
455	my $event = shift;
456
457	my $cb = $hook[$event]
458	or return;
459
460	List::Util::max map &$_, values %$cb
461	}
462
463	sub inject_command {
464	my ($name, $obj, $params) = @_;
465
466	for my $cmd (@{ $command{$name} }) {
467	$cmd->[1]->($obj, $params);
468	}
469
470	-1
471	}
472		900
473	sub register_command {	901	sub register_command {
474	my ($name, $time, $cb) = @_;	902	my ($name, $cb) = @_;
475		903
476	my $caller = caller;	904	my $caller = caller;
477	#warn "registering command '$name/$time' to '$caller'";	905	#warn "registering command '$name/$time' to '$caller'";
478		906
479	push @{ $command{$name} }, [$time, $cb, $caller];	907	push @{ $COMMAND{$name} }, [$caller, $cb];
480	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
481	}	908	}
		909
		910	=item cf::register_extcmd $name => \&callback($pl,$packet);
		911
		912	Register a callbackf ro execution when the client sends an extcmd packet.
		913
		914	If the callback returns something, it is sent back as if reply was being
		915	called.
		916
		917	=cut
482		918
483	sub register_extcmd {	919	sub register_extcmd {
484	my ($name, $cb) = @_;	920	my ($name, $cb) = @_;
485		921
486	my $caller = caller;	922	my $caller = caller;
487	#warn "registering extcmd '$name' to '$caller'";	923	#warn "registering extcmd '$name' to '$caller'";
488		924
489	$extcmd{$name} = [$cb, $caller];	925	$EXTCMD{$name} = [$cb, $caller];
490	}	926	}
		927
		928	cf::player->attach (
		929	on_command => sub {
		930	my ($pl, $name, $params) = @_;
		931
		932	my $cb = $COMMAND{$name}
		933	or return;
		934
		935	for my $cmd (@$cb) {
		936	$cmd->[1]->($pl->ob, $params);
		937	}
		938
		939	cf::override;
		940	},
		941	on_extcmd => sub {
		942	my ($pl, $buf) = @_;
		943
		944	my $msg = eval { from_json $buf };
		945
		946	if (ref $msg) {
		947	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		948	if (my %reply = $cb->[0]->($pl, $msg)) {
		949	$pl->ext_reply ($msg->{msgid}, %reply);
		950	}
		951	}
		952	} else {
		953	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		954	}
		955
		956	cf::override;
		957	},
		958	);
491		959
492	sub register {	960	sub register {
493	my ($base, $pkg) = @_;	961	my ($base, $pkg) = @_;
494		962
495	#TODO	963	#TODO
…		…
514	. "#line 1 \"$path\"\n{\n"	982	. "#line 1 \"$path\"\n{\n"
515	. (do { local $/; <$fh> })	983	. (do { local $/; <$fh> })
516	. "\n};\n1";	984	. "\n};\n1";
517		985
518	eval $source	986	eval $source
519	or die "$path: $@";	987	or die $@ ? "$path: $@\n"
		988	: "extension disabled.\n";
520		989
521	push @exts, $pkg;	990	push @exts, $pkg;
522	$ext_pkg{$base} = $pkg;	991	$ext_pkg{$base} = $pkg;
523		992
524	# no strict 'refs';	993	# no strict 'refs';
…		…
537	# for my $idx (0 .. $#PLUGIN_EVENT) {	1006	# for my $idx (0 .. $#PLUGIN_EVENT) {
538	# delete $hook[$idx]{$pkg};	1007	# delete $hook[$idx]{$pkg};
539	# }	1008	# }
540		1009
541	# remove commands	1010	# remove commands
542	for my $name (keys %command) {	1011	for my $name (keys %COMMAND) {
543	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1012	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
544		1013
545	if (@cb) {	1014	if (@cb) {
546	$command{$name} = \@cb;	1015	$COMMAND{$name} = \@cb;
547	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
548	} else {	1016	} else {
549	delete $command{$name};
550	delete $COMMAND{"$name\000"};	1017	delete $COMMAND{$name};
551	}	1018	}
552	}	1019	}
553		1020
554	# remove extcmds	1021	# remove extcmds
555	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1022	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
556	delete $extcmd{$name};	1023	delete $EXTCMD{$name};
557	}	1024	}
558		1025
559	if (my $cb = $pkg->can ("unload")) {	1026	if (my $cb = $pkg->can ("unload")) {
560	eval {	1027	eval {
561	$cb->($pkg);	1028	$cb->($pkg);
…		…
565		1032
566	Symbol::delete_package $pkg;	1033	Symbol::delete_package $pkg;
567	}	1034	}
568		1035
569	sub load_extensions {	1036	sub load_extensions {
570	my $LIBDIR = maps_directory "perl";
571
572	for my $ext (<$LIBDIR/*.ext>) {	1037	for my $ext (<$LIBDIR/*.ext>) {
573	next unless -r $ext;	1038	next unless -r $ext;
574	eval {	1039	eval {
575	load_extension $ext;	1040	load_extension $ext;
576	1	1041	1
577	} or warn "$ext not loaded: $@";	1042	} or warn "$ext not loaded: $@";
578	}	1043	}
579	}	1044	}
580		1045
581	sub _perl_reload(&) {
582	my ($msg) = @_;
583
584	$msg->("reloading...");
585
586	eval {
587	# 1. cancel all watchers
588	$_->cancel for Event::all_watchers;
589
590	# 2. unload all extensions
591	for (@exts) {
592	$msg->("unloading <$_>");
593	unload_extension $_;
594	}
595
596	# 3. unload all modules loaded from $LIBDIR
597	while (my ($k, $v) = each %INC) {
598	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
599
600	$msg->("removing <$k>");
601	delete $INC{$k};
602
603	$k =~ s/\.pm$//;
604	$k =~ s/\//::/g;
605
606	if (my $cb = $k->can ("unload_module")) {
607	$cb->();
608	}
609
610	Symbol::delete_package $k;
611	}
612
613	# 4. get rid of safe::, as good as possible
614	Symbol::delete_package "safe::$_"
615	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
616
617	# 5. remove register_script_function callbacks
618	# TODO
619
620	# 6. unload cf.pm "a bit"
621	delete $INC{"cf.pm"};
622
623	# don't, removes xs symbols, too,
624	# and global variables created in xs
625	#Symbol::delete_package __PACKAGE__;
626
627	# 7. reload cf.pm
628	$msg->("reloading cf.pm");
629	require cf;
630	};
631	$msg->($@) if $@;
632
633	$msg->("reloaded");
634	};
635
636	sub perl_reload() {
637	_perl_reload {
638	warn $_[0];
639	print "$_[0]\n";
640	};
641	}
642
643	register_command "perl-reload", 0, sub {
644	my ($who, $arg) = @_;
645
646	if ($who->flag (FLAG_WIZ)) {
647	_perl_reload {
648	warn $_[0];
649	$who->message ($_[0]);
650	};
651	}
652	};
653
654	#############################################################################
655	# extcmd framework, basically convert ext <msg>
656	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
657
658	attach_to_players
659	on_extcmd => sub {
660	my ($pl, $buf) = @_;
661
662	my $msg = eval { from_json $buf };
663
664	if (ref $msg) {
665	if (my $cb = $extcmd{$msg->{msgtype}}) {
666	if (my %reply = $cb->[0]->($pl, $msg)) {
667	$pl->ext_reply ($msg->{msgid}, %reply);
668	}
669	}
670	} else {
671	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
672	}
673
674	cf::override;
675	},
676	;
677
678	#############################################################################	1046	#############################################################################
679	# load/save/clean perl data associated with a map	1047	# load/save/clean perl data associated with a map
680		1048
681	*cf::mapsupport::on_clean = sub {	1049	*cf::mapsupport::on_clean = sub {
682	my ($map) = @_;	1050	my ($map) = @_;
…		…
685	defined $path or return;	1053	defined $path or return;
686		1054
687	unlink "$path.pst";	1055	unlink "$path.pst";
688	};	1056	};
689		1057
690	# old style persistent data, TODO: remove #d#
691	*cf::mapsupport::on_swapin =
692	*cf::mapsupport::on_load = sub {
693	my ($map) = @_;
694
695	my $path = $map->tmpname;
696	$path = $map->path unless defined $path;
697
698	open my $fh, "<:raw", "$path.cfperl"
699	or return; # no perl data
700
701	my $data = Storable::thaw do { local $/; <$fh> };
702
703	$data->{version} <= 1
704	or return; # too new
705
706	$map->_set_obs ($data->{obs});
707	$map->invoke (EVENT_MAP_UPGRADE);
708	};
709
710	attach_to_maps prio => -10000, package => cf::mapsupport::;	1058	cf::map->attach (prio => -10000, package => cf::mapsupport::);
711		1059
712	#############################################################################	1060	#############################################################################
713	# load/save perl data associated with player->ob objects	1061	# load/save perl data associated with player->ob objects
714		1062
715	sub all_objects(@) {	1063	sub all_objects(@) {
716	@_, map all_objects ($_->inv), @_	1064	@_, map all_objects ($_->inv), @_
717	}	1065	}
718		1066
719	attach_to_players	1067	# TODO: compatibility cruft, remove when no longer needed
		1068	cf::player->attach (
720	on_load => sub {	1069	on_load => sub {
721	my ($pl, $path) = @_;	1070	my ($pl, $path) = @_;
722		1071
723	for my $o (all_objects $pl->ob) {	1072	for my $o (all_objects $pl->ob) {
724	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1073	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
726		1075
727	%$o = %{ Storable::thaw pack "H*", $value };	1076	%$o = %{ Storable::thaw pack "H*", $value };
728	}	1077	}
729	}	1078	}
730	},	1079	},
731	;	1080	);
732		1081
733	#############################################################################	1082	#############################################################################
734	# core extensions - in perl	1083
		1084	=head2 CORE EXTENSIONS
		1085
		1086	Functions and methods that extend core crossfire objects.
		1087
		1088	=head3 cf::player
		1089
		1090	=over 4
735		1091
736	=item cf::player::exists $login	1092	=item cf::player::exists $login
737		1093
738	Returns true when the given account exists.	1094	Returns true when the given account exists.
739		1095
…		…
742	sub cf::player::exists($) {	1098	sub cf::player::exists($) {
743	cf::player::find $_[0]	1099	cf::player::find $_[0]
744	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1100	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
745	}	1101	}
746		1102
		1103	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1104
		1105	Sends an ext reply to the player.
		1106
		1107	=cut
		1108
		1109	sub cf::player::ext_reply($$$%) {
		1110	my ($self, $id, %msg) = @_;
		1111
		1112	$msg{msgid} = $id;
		1113
		1114	$self->send ("ext " . to_json \%msg);
		1115	}
		1116
		1117	=back
		1118
		1119
		1120	=head3 cf::map
		1121
		1122	=over 4
		1123
		1124	=cut
		1125
		1126	package cf::map;
		1127
		1128	use Fcntl;
		1129	use Coro::AIO;
		1130
		1131	our $MAX_RESET = 7200;
		1132	our $DEFAULT_RESET = 3600;
		1133
		1134	sub generate_random_map {
		1135	my ($path, $rmp) = @_;
		1136
		1137	# mit "rum" bekleckern, nicht
		1138	cf::map::_create_random_map
		1139	$path,
		1140	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1141	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1142	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1143	$rmp->{exit_on_final_map},
		1144	$rmp->{xsize}, $rmp->{ysize},
		1145	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1146	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1147	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1148	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1149	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1150	(cf::region::find $rmp->{region})
		1151	}
		1152
		1153	# and all this just because we cannot iterate over
		1154	# all maps in C++...
		1155	sub change_all_map_light {
		1156	my ($change) = @_;
		1157
		1158	$_->change_map_light ($change)
		1159	for grep $_->outdoor, values %cf::MAP;
		1160	}
		1161
		1162	sub try_load_header($) {
		1163	my ($path) = @_;
		1164
		1165	utf8::encode $path;
		1166	aio_open $path, O_RDONLY, 0
		1167	or return;
		1168
		1169	my $map = cf::map::new
		1170	or return;
		1171
		1172	$map->load_header ($path)
		1173	or return;
		1174
		1175	$map->{load_path} = $path;
		1176
		1177	$map
		1178	}
		1179
		1180	sub find_map {
		1181	my ($path, $origin) = @_;
		1182
		1183	#warn "find_map<$path,$origin>\n";#d#
		1184
		1185	$path = new cf::path $path, $origin && $origin->path;
		1186	my $key = $path->as_string;
		1187
		1188	cf::lock_wait "map_find:$key";
		1189
		1190	$cf::MAP{$key} || do {
		1191	my $guard = cf::lock_acquire "map_find:$key";
		1192
		1193	# do it the slow way
		1194	my $map = try_load_header $path->save_path;
		1195
		1196	if ($map) {
		1197	# safety
		1198	$map->{instantiate_time} = $cf::RUNTIME
		1199	if $map->{instantiate_time} > $cf::RUNTIME;
		1200	} else {
		1201	if (my $rmp = $path->random_map_params) {
		1202	$map = generate_random_map $key, $rmp;
		1203	} else {
		1204	$map = try_load_header $path->load_path;
		1205	}
		1206
		1207	$map or return;
		1208
		1209	$map->{load_original} = 1;
		1210	$map->{instantiate_time} = $cf::RUNTIME;
		1211	$map->instantiate;
		1212
		1213	# per-player maps become, after loading, normal maps
		1214	$map->per_player (0) if $path->{user_rel};
		1215	}
		1216
		1217	$map->path ($key);
		1218	$map->{path} = $path;
		1219	$map->{last_save} = $cf::RUNTIME;
		1220	$map->last_access ($cf::RUNTIME);
		1221
		1222	if ($map->should_reset) {
		1223	$map->reset;
		1224	$map = find_map $path;
		1225	}
		1226
		1227	$cf::MAP{$key} = $map
		1228	}
		1229	}
		1230
		1231	sub load {
		1232	my ($self) = @_;
		1233
		1234	my $path = $self->{path};
		1235	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1236
		1237	return if $self->in_memory != cf::MAP_SWAPPED;
		1238
		1239	$self->in_memory (cf::MAP_LOADING);
		1240
		1241	$self->alloc;
		1242	$self->load_objects ($self->{load_path}, 1)
		1243	or return;
		1244
		1245	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1246	if delete $self->{load_original};
		1247
		1248	if (my $uniq = $path->uniq_path) {
		1249	utf8::encode $uniq;
		1250	if (aio_open $uniq, O_RDONLY, 0) {
		1251	$self->clear_unique_items;
		1252	$self->load_objects ($uniq, 0);
		1253	}
		1254	}
		1255
		1256	# now do the right thing for maps
		1257	$self->link_multipart_objects;
		1258
		1259	if ($self->{path}->is_style_map) {
		1260	$self->{deny_save} = 1;
		1261	$self->{deny_reset} = 1;
		1262	} else {
		1263	$self->fix_auto_apply;
		1264	$self->decay_objects;
		1265	$self->update_buttons;
		1266	$self->set_darkness_map;
		1267	$self->difficulty ($self->estimate_difficulty)
		1268	unless $self->difficulty;
		1269	$self->activate;
		1270	}
		1271
		1272	$self->in_memory (cf::MAP_IN_MEMORY);
		1273	}
		1274
		1275	sub load_map_sync {
		1276	my ($path, $origin) = @_;
		1277
		1278	#warn "load_map_sync<$path, $origin>\n";#d#
		1279
		1280	cf::sync_job {
		1281	my $map = cf::map::find_map $path, $origin
		1282	or return;
		1283	$map->load;
		1284	$map
		1285	}
		1286	}
		1287
		1288	sub save {
		1289	my ($self) = @_;
		1290
		1291	$self->{last_save} = $cf::RUNTIME;
		1292
		1293	return unless $self->dirty;
		1294
		1295	my $save = $self->{path}->save_path; utf8::encode $save;
		1296	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1297
		1298	$self->{load_path} = $save;
		1299
		1300	return if $self->{deny_save};
		1301
		1302	if ($uniq) {
		1303	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1304	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1305	} else {
		1306	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1307	}
		1308	}
		1309
		1310	sub swap_out {
		1311	my ($self) = @_;
		1312
		1313	return if $self->players;
		1314	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1315	return if $self->{deny_save};
		1316
		1317	$self->save;
		1318	$self->clear;
		1319	$self->in_memory (cf::MAP_SWAPPED);
		1320	}
		1321
		1322	sub reset_at {
		1323	my ($self) = @_;
		1324
		1325	# TODO: safety, remove and allow resettable per-player maps
		1326	return 1e99 if $self->{path}{user_rel};
		1327	return 1e99 if $self->{deny_reset};
		1328
		1329	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1330	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1331
		1332	$time + $to
		1333	}
		1334
		1335	sub should_reset {
		1336	my ($self) = @_;
		1337
		1338	$self->reset_at <= $cf::RUNTIME
		1339	}
		1340
		1341	sub unlink_save {
		1342	my ($self) = @_;
		1343
		1344	utf8::encode (my $save = $self->{path}->save_path);
		1345	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1346	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1347	}
		1348
		1349	sub rename {
		1350	my ($self, $new_path) = @_;
		1351
		1352	$self->unlink_save;
		1353
		1354	delete $cf::MAP{$self->path};
		1355	$self->{path} = new cf::path $new_path;
		1356	$self->path ($self->{path}->as_string);
		1357	$cf::MAP{$self->path} = $self;
		1358
		1359	$self->save;
		1360	}
		1361
		1362	sub reset {
		1363	my ($self) = @_;
		1364
		1365	return if $self->players;
		1366	return if $self->{path}{user_rel};#d#
		1367
		1368	warn "resetting map ", $self->path;#d#
		1369
		1370	delete $cf::MAP{$self->path};
		1371
		1372	$_->clear_links_to ($self) for values %cf::MAP;
		1373
		1374	$self->unlink_save;
		1375	$self->destroy;
		1376	}
		1377
		1378	my $nuke_counter = "aaaa";
		1379
		1380	sub nuke {
		1381	my ($self) = @_;
		1382
		1383	$self->{deny_save} = 1;
		1384	$self->reset_timeout (1);
		1385	$self->rename ("{nuke}/" . ($nuke_counter++));
		1386	$self->reset; # polite request, might not happen
		1387	}
		1388
		1389	sub customise_for {
		1390	my ($map, $ob) = @_;
		1391
		1392	if ($map->per_player) {
		1393	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1394	}
		1395
		1396	$map
		1397	}
		1398
		1399	sub emergency_save {
		1400	local $cf::FREEZE = 1;
		1401
		1402	warn "enter emergency map save\n";
		1403
		1404	cf::sync_job {
		1405	warn "begin emergency map save\n";
		1406	$_->save for values %cf::MAP;
		1407	};
		1408
		1409	warn "end emergency map save\n";
		1410	}
		1411
		1412	package cf;
		1413
		1414	=back
		1415
		1416
		1417	=head3 cf::object::player
		1418
		1419	=over 4
		1420
747	=item $player->reply ($npc, $msg[, $flags])	1421	=item $player_object->reply ($npc, $msg[, $flags])
748		1422
749	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1423	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
750	can be C<undef>. Does the right thing when the player is currently in a	1424	can be C<undef>. Does the right thing when the player is currently in a
751	dialogue with the given NPC character.	1425	dialogue with the given NPC character.
752		1426
753	=cut	1427	=cut
754		1428
755	# rough implementation of a future "reply" method that works	1429	# rough implementation of a future "reply" method that works
756	# with dialog boxes.	1430	# with dialog boxes.
		1431	#TODO: the first argument must go, split into a $npc->reply_to ( method
757	sub cf::object::player::reply($$$;$) {	1432	sub cf::object::player::reply($$$;$) {
758	my ($self, $npc, $msg, $flags) = @_;	1433	my ($self, $npc, $msg, $flags) = @_;
759		1434
760	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1435	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
761		1436
…		…
765	$msg = $npc->name . " says: $msg" if $npc;	1440	$msg = $npc->name . " says: $msg" if $npc;
766	$self->message ($msg, $flags);	1441	$self->message ($msg, $flags);
767	}	1442	}
768	}	1443	}
769		1444
770	=item $player->ext_reply ($msgid, $msgtype, %msg)	1445	=item $player_object->may ("access")
771		1446
772	Sends an ext reply to the player.	1447	Returns wether the given player is authorized to access resource "access"
		1448	(e.g. "command_wizcast").
773		1449
774	=cut	1450	=cut
775		1451
776	sub cf::player::ext_reply($$$%) {	1452	sub cf::object::player::may {
		1453	my ($self, $access) = @_;
		1454
		1455	$self->flag (cf::FLAG_WIZ) ||
		1456	(ref $cf::CFG{"may_$access"}
		1457	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1458	: $cf::CFG{"may_$access"})
		1459	}
		1460
		1461	=item $player_object->enter_link
		1462
		1463	Freezes the player and moves him/her to a special map (C<{link}>).
		1464
		1465	The player should be reaosnably safe there for short amounts of time. You
		1466	I<MUST> call C<leave_link> as soon as possible, though.
		1467
		1468	=item $player_object->leave_link ($map, $x, $y)
		1469
		1470	Moves the player out of the specila link map onto the given map. If the
		1471	map is not valid (or omitted), the player will be moved back to the
		1472	location he/she was before the call to C<enter_link>, or, if that fails,
		1473	to the emergency map position.
		1474
		1475	Might block.
		1476
		1477	=cut
		1478
		1479	sub cf::object::player::enter_link {
		1480	my ($self) = @_;
		1481
		1482	$self->deactivate_recursive;
		1483
		1484	return if $self->map == $LINK_MAP;
		1485
		1486	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1487	if $self->map;
		1488
		1489	$self->enter_map ($LINK_MAP, 20, 20);
		1490	}
		1491
		1492	sub cf::object::player::leave_link {
		1493	my ($self, $map, $x, $y) = @_;
		1494
		1495	my $link_pos = delete $self->{_link_pos};
		1496
		1497	unless ($map) {
		1498	# restore original map position
		1499	($map, $x, $y) = @{ $link_pos || [] };
		1500	$map = cf::map::find_map $map;
		1501
		1502	unless ($map) {
		1503	($map, $x, $y) = @$EMERGENCY_POSITION;
		1504	$map = cf::map::find_map $map
		1505	or die "FATAL: cannot load emergency map\n";
		1506	}
		1507	}
		1508
		1509	($x, $y) = (-1, -1)
		1510	unless (defined $x) && (defined $y);
		1511
		1512	# use -1 or undef as default coordinates, not 0, 0
		1513	($x, $y) = ($map->enter_x, $map->enter_y)
		1514	if $x <=0 && $y <= 0;
		1515
		1516	$map->load;
		1517
		1518	$self->activate_recursive;
		1519	$self->enter_map ($map, $x, $y);
		1520	}
		1521
		1522	cf::player->attach (
		1523	on_logout => sub {
		1524	my ($pl) = @_;
		1525
		1526	# abort map switching before logout
		1527	if ($pl->ob->{_link_pos}) {
		1528	cf::sync_job {
		1529	$pl->ob->leave_link
		1530	};
		1531	}
		1532	},
		1533	on_login => sub {
		1534	my ($pl) = @_;
		1535
		1536	# try to abort aborted map switching on player login :)
		1537	# should happen only on crashes
		1538	if ($pl->ob->{_link_pos}) {
		1539	$pl->ob->enter_link;
		1540	Coro::async {
		1541	# we need this sleep as the login has a concurrent enter_exit running
		1542	# and this sleep increases chances of the player not ending up in scorn
		1543	Coro::Timer::sleep 1;
		1544	$pl->ob->leave_link;
		1545	};
		1546	}
		1547	},
		1548	);
		1549
		1550	=item $player_object->goto_map ($path, $x, $y)
		1551
		1552	=cut
		1553
		1554	sub cf::object::player::goto_map {
		1555	my ($self, $path, $x, $y) = @_;
		1556
		1557	$self->enter_link;
		1558
		1559	(Coro::async {
		1560	$path = new cf::path $path;
		1561
		1562	my $map = cf::map::find_map $path->as_string;
		1563	$map = $map->customise_for ($self) if $map;
		1564
		1565	# warn "entering ", $map->path, " at ($x, $y)\n"
		1566	# if $map;
		1567
		1568	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1569
		1570	$self->leave_link ($map, $x, $y);
		1571	})->prio (1);
		1572	}
		1573
		1574	=item $player_object->enter_exit ($exit_object)
		1575
		1576	=cut
		1577
		1578	sub parse_random_map_params {
		1579	my ($spec) = @_;
		1580
		1581	my $rmp = { # defaults
		1582	xsize => 10,
		1583	ysize => 10,
		1584	};
		1585
		1586	for (split /\n/, $spec) {
		1587	my ($k, $v) = split /\s+/, $_, 2;
		1588
		1589	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1590	}
		1591
		1592	$rmp
		1593	}
		1594
		1595	sub prepare_random_map {
		1596	my ($exit) = @_;
		1597
		1598	# all this does is basically replace the /! path by
		1599	# a new random map path (?random/...) with a seed
		1600	# that depends on the exit object
		1601
		1602	my $rmp = parse_random_map_params $exit->msg;
		1603
		1604	if ($exit->map) {
		1605	$rmp->{region} = $exit->map->region_name;
		1606	$rmp->{origin_map} = $exit->map->path;
		1607	$rmp->{origin_x} = $exit->x;
		1608	$rmp->{origin_y} = $exit->y;
		1609	}
		1610
		1611	$rmp->{random_seed} ||= $exit->random_seed;
		1612
		1613	my $data = cf::to_json $rmp;
		1614	my $md5 = Digest::MD5::md5_hex $data;
		1615
		1616	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1617	aio_write $fh, 0, (length $data), $data, 0;
		1618
		1619	$exit->slaying ("?random/$md5");
		1620	$exit->msg (undef);
		1621	}
		1622	}
		1623
		1624	sub cf::object::player::enter_exit {
777	my ($self, $id, %msg) = @_;	1625	my ($self, $exit) = @_;
778		1626
779	$msg{msgid} = $id;	1627	return unless $self->type == cf::PLAYER;
780		1628
781	$self->send ("ext " . to_json \%msg);	1629	$self->enter_link;
782	}
783		1630
784	#############################################################################	1631	(Coro::async {
785	# map scripting support	1632	unless (eval {
		1633
		1634	prepare_random_map $exit
		1635	if $exit->slaying eq "/!";
		1636
		1637	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1638	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1639
		1640	1;
		1641	}) {
		1642	$self->message ("Something went wrong deep within the crossfire server. "
		1643	. "I'll try to bring you back to the map you were before. "
		1644	. "Please report this to the dungeon master",
		1645	cf::NDI_UNIQUE | cf::NDI_RED);
		1646
		1647	warn "ERROR in enter_exit: $@";
		1648	$self->leave_link;
		1649	}
		1650	})->prio (1);
		1651	}
		1652
		1653	=head3 cf::client
		1654
		1655	=over 4
		1656
		1657	=item $client->send_drawinfo ($text, $flags)
		1658
		1659	Sends a drawinfo packet to the client. Circumvents output buffering so
		1660	should not be used under normal circumstances.
		1661
		1662	=cut
		1663
		1664	sub cf::client::send_drawinfo {
		1665	my ($self, $text, $flags) = @_;
		1666
		1667	utf8::encode $text;
		1668	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1669	}
		1670
		1671
		1672	=item $success = $client->query ($flags, "text", \&cb)
		1673
		1674	Queues a query to the client, calling the given callback with
		1675	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1676	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1677
		1678	Queries can fail, so check the return code. Or don't, as queries will become
		1679	reliable at some point in the future.
		1680
		1681	=cut
		1682
		1683	sub cf::client::query {
		1684	my ($self, $flags, $text, $cb) = @_;
		1685
		1686	return unless $self->state == ST_PLAYING
		1687	|| $self->state == ST_SETUP
		1688	|| $self->state == ST_CUSTOM;
		1689
		1690	$self->state (ST_CUSTOM);
		1691
		1692	utf8::encode $text;
		1693	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1694
		1695	$self->send_packet ($self->{query_queue}[0][0])
		1696	if @{ $self->{query_queue} } == 1;
		1697	}
		1698
		1699	cf::client->attach (
		1700	on_reply => sub {
		1701	my ($ns, $msg) = @_;
		1702
		1703	# this weird shuffling is so that direct followup queries
		1704	# get handled first
		1705	my $queue = delete $ns->{query_queue};
		1706
		1707	(shift @$queue)->[1]->($msg);
		1708
		1709	push @{ $ns->{query_queue} }, @$queue;
		1710
		1711	if (@{ $ns->{query_queue} } == @$queue) {
		1712	if (@$queue) {
		1713	$ns->send_packet ($ns->{query_queue}[0][0]);
		1714	} else {
		1715	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1716	}
		1717	}
		1718	},
		1719	);
		1720
		1721	=item $client->coro (\&cb)
		1722
		1723	Create a new coroutine, running the specified callback. The coroutine will
		1724	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1725	or loss of connection).
		1726
		1727	=cut
		1728
		1729	sub cf::client::coro {
		1730	my ($self, $cb) = @_;
		1731
		1732	my $coro; $coro = async {
		1733	eval {
		1734	$cb->();
		1735	};
		1736	warn $@ if $@;
		1737	};
		1738
		1739	$coro->on_destroy (sub {
		1740	delete $self->{_coro}{$coro+0};
		1741	});
		1742
		1743	$self->{_coro}{$coro+0} = $coro;
		1744
		1745	$coro
		1746	}
		1747
		1748	cf::client->attach (
		1749	on_destroy => sub {
		1750	my ($ns) = @_;
		1751
		1752	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1753	},
		1754	);
		1755
		1756	=back
		1757
		1758
		1759	=head2 SAFE SCRIPTING
		1760
		1761	Functions that provide a safe environment to compile and execute
		1762	snippets of perl code without them endangering the safety of the server
		1763	itself. Looping constructs, I/O operators and other built-in functionality
		1764	is not available in the safe scripting environment, and the number of
		1765	functions and methods that can be called is greatly reduced.
		1766
		1767	=cut
786		1768
787	our $safe = new Safe "safe";	1769	our $safe = new Safe "safe";
788	our $safe_hole = new Safe::Hole;	1770	our $safe_hole = new Safe::Hole;
789		1771
790	$SIG{FPE} = 'IGNORE';	1772	$SIG{FPE} = 'IGNORE';
791		1773
792	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1774	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
793		1775
794	# here we export the classes and methods available to script code	1776	# here we export the classes and methods available to script code
795		1777
		1778	=pod
		1779
		1780	The following fucntions and emthods are available within a safe environment:
		1781
		1782	cf::object contr pay_amount pay_player map
		1783	cf::object::player player
		1784	cf::player peaceful
		1785	cf::map trigger
		1786
		1787	=cut
		1788
796	for (	1789	for (
797	["cf::object" => qw(contr pay_amount pay_player)],	1790	["cf::object" => qw(contr pay_amount pay_player map)],
798	["cf::object::player" => qw(player)],	1791	["cf::object::player" => qw(player)],
799	["cf::player" => qw(peaceful)],	1792	["cf::player" => qw(peaceful)],
		1793	["cf::map" => qw(trigger)],
800	) {	1794	) {
801	no strict 'refs';	1795	no strict 'refs';
802	my ($pkg, @funs) = @$_;	1796	my ($pkg, @funs) = @$_;
803	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1797	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
804	for @funs;	1798	for @funs;
805	}	1799	}
		1800
		1801	=over 4
		1802
		1803	=item @retval = safe_eval $code, [var => value, ...]
		1804
		1805	Compiled and executes the given perl code snippet. additional var/value
		1806	pairs result in temporary local (my) scalar variables of the given name
		1807	that are available in the code snippet. Example:
		1808
		1809	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1810
		1811	=cut
806		1812
807	sub safe_eval($;@) {	1813	sub safe_eval($;@) {
808	my ($code, %vars) = @_;	1814	my ($code, %vars) = @_;
809		1815
810	my $qcode = $code;	1816	my $qcode = $code;
…		…
833	}	1839	}
834		1840
835	wantarray ? @res : $res[0]	1841	wantarray ? @res : $res[0]
836	}	1842	}
837		1843
		1844	=item cf::register_script_function $function => $cb
		1845
		1846	Register a function that can be called from within map/npc scripts. The
		1847	function should be reasonably secure and should be put into a package name
		1848	like the extension.
		1849
		1850	Example: register a function that gets called whenever a map script calls
		1851	C<rent::overview>, as used by the C<rent> extension.
		1852
		1853	cf::register_script_function "rent::overview" => sub {
		1854	...
		1855	};
		1856
		1857	=cut
		1858
838	sub register_script_function {	1859	sub register_script_function {
839	my ($fun, $cb) = @_;	1860	my ($fun, $cb) = @_;
840		1861
841	no strict 'refs';	1862	no strict 'refs';
842	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1863	*{"safe::$fun"} = $safe_hole->wrap ($cb);
843	}	1864	}
844		1865
		1866	=back
		1867
		1868	=cut
		1869
		1870	#############################################################################
		1871
		1872	=head2 EXTENSION DATABASE SUPPORT
		1873
		1874	Crossfire maintains a very simple database for extension use. It can
		1875	currently store anything that can be serialised using Storable, which
		1876	excludes objects.
		1877
		1878	The parameter C<$family> should best start with the name of the extension
		1879	using it, it should be unique.
		1880
		1881	=over 4
		1882
		1883	=item $hashref = cf::db_get $family
		1884
		1885	Return a hashref for use by the extension C<$family>, which can be
		1886	modified. After modifications, you have to call C<cf::db_dirty> or
		1887	C<cf::db_sync>.
		1888
		1889	=item $value = cf::db_get $family => $key
		1890
		1891	Returns a single value from the database
		1892
		1893	=item cf::db_put $family => $hashref
		1894
		1895	Stores the given family hashref into the database. Updates are delayed, if
		1896	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1897
		1898	=item cf::db_put $family => $key => $value
		1899
		1900	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1901	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1902
		1903	=item cf::db_dirty
		1904
		1905	Marks the database as dirty, to be updated at a later time.
		1906
		1907	=item cf::db_sync
		1908
		1909	Immediately write the database to disk I<if it is dirty>.
		1910
		1911	=cut
		1912
		1913	our $DB;
		1914
		1915	{
		1916	my $path = cf::localdir . "/database.pst";
		1917
		1918	sub db_load() {
		1919	$DB = stat $path ? Storable::retrieve $path : { };
		1920	}
		1921
		1922	my $pid;
		1923
		1924	sub db_save() {
		1925	waitpid $pid, 0 if $pid;
		1926	if (0 == ($pid = fork)) {
		1927	$DB->{_meta}{version} = 1;
		1928	Storable::nstore $DB, "$path~";
		1929	rename "$path~", $path;
		1930	cf::_exit 0 if defined $pid;
		1931	}
		1932	}
		1933
		1934	my $dirty;
		1935
		1936	sub db_sync() {
		1937	db_save if $dirty;
		1938	undef $dirty;
		1939	}
		1940
		1941	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1942	db_sync;
		1943	});
		1944
		1945	sub db_dirty() {
		1946	$dirty = 1;
		1947	$idle->start;
		1948	}
		1949
		1950	sub db_get($;$) {
		1951	@_ >= 2
		1952	? $DB->{$_[0]}{$_[1]}
		1953	: ($DB->{$_[0]} ||= { })
		1954	}
		1955
		1956	sub db_put($$;$) {
		1957	if (@_ >= 3) {
		1958	$DB->{$_[0]}{$_[1]} = $_[2];
		1959	} else {
		1960	$DB->{$_[0]} = $_[1];
		1961	}
		1962	db_dirty;
		1963	}
		1964
		1965	cf::global->attach (
		1966	prio => 10000,
		1967	on_cleanup => sub {
		1968	db_sync;
		1969	},
		1970	);
		1971	}
		1972
845	#############################################################################	1973	#############################################################################
846	# the server's main()	1974	# the server's main()
847		1975
		1976	sub cfg_load {
		1977	open my $fh, "<:utf8", cf::confdir . "/config"
		1978	or return;
		1979
		1980	local $/;
		1981	*CFG = YAML::Syck::Load <$fh>;
		1982	}
		1983
848	sub main {	1984	sub main {
		1985	# we must not ever block the main coroutine
		1986	local $Coro::idle = sub {
		1987	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		1988	(Coro::unblock_sub {
		1989	Event::one_event;
		1990	})->();
		1991	};
		1992
		1993	cfg_load;
		1994	db_load;
		1995	load_extensions;
849	Event::loop;	1996	Event::loop;
850	}	1997	}
851		1998
852	#############################################################################	1999	#############################################################################
853	# initialisation	2000	# initialisation
854		2001
		2002	sub reload() {
		2003	# can/must only be called in main
		2004	if ($Coro::current != $Coro::main) {
		2005	warn "can only reload from main coroutine\n";
		2006	return;
		2007	}
		2008
		2009	warn "reloading...";
		2010
		2011	local $FREEZE = 1;
		2012	cf::emergency_save;
		2013
		2014	eval {
		2015	# if anything goes wrong in here, we should simply crash as we already saved
		2016
		2017	# cancel all watchers
		2018	for (Event::all_watchers) {
		2019	$_->cancel if $_->data & WF_AUTOCANCEL;
		2020	}
		2021
		2022	# cancel all extension coros
		2023	$_->cancel for values %EXT_CORO;
		2024	%EXT_CORO = ();
		2025
		2026	# unload all extensions
		2027	for (@exts) {
		2028	warn "unloading <$_>";
		2029	unload_extension $_;
		2030	}
		2031
		2032	# unload all modules loaded from $LIBDIR
		2033	while (my ($k, $v) = each %INC) {
		2034	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2035
		2036	warn "removing <$k>";
		2037	delete $INC{$k};
		2038
		2039	$k =~ s/\.pm$//;
		2040	$k =~ s/\//::/g;
		2041
		2042	if (my $cb = $k->can ("unload_module")) {
		2043	$cb->();
		2044	}
		2045
		2046	Symbol::delete_package $k;
		2047	}
		2048
		2049	# sync database to disk
		2050	cf::db_sync;
		2051	IO::AIO::flush;
		2052
		2053	# get rid of safe::, as good as possible
		2054	Symbol::delete_package "safe::$_"
		2055	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2056
		2057	# remove register_script_function callbacks
		2058	# TODO
		2059
		2060	# unload cf.pm "a bit"
		2061	delete $INC{"cf.pm"};
		2062
		2063	# don't, removes xs symbols, too,
		2064	# and global variables created in xs
		2065	#Symbol::delete_package __PACKAGE__;
		2066
		2067	# reload cf.pm
		2068	warn "reloading cf.pm";
		2069	require cf;
		2070	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2071
		2072	# load config and database again
		2073	cf::cfg_load;
		2074	cf::db_load;
		2075
		2076	# load extensions
		2077	warn "load extensions";
		2078	cf::load_extensions;
		2079
		2080	# reattach attachments to objects
		2081	warn "reattach";
		2082	_global_reattach;
		2083	};
		2084
		2085	if ($@) {
		2086	warn $@;
		2087	warn "error while reloading, exiting.";
		2088	exit 1;
		2089	}
		2090
		2091	warn "reloaded successfully";
		2092	};
		2093
		2094	#############################################################################
		2095
		2096	unless ($LINK_MAP) {
		2097	$LINK_MAP = cf::map::new;
		2098
		2099	$LINK_MAP->width (41);
		2100	$LINK_MAP->height (41);
		2101	$LINK_MAP->alloc;
		2102	$LINK_MAP->path ("{link}");
		2103	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2104	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2105
		2106	# dirty hack because... archetypes are not yet loaded
		2107	Event->timer (
		2108	after => 2,
		2109	cb => sub {
		2110	$_[0]->w->cancel;
		2111
		2112	# provide some exits "home"
		2113	my $exit = cf::object::new "exit";
		2114
		2115	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2116	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2117	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2118
		2119	$LINK_MAP->insert ($exit->clone, 19, 19);
		2120	$LINK_MAP->insert ($exit->clone, 19, 20);
		2121	$LINK_MAP->insert ($exit->clone, 19, 21);
		2122	$LINK_MAP->insert ($exit->clone, 20, 19);
		2123	$LINK_MAP->insert ($exit->clone, 20, 21);
		2124	$LINK_MAP->insert ($exit->clone, 21, 19);
		2125	$LINK_MAP->insert ($exit->clone, 21, 20);
		2126	$LINK_MAP->insert ($exit->clone, 21, 21);
		2127
		2128	$exit->destroy;
		2129	});
		2130
		2131	$LINK_MAP->{deny_save} = 1;
		2132	$LINK_MAP->{deny_reset} = 1;
		2133
		2134	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2135	}
		2136
855	register "<global>", __PACKAGE__;	2137	register "<global>", __PACKAGE__;
856		2138
		2139	register_command "reload" => sub {
		2140	my ($who, $arg) = @_;
		2141
		2142	if ($who->flag (FLAG_WIZ)) {
		2143	$who->message ("start of reload.");
		2144	reload;
		2145	$who->message ("end of reload.");
		2146	}
		2147	};
		2148
857	unshift @INC, $LIBDIR;	2149	unshift @INC, $LIBDIR;
858		2150
859	load_extensions;
860
861	$TICK_WATCHER = Event->timer (	2151	$TICK_WATCHER = Event->timer (
		2152	reentrant => 0,
862	prio => 1,	2153	prio => 0,
863	at => $NEXT_TICK || 1,	2154	at => $NEXT_TICK || $TICK,
		2155	data => WF_AUTOCANCEL,
864	cb => sub {	2156	cb => sub {
		2157	unless ($FREEZE) {
865	cf::server_tick; # one server iteration	2158	cf::server_tick; # one server iteration
		2159	$RUNTIME += $TICK;
		2160	}
866		2161
867	my $NOW = Event::time;
868	$NEXT_TICK += $TICK;	2162	$NEXT_TICK += $TICK;
869		2163
870	# if we are delayed by four ticks, skip them all	2164	# if we are delayed by four ticks or more, skip them all
871	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2165	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
872		2166
873	$TICK_WATCHER->at ($NEXT_TICK);	2167	$TICK_WATCHER->at ($NEXT_TICK);
874	$TICK_WATCHER->start;	2168	$TICK_WATCHER->start;
875	},	2169	},
876	);	2170	);
877		2171
878	_reload_2;	2172	IO::AIO::max_poll_time $TICK * 0.2;
		2173
		2174	Event->io (
		2175	fd => IO::AIO::poll_fileno,
		2176	poll => 'r',
		2177	prio => 5,
		2178	data => WF_AUTOCANCEL,
		2179	cb => \&IO::AIO::poll_cb,
		2180	);
		2181
		2182	Event->timer (
		2183	data => WF_AUTOCANCEL,
		2184	after => 0,
		2185	interval => 10,
		2186	cb => sub {
		2187	(Coro::unblock_sub {
		2188	write_runtime
		2189	or warn "ERROR: unable to write runtime file: $!";
		2190	})->();
		2191	},
		2192	);
879		2193
880	1	2194	1
881		2195

Diff Legend

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