Skip to content

Commit 5e507c9

Browse files
est31est31
committedNov 6, 2015
Add server side ncurses terminal
This adds a chat console the server owner can use for administration or to talk with players. It runs in its own thread, which makes the user interface immune to the server's lag, behaving just like a client, except timeout. As it uses the same console code as the f10 console, things like nick completion or a scroll buffer basically come for free. The terminal itself is written in a general way so that adding a client version later on is just about implementing an interface. Fatal errors are printed after the console exists and the ncurses terminal buffer gets cleaned up with endwin(), so that the error still remains visible. The server owner can chose their username their entered text will have in chat and where players can send PMs to. Once the username is secured with a password to prevent anybody to take over the server, the owner can execute admin tasks over the console. This change includes a contribution by @kahrl who has improved ncurses library detection.
·
5.11.00.4.14
1 parent 1384108 commit 5e507c9

22 files changed

+1214
-91
lines changed
 

‎builtin/init.lua

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77

88
-- Initialize some very basic things
99
function core.debug(...) core.log(table.concat({...}, "\t")) end
10+
if core.print then
Has conversations. Original line has conversations.
11+
local core_print = core.print
12+
-- Override native print and use
13+
-- terminal if that's turned on
14+
function print(...)
15+
core_print(table.concat({...}, "\t"))
16+
end
17+
core.print = nil -- don't pollute our namespace
18+
end
1019
math.randomseed(os.time())
1120
os.setlocale("C", "numeric")
1221
minetest = core

‎cmake/Modules/FindNcursesw.cmake

+189
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
#.rst:
2+
# FindNcursesw
3+
# ------------
4+
#
5+
# Find the ncursesw (wide ncurses) include file and library.
6+
#
7+
# Based on FindCurses.cmake which comes with CMake.
8+
#
9+
# Checks for ncursesw first. If not found, it then executes the
10+
# regular old FindCurses.cmake to look for for ncurses (or curses).
11+
#
12+
#
13+
# Result Variables
14+
# ^^^^^^^^^^^^^^^^
15+
#
16+
# This module defines the following variables:
17+
#
18+
# ``CURSES_FOUND``
19+
# True if curses is found.
20+
# ``NCURSESW_FOUND``
21+
# True if ncursesw is found.
22+
# ``CURSES_INCLUDE_DIRS``
23+
# The include directories needed to use Curses.
24+
# ``CURSES_LIBRARIES``
25+
# The libraries needed to use Curses.
26+
# ``CURSES_HAVE_CURSES_H``
27+
# True if curses.h is available.
28+
# ``CURSES_HAVE_NCURSES_H``
29+
# True if ncurses.h is available.
30+
# ``CURSES_HAVE_NCURSES_NCURSES_H``
31+
# True if ``ncurses/ncurses.h`` is available.
32+
# ``CURSES_HAVE_NCURSES_CURSES_H``
33+
# True if ``ncurses/curses.h`` is available.
34+
# ``CURSES_HAVE_NCURSESW_NCURSES_H``
35+
# True if ``ncursesw/ncurses.h`` is available.
36+
# ``CURSES_HAVE_NCURSESW_CURSES_H``
37+
# True if ``ncursesw/curses.h`` is available.
38+
#
39+
# Set ``CURSES_NEED_NCURSES`` to ``TRUE`` before the
40+
# ``find_package(Ncursesw)`` call if NCurses functionality is required.
41+
#
42+
#=============================================================================
43+
# Copyright 2001-2014 Kitware, Inc.
44+
# modifications: Copyright 2015 kahrl <kahrl@gmx.net>
45+
#
46+
# Redistribution and use in source and binary forms, with or without
47+
# modification, are permitted provided that the following conditions
48+
# are met:
49+
#
50+
# * Redistributions of source code must retain the above copyright
51+
# notice, this list of conditions and the following disclaimer.
52+
#
53+
# * Redistributions in binary form must reproduce the above copyright
54+
# notice, this list of conditions and the following disclaimer in the
55+
# documentation and/or other materials provided with the distribution.
56+
#
57+
# * Neither the names of Kitware, Inc., the Insight Software Consortium,
58+
# nor the names of their contributors may be used to endorse or promote
59+
# products derived from this software without specific prior written
60+
# permission.
61+
#
62+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
63+
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
64+
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
65+
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
66+
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
67+
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
68+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
69+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
70+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
72+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73+
#
74+
# ------------------------------------------------------------------------------
75+
#
76+
# The above copyright and license notice applies to distributions of
77+
# CMake in source and binary form. Some source files contain additional
78+
# notices of original copyright by their contributors; see each source
79+
# for details. Third-party software packages supplied with CMake under
80+
# compatible licenses provide their own copyright notices documented in
81+
# corresponding subdirectories.
82+
#
83+
# ------------------------------------------------------------------------------
84+
#
85+
# CMake was initially developed by Kitware with the following sponsorship:
86+
#
87+
# * National Library of Medicine at the National Institutes of Health
88+
# as part of the Insight Segmentation and Registration Toolkit (ITK).
89+
#
90+
# * US National Labs (Los Alamos, Livermore, Sandia) ASC Parallel
91+
# Visualization Initiative.
92+
#
93+
# * National Alliance for Medical Image Computing (NAMIC) is funded by the
94+
# National Institutes of Health through the NIH Roadmap for Medical Research,
95+
# Grant U54 EB005149.
96+
#
97+
# * Kitware, Inc.
98+
#=============================================================================
99+
100+
include(CheckLibraryExists)
101+
102+
find_library(CURSES_NCURSESW_LIBRARY NAMES ncursesw
103+
DOC "Path to libncursesw.so or .lib or .a")
104+
105+
set(CURSES_USE_NCURSES FALSE)
106+
set(CURSES_USE_NCURSESW FALSE)
107+
108+
if(CURSES_NCURSESW_LIBRARY)
109+
set(CURSES_USE_NCURSES TRUE)
110+
set(CURSES_USE_NCURSESW TRUE)
111+
endif()
112+
113+
if(CURSES_USE_NCURSESW)
114+
get_filename_component(_cursesLibDir "${CURSES_NCURSESW_LIBRARY}" PATH)
115+
get_filename_component(_cursesParentDir "${_cursesLibDir}" PATH)
116+
117+
find_path(CURSES_INCLUDE_PATH
118+
NAMES ncursesw/ncurses.h ncursesw/curses.h
119+
HINTS "${_cursesParentDir}/include"
120+
)
121+
122+
# Previous versions of FindCurses provided these values.
123+
if(NOT DEFINED CURSES_LIBRARY)
124+
set(CURSES_LIBRARY "${CURSES_NCURSESW_LIBRARY}")
125+
endif()
126+
127+
CHECK_LIBRARY_EXISTS("${CURSES_NCURSESW_LIBRARY}"
128+
cbreak "" CURSES_NCURSESW_HAS_CBREAK)
129+
if(NOT CURSES_NCURSESW_HAS_CBREAK)
130+
find_library(CURSES_EXTRA_LIBRARY tinfo HINTS "${_cursesLibDir}"
131+
DOC "Path to libtinfo.so or .lib or .a")
132+
find_library(CURSES_EXTRA_LIBRARY tinfo )
133+
endif()
134+
135+
# Report whether each possible header name exists in the include directory.
136+
if(NOT DEFINED CURSES_HAVE_NCURSESW_NCURSES_H)
137+
if(EXISTS "${CURSES_INCLUDE_PATH}/ncursesw/ncurses.h")
138+
set(CURSES_HAVE_NCURSESW_NCURSES_H "${CURSES_INCLUDE_PATH}/ncursesw/ncurses.h")
139+
else()
140+
set(CURSES_HAVE_NCURSESW_NCURSES_H "CURSES_HAVE_NCURSESW_NCURSES_H-NOTFOUND")
141+
endif()
142+
endif()
143+
if(NOT DEFINED CURSES_HAVE_NCURSESW_CURSES_H)
144+
if(EXISTS "${CURSES_INCLUDE_PATH}/ncursesw/curses.h")
145+
set(CURSES_HAVE_NCURSESW_CURSES_H "${CURSES_INCLUDE_PATH}/ncursesw/curses.h")
146+
else()
147+
set(CURSES_HAVE_NCURSESW_CURSES_H "CURSES_HAVE_NCURSESW_CURSES_H-NOTFOUND")
148+
endif()
149+
endif()
150+
151+
find_library(CURSES_FORM_LIBRARY form HINTS "${_cursesLibDir}"
152+
DOC "Path to libform.so or .lib or .a")
153+
find_library(CURSES_FORM_LIBRARY form )
154+
155+
# Need to provide the *_LIBRARIES
156+
set(CURSES_LIBRARIES ${CURSES_LIBRARY})
157+
158+
if(CURSES_EXTRA_LIBRARY)
159+
set(CURSES_LIBRARIES ${CURSES_LIBRARIES} ${CURSES_EXTRA_LIBRARY})
160+
endif()
161+
162+
if(CURSES_FORM_LIBRARY)
163+
set(CURSES_LIBRARIES ${CURSES_LIBRARIES} ${CURSES_FORM_LIBRARY})
164+
endif()
165+
166+
# Provide the *_INCLUDE_DIRS result.
167+
set(CURSES_INCLUDE_DIRS ${CURSES_INCLUDE_PATH})
168+
set(CURSES_INCLUDE_DIR ${CURSES_INCLUDE_PATH}) # compatibility
169+
170+
# handle the QUIETLY and REQUIRED arguments and set CURSES_FOUND to TRUE if
171+
# all listed variables are TRUE
172+
include(FindPackageHandleStandardArgs)
173+
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Ncursesw DEFAULT_MSG
174+
CURSES_LIBRARY CURSES_INCLUDE_PATH)
175+
set(CURSES_FOUND ${NCURSESW_FOUND})
176+
177+
else()
178+
find_package(Curses)
179+
set(NCURSESW_FOUND FALSE)
180+
endif()
181+
182+
mark_as_advanced(
183+
CURSES_INCLUDE_PATH
184+
CURSES_CURSES_LIBRARY
185+
CURSES_NCURSES_LIBRARY
186+
CURSES_NCURSESW_LIBRARY
187+
CURSES_EXTRA_LIBRARY
188+
CURSES_FORM_LIBRARY
189+
)

‎doc/minetest.6

+3
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ Run speed tests
8989
.B \-\-migrate <value>
9090
Migrate from current map backend to another. Possible values are sqlite3,
9191
leveldb, redis, and dummy.
92+
.TP
93+
.B \-\-terminal
94+
Display an interactive terminal over ncurses during execution.
9295

9396
.SH ENVIRONMENT
9497
.TP

‎src/CMakeLists.txt

+22-1
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,20 @@ find_package(Lua REQUIRED)
160160

161161
find_package(GMP REQUIRED)
162162

163+
option(ENABLE_CURSES "Enable ncurses console" TRUE)
164+
set(USE_CURSES FALSE)
165+
166+
if(ENABLE_CURSES)
167+
find_package(Ncursesw)
168+
if(CURSES_FOUND)
169+
set(USE_CURSES TRUE)
170+
message(STATUS "ncurses console enabled.")
171+
include_directories(${CURSES_INCLUDE_DIRS})
172+
else()
173+
message(STATUS "ncurses not found!")
174+
endif()
175+
endif(ENABLE_CURSES)
176+
163177
option(ENABLE_LEVELDB "Enable LevelDB backend" TRUE)
164178
set(USE_LEVELDB FALSE)
165179

@@ -322,6 +336,7 @@ set(common_SRCS
322336
areastore.cpp
323337
ban.cpp
324338
cavegen.cpp
339+
chat.cpp
325340
clientiface.cpp
326341
collision.cpp
327342
content_abm.cpp
@@ -387,6 +402,7 @@ set(common_SRCS
387402
sound.cpp
388403
staticobject.cpp
389404
subgame.cpp
405+
terminal_chat_console.cpp
390406
tool.cpp
391407
treegen.cpp
392408
version.cpp
@@ -431,7 +447,6 @@ set(client_SRCS
431447
${sound_SRCS}
432448
${client_network_SRCS}
433449
camera.cpp
434-
chat.cpp
435450
client.cpp
436451
clientmap.cpp
437452
clientmedia.cpp
@@ -558,6 +573,9 @@ if(BUILD_CLIENT)
558573
${CGUITTFONT_LIBRARY}
559574
)
560575
endif()
576+
if (USE_CURSES)
577+
target_link_libraries(${PROJECT_NAME} ${CURSES_LIBRARIES})
578+
endif()
561579
if (USE_LEVELDB)
562580
target_link_libraries(${PROJECT_NAME} ${LEVELDB_LIBRARY})
563581
endif()
@@ -585,6 +603,9 @@ if(BUILD_SERVER)
585603
)
586604
set_target_properties(${PROJECT_NAME}server PROPERTIES
587605
COMPILE_DEFINITIONS "SERVER")
606+
if (USE_CURSES)
607+
target_link_libraries(${PROJECT_NAME}server ${CURSES_LIBRARIES})
608+
endif()
588609
if (USE_LEVELDB)
589610
target_link_libraries(${PROJECT_NAME}server ${LEVELDB_LIBRARY})
590611
endif()

‎src/chat.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
2525
#include <vector>
2626
#include <list>
2727

28-
// Chat console related classes, only used by the client
28+
// Chat console related classes
2929

3030
struct ChatLine
3131
{
@@ -123,7 +123,7 @@ class ChatBuffer
123123
u32 m_scrollback;
124124
// Array of unformatted chat lines
125125
std::vector<ChatLine> m_unformatted;
126-
126+
127127
// Number of character columns in console
128128
u32 m_cols;
129129
// Number of character rows in console
@@ -213,7 +213,7 @@ class ChatPrompt
213213
std::wstring m_line;
214214
// History buffer
215215
std::vector<std::wstring> m_history;
216-
// History index (0 <= m_history_index <= m_history.size())
216+
// History index (0 <= m_history_index <= m_history.size())
217217
u32 m_history_index;
218218
// Maximum number of history entries
219219
u32 m_history_limit;

‎src/chat_interface.h

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/*
2+
Minetest
3+
Copyright (C) 2015 est31 <MTest31@outlook.com>
4+
5+
This program is free software; you can redistribute it and/or modify
6+
it under the terms of the GNU Lesser General Public License as published by
7+
the Free Software Foundation; either version 2.1 of the License, or
8+
(at your option) any later version.
9+
10+
This program is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
GNU Lesser General Public License for more details.
14+
15+
You should have received a copy of the GNU Lesser General Public License along
16+
with this program; if not, write to the Free Software Foundation, Inc.,
17+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*/
19+
20+
#ifndef CHAT_INTERFACE_H
21+
#define CHAT_INTERFACE_H
22+
23+
#include "util/container.h"
24+
#include <string>
25+
#include <queue>
26+
#include "irrlichttypes.h"
27+
28+
enum ChatEventType {
29+
CET_CHAT,
30+
CET_NICK_ADD,
31+
CET_NICK_REMOVE,
32+
CET_TIME_INFO,
33+
};
34+
35+
class ChatEvent {
36+
protected:
37+
ChatEvent(ChatEventType a_type) { type = a_type; }
38+
public:
39+
ChatEventType type;
40+
};
41+
42+
struct ChatEventTimeInfo : public ChatEvent {
43+
ChatEventTimeInfo(
44+
u64 a_game_time,
45+
u32 a_time) :
46+
ChatEvent(CET_TIME_INFO),
47+
game_time(a_game_time),
48+
time(a_time)
49+
{}
50+
51+
u64 game_time;
52+
u32 time;
53+
};
54+
55+
struct ChatEventNick : public ChatEvent {
56+
ChatEventNick(ChatEventType a_type,
57+
const std::string &a_nick) :
58+
ChatEvent(a_type), // one of CET_NICK_ADD, CET_NICK_REMOVE
59+
nick(a_nick)
60+
{}
61+
62+
std::string nick;
63+
};
64+
65+
struct ChatEventChat : public ChatEvent {
66+
ChatEventChat(const std::string &a_nick,
67+
const std::wstring &an_evt_msg) :
68+
ChatEvent(CET_CHAT),
69+
nick(a_nick),
70+
evt_msg(an_evt_msg)
71+
{}
72+
73+
std::string nick;
74+
std::wstring evt_msg;
75+
};
76+
77+
struct ChatInterface {
78+
MutexedQueue<ChatEvent *> command_queue; // chat backend --> server
79+
MutexedQueue<ChatEvent *> outgoing_queue; // server --> chat backend
80+
};
81+
82+
#endif

0 commit comments

Comments
 (0)
Please sign in to comment.