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

Diff Legend

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