This class provides support for the Telnet protocol. This is useful for communication with legacy, terminal-based applications running on servers, devices, or locally.
102 |
103 |
--------------------------------------------------------------------------------
/INSTALL.TXT:
--------------------------------------------------------------------------------
1 | INSTALLATION INSTRUCTIONS
2 |
3 | These instructions refer to the package you are installing as
4 | some-package.tar.gz or some-package.zip. The .zip file is intended for use
5 | on Windows.
6 |
7 | The directory you choose for the installation will be referred to as
8 | your-install-dir.
9 |
10 | Note to Qt Visual Studio Integration users: In the instructions below,
11 | instead of building from command line with nmake, you can use the menu
12 | command 'Qt->Open Solution from .pro file' on the .pro files in the
13 | example and plugin directories, and then build from within Visual
14 | Studio.
15 |
16 | Unpacking and installation
17 | --------------------------
18 |
19 | 1. Unpacking the archive (if you have not done so already).
20 |
21 | On Unix and Mac OS X (in a terminal window):
22 |
23 | cd your-install-dir
24 | gunzip some-package.tar.gz
25 | tar xvf some-package.tar
26 |
27 | This creates the subdirectory some-package containing the files.
28 |
29 | On Windows:
30 |
31 | Unpack the .zip archive by right-clicking it in explorer and
32 | choosing "Extract All...". If your version of Windows does not
33 | have zip support, you can use the infozip tools available
34 | from www.info-zip.org.
35 |
36 | If you are using the infozip tools (in a command prompt window):
37 | cd your-install-dir
38 | unzip some-package.zip
39 |
40 | 2. Configuring the package.
41 |
42 | The configure script is called "configure" on unix/mac and
43 | "configure.bat" on Windows. It should be run from a command line
44 | after cd'ing to the package directory.
45 |
46 | You can choose whether you want to use the component by including
47 | its source code directly into your project, or build the component
48 | as a dynamic shared library (DLL) that is loaded into the
49 | application at run-time. The latter may be preferable for
50 | technical or licensing (LGPL) reasons. If you want to build a DLL,
51 | run the configure script with the argument "-library". Also see
52 | the note about usage below.
53 |
54 | (Components that are Qt plugins, e.g. styles and image formats,
55 | are by default built as a plugin DLL.)
56 |
57 | The configure script will prompt you in some cases for further
58 | information. Answer these questions and carefully read the license text
59 | before accepting the license conditions. The package cannot be used if
60 | you do not accept the license conditions.
61 |
62 | 3. Building the component and examples (when required).
63 |
64 | If a DLL is to be built, or if you would like to build the
65 | examples, next give the commands
66 |
67 | qmake
68 | make [or nmake if your are using Microsoft Visual C++]
69 |
70 | The example program(s) can be found in the directory called
71 | "examples" or "example".
72 |
73 | Components that are Qt plugins, e.g. styles and image formats, are
74 | ready to be used as soon as they are built, so the rest of this
75 | installation instruction can be skipped.
76 |
77 | 4. Building the Qt Designer plugin (optional).
78 |
79 | Some of the widget components are provided with plugins for Qt
80 | Designer. To build and install the plugin, cd into the
81 | some-package/plugin directory and give the commands
82 |
83 | qmake
84 | make [or nmake if your are using Microsoft Visual C++]
85 |
86 | Restart Qt Designer to make it load the new widget plugin.
87 |
88 | Note: If you are using the built-in Qt Designer from the Qt Visual
89 | Studio Integration, you will need to manually copy the plugin DLL
90 | file, i.e. copy
91 | %QTDIR%\plugins\designer\some-component.dll
92 | to the Qt Visual Studio Integration plugin path, typically:
93 | C:\Program Files\Trolltech\Qt VS Integration\plugins
94 |
95 | Note: If you for some reason are using a Qt Designer that is built
96 | in debug mode, you will need to build the plugin in debug mode
97 | also. Edit the file plugin.pro in the plugin directory, changing
98 | 'release' to 'debug' in the CONFIG line, before running qmake.
99 |
100 |
101 |
102 | Solutions components are intended to be used directly from the package
103 | directory during development, so there is no 'make install' procedure.
104 |
105 |
106 | Using a component in your project
107 | ---------------------------------
108 |
109 | To use this component in your project, add the following line to the
110 | project's .pro file (or do the equivalent in your IDE):
111 |
112 | include(your-install-dir/some-package/src/some-package.pri)
113 |
114 | This adds the package's sources and headers to the SOURCES and HEADERS
115 | project variables respectively (or, if the component has been
116 | configured as a DLL, it adds that library to the LIBS variable), and
117 | updates INCLUDEPATH to contain the package's src
118 | directory. Additionally, the .pri file may include some dependencies
119 | needed by the package.
120 |
121 | To include a header file from the package in your sources, you can now
122 | simply use:
123 |
124 | #include
125 |
126 | or alternatively, in pre-Qt 4 style:
127 |
128 | #include
129 |
130 | Refer to the documentation to see the classes and headers this
131 | components provides.
132 |
133 |
134 |
135 | Install documentation (optional)
136 | --------------------------------
137 |
138 | The HTML documentation for the package's classes is located in the
139 | your-install-dir/some-package/doc/html/index.html. You can open this
140 | file and read the documentation with any web browser.
141 |
142 | To install the documentation into Qt Assistant (for Qt version 4.4 and
143 | later):
144 |
145 | 1. In Assistant, open the Edit->Preferences dialog and choose the
146 | Documentation tab. Click the Add... button and select the file
147 | your-install-dir/some-package/doc/html/some-package.qch
148 |
149 | For Qt versions prior to 4.4, do instead the following:
150 |
151 | 1. The directory your-install-dir/some-package/doc/html contains a
152 | file called some-package.dcf. Execute the following commands in a
153 | shell, command prompt or terminal window:
154 |
155 | cd your-install-dir/some-package/doc/html/
156 | assistant -addContentFile some-package.dcf
157 |
158 | The next time you start Qt Assistant, you can access the package's
159 | documentation.
160 |
161 |
162 | Removing the documentation from assistant
163 | -----------------------------------------
164 |
165 | If you have installed the documentation into Qt Assistant, and want to uninstall it, do as follows, for Qt version 4.4 and later:
166 |
167 | 1. In Assistant, open the Edit->Preferences dialog and choose the
168 | Documentation tab. In the list of Registered Documentation, select
169 | the item com.trolltech.qtsolutions.some-package_version, and click
170 | the Remove button.
171 |
172 | For Qt versions prior to 4.4, do instead the following:
173 |
174 | 1. The directory your-install-dir/some-package/doc/html contains a
175 | file called some-package.dcf. Execute the following commands in a
176 | shell, command prompt or terminal window:
177 |
178 | cd your-install-dir/some-package/doc/html/
179 | assistant -removeContentFile some-package.dcf
180 |
181 |
182 |
183 | Using the component as a DLL
184 | ----------------------------
185 |
186 | 1. Normal components
187 |
188 | The shared library (DLL) is built and placed in the
189 | some-package/lib directory. It is intended to be used directly
190 | from there during development. When appropriate, both debug and
191 | release versions are built, since the run-time linker will in some
192 | cases refuse to load a debug-built DLL into a release-built
193 | application or vice versa.
194 |
195 | The following steps are taken by default to help the dynamic
196 | linker to locate the DLL at run-time (during development):
197 |
198 | Unix: The some-package.pri file will add linker instructions to
199 | add the some-package/lib directory to the rpath of the
200 | executable. (When distributing, or if your system does not support
201 | rpath, you can copy the shared library to another place that is
202 | searched by the dynamic linker, e.g. the "lib" directory of your
203 | Qt installation.)
204 |
205 | Mac: The full path to the library is hardcoded into the library
206 | itself, from where it is copied into the executable at link time,
207 | and ready by the dynamic linker at run-time. (When distributing,
208 | you will want to edit these hardcoded paths in the same way as for
209 | the Qt DLLs. Refer to the document "Deploying an Application on
210 | Mac OS X" in the Qt Reference Documentation.)
211 |
212 | Windows: the .dll file(s) are copied into the "bin" directory of
213 | your Qt installation. The Qt installation will already have set up
214 | that directory to be searched by the dynamic linker.
215 |
216 |
217 | 2. Plugins
218 |
219 | For Qt Solutions plugins (e.g. image formats), both debug and
220 | release versions of the plugin are built by default when
221 | appropriate, since in some cases the release Qt library will not
222 | load a debug plugin, and vice versa. The plugins are automatically
223 | copied into the plugins directory of your Qt installation when
224 | built, so no further setup is required.
225 |
226 | Plugins may also be built statically, i.e. as a library that will be
227 | linked into your application executable, and so will not need to
228 | be redistributed as a separate plugin DLL to end users. Static
229 | building is required if Qt itself is built statically. To do it,
230 | just add "static" to the CONFIG variable in the plugin/plugin.pro
231 | file before building. Refer to the "Static Plugins" section in the
232 | chapter "How to Create Qt Plugins" for explanation of how to use a
233 | static plugin in your application. The source code of the example
234 | program(s) will also typically contain the relevant instructions
235 | as comments.
236 |
237 |
238 |
239 | Uninstalling
240 | ------------
241 |
242 | The following command will remove any fils that have been
243 | automatically placed outside the package directory itself during
244 | installation and building
245 |
246 | make distclean [or nmake if your are using Microsoft Visual C++]
247 |
248 | If Qt Assistant documentation or Qt Designer plugins have been
249 | installed, they can be uninstalled manually, ref. above.
250 |
251 |
252 | Enjoy! :)
253 |
254 | - The Qt Solutions Team.
255 |
--------------------------------------------------------------------------------
/examples/simpleClient/main.cpp:
--------------------------------------------------------------------------------
1 | /****************************************************************************
2 | **
3 | ** This file is part of a Qt Solutions component.
4 | **
5 | ** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
6 | **
7 | ** Contact: Qt Software Information (qt-info@nokia.com)
8 | **
9 | ** Commercial Usage
10 | ** Licensees holding valid Qt Commercial licenses may use this file in
11 | ** accordance with the Qt Solutions Commercial License Agreement provided
12 | ** with the Software or, alternatively, in accordance with the terms
13 | ** contained in a written agreement between you and Nokia.
14 | **
15 | ** GNU Lesser General Public License Usage
16 | ** Alternatively, this file may be used under the terms of the GNU Lesser
17 | ** General Public License version 2.1 as published by the Free Software
18 | ** Foundation and appearing in the file LICENSE.LGPL included in the
19 | ** packaging of this file. Please review the following information to
20 | ** ensure the GNU Lesser General Public License version 2.1 requirements
21 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22 | **
23 | ** In addition, as a special exception, Nokia gives you certain
24 | ** additional rights. These rights are described in the Nokia Qt LGPL
25 | ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26 | ** package.
27 | **
28 | ** GNU General Public License Usage
29 | ** Alternatively, this file may be used under the terms of the GNU
30 | ** General Public License version 3.0 as published by the Free Software
31 | ** Foundation and appearing in the file LICENSE.GPL included in the
32 | ** packaging of this file. Please review the following information to
33 | ** ensure the GNU General Public License version 3.0 requirements will be
34 | ** met: http://www.gnu.org/copyleft/gpl.html.
35 | **
36 | ** Please note Third Party Software included with Qt Solutions may impose
37 | ** additional restrictions and it is the user's responsibility to ensure
38 | ** that they have met the licensing requirements of the GPL, LGPL, or Qt
39 | ** Solutions Commercial license and the relevant license of the Third
40 | ** Party Software they are using.
41 | **
42 | ** If you are unsure which license is appropriate for your use, please
43 | ** contact the sales department at qt-sales@nokia.com.
44 | **
45 | ****************************************************************************/
46 |
47 | #include "qttelnet.h"
48 | #include
49 | #include
50 | #include
51 | #include
52 | #include
53 | #include
54 | #include
55 | #include
56 | #include
57 | #include
58 | #include
59 | #include
60 | #include
61 | #include
62 |
63 | class LoginDialog : public QDialog
64 | {
65 | public:
66 | LoginDialog(QWidget *parent = 0)
67 | : QDialog(parent)
68 | {
69 | QGridLayout *gl = new QGridLayout;
70 | setLayout(gl);
71 |
72 | QLabel *l;
73 |
74 | l = new QLabel("&Login:", this);
75 | gl->addWidget(l, 0, 0);
76 | lle = new QLineEdit(this);
77 | gl->addWidget(lle, 0, 1);
78 | l->setBuddy(lle);
79 |
80 | l = new QLabel("&Password:", this);
81 | gl->addWidget(l, 1, 0);
82 | ple = new QLineEdit(this);
83 | ple->setEchoMode(QLineEdit::Password);
84 | gl->addWidget(ple, 1, 1);
85 | l->setBuddy(ple);
86 |
87 | QWidget *hbox = new QWidget(this);
88 | QHBoxLayout *hboxlayout = new QHBoxLayout;
89 |
90 | gl->addWidget(hbox, 2, 0, 1, 2);
91 |
92 | QPushButton *pb;
93 | pb = new QPushButton("&Ok");
94 | connect(pb, SIGNAL(clicked()), this, SLOT(accept()));
95 | hboxlayout->addWidget(pb);
96 |
97 | pb = new QPushButton("&Cancel");
98 | connect(pb, SIGNAL(clicked()), this, SLOT(reject()));
99 | hboxlayout->addWidget(pb);
100 |
101 | hbox->setLayout(hboxlayout);
102 | }
103 |
104 | QString login() const { return lle->text(); }
105 | QString password() const { return ple->text(); }
106 |
107 | private:
108 | QLineEdit *lle, *ple;
109 | };
110 |
111 | class TelnetClient : public QMainWindow
112 | {
113 | Q_OBJECT
114 | public:
115 | TelnetClient(QWidget *par = 0)
116 | : QMainWindow(par), t(new QtTelnet)
117 | {
118 | //t->setPromptString("Welcome");
119 |
120 | QWidget *vbox = new QWidget(this);
121 | QVBoxLayout *vboxlayout = new QVBoxLayout();
122 |
123 | textEdit = new QTextEdit();
124 | lineEdit = new QLineEdit();
125 | status = new QLabel();
126 | quit = new QPushButton("Quit");
127 | connect(quit, SIGNAL(clicked()), this, SLOT(close()));
128 |
129 | vboxlayout->addWidget(textEdit);
130 | vboxlayout->addWidget(lineEdit);
131 | vboxlayout->addWidget(status);
132 | vboxlayout->addWidget(quit);
133 | vbox->setLayout(vboxlayout);
134 | setCentralWidget(vbox);
135 |
136 | QFont fnt = textEdit->font();
137 | fnt.setFamily("Fixed");
138 | textEdit->setFont(fnt);
139 |
140 | lineEdit->installEventFilter(this);
141 | installEventFilter(this);
142 |
143 | QShortcut *shortcut;
144 |
145 | shortcut = new QShortcut(this);
146 | shortcut->setKey(Qt::CTRL + Qt::Key_D);
147 | connect(shortcut, SIGNAL(activated()),
148 | this, SLOT(deleteCharOrLogout()));
149 |
150 | shortcut = new QShortcut(this);
151 | shortcut->setKey(Qt::CTRL + Qt::Key_Z);
152 | connect(shortcut, SIGNAL(activated()), this, SLOT(suspend()));
153 |
154 | shortcut = new QShortcut(this);
155 | shortcut->setKey(Qt::CTRL + Qt::Key_C);
156 | connect(shortcut, SIGNAL(activated()), this, SLOT(kill()));
157 |
158 | textEdit->setReadOnly(true);
159 |
160 | connect(lineEdit, SIGNAL(returnPressed()),
161 | this, SLOT(lineReturnPressed()));
162 |
163 | connect(t, SIGNAL(message(const QString &)),
164 | this, SLOT(telnetMessage(const QString &)));
165 | connect(t, SIGNAL(loginRequired()),
166 | this, SLOT(telnetLoginRequired()));
167 | connect(t, SIGNAL(loginFailed()),
168 | this, SLOT(telnetLoginFailed()));
169 | connect(t, SIGNAL(loggedOut()),
170 | this, SLOT(telnetLoggedOut()));
171 | connect(t, SIGNAL(loggedIn()),
172 | this, SLOT(telnetLoggedIn()));
173 | connect(t, SIGNAL(connectionError(QAbstractSocket::SocketError)),
174 | this, SLOT(telnetConnectionError(QAbstractSocket::SocketError)));
175 |
176 | QString host = QInputDialog::getText(this,
177 | "Host name",
178 | "Host name of Telnet server",
179 | QLineEdit::Normal,
180 | "localhost");
181 | host = host.trimmed();
182 | if (!host.isEmpty())
183 | t->connectToHost(host);
184 | else
185 | textEdit->setPlainText("Not connected");
186 | }
187 |
188 | protected:
189 | void resizeEvent(QResizeEvent *ev)
190 | {
191 | QFontMetrics fm(font());
192 | int lh = fm.lineSpacing();
193 | int cw = fm.width(QChar('X'));
194 | QRect r = textEdit->visibleRegion().boundingRect();
195 | int dx = ev->oldSize().width() - r.width();
196 | int dy = ev->oldSize().height() - r.height();
197 |
198 | t->setWindowSize((ev->size().width() - dx) / cw,
199 | (ev->size().height() - dy) / lh);
200 | }
201 | bool eventFilter(QObject *obj, QEvent *event)
202 | {
203 | if (event->type() == QEvent::ShortcutOverride) {
204 | QKeyEvent *ke = static_cast(event);
205 | if (ke->modifiers() & Qt::ControlModifier) {
206 | switch (ke->key()) {
207 | case Qt::Key_C:
208 | case Qt::Key_D:
209 | case Qt::Key_Z:
210 | return true;
211 | default:
212 | break;
213 | }
214 | }
215 | }
216 | return QObject::eventFilter(obj, event);
217 | }
218 |
219 | private slots:
220 | void telnetMessage(const QString &msg)
221 | {
222 | textEdit->append(stripCR(msg));
223 | QScrollBar *s = textEdit->verticalScrollBar();
224 | s->setValue(s->maximum());
225 | }
226 | void telnetLoginRequired()
227 | {
228 | LoginDialog ld(this);
229 | if (ld.exec() == LoginDialog::Accepted)
230 | t->login(ld.login(), ld.password());
231 | else
232 | t->logout();
233 | }
234 | void telnetLoginFailed()
235 | {
236 | status->setText("Login failed");
237 | }
238 | void telnetLoggedOut()
239 | {
240 | lineEdit->setEnabled(false);
241 | status->setText("Logged out");
242 | }
243 | void telnetLoggedIn()
244 | {
245 | lineEdit->setEnabled(true);
246 | status->setText("Logged in");
247 | }
248 | void telnetConnectionError(QAbstractSocket::SocketError error)
249 | {
250 | status->setText(QString("Connection error: %1").arg(error));
251 | }
252 | void suspend()
253 | {
254 | t->sendControl(QtTelnet::Suspend);
255 | }
256 | void kill()
257 | {
258 | t->sendControl(QtTelnet::InterruptProcess);
259 | }
260 | void lineReturnPressed()
261 | {
262 | t->sendData(lineEdit->text()+QString("\r\n"));
263 | lineEdit->clear();
264 | }
265 | void deleteCharOrLogout()
266 | {
267 | if (lineEdit->text().isEmpty()) {
268 | t->logout();
269 | } else {
270 | int cpos = lineEdit->cursorPosition();
271 | QString txt = lineEdit->text();
272 | if (cpos < (int)txt.length()) {
273 | lineEdit->setText(txt.remove(cpos, 1));
274 | lineEdit->setCursorPosition(cpos);
275 | }
276 | }
277 | }
278 |
279 | private:
280 | QString stripCR(const QString &msg)
281 | {
282 | QString nmsg(msg);
283 | nmsg.remove('\r');
284 | nmsg.remove(QRegExp("\033\\[[0-9;]*[A-Za-z]")); // Also remove terminal control codes
285 | return nmsg;
286 | }
287 |
288 | private:
289 | QtTelnet *t;
290 | QTextEdit *textEdit;
291 | QLineEdit *lineEdit;
292 | QLabel *status;
293 | QPushButton *quit;
294 | };
295 |
296 | int main( int argc, char **argv )
297 | {
298 | QApplication a(argc, argv);
299 |
300 | TelnetClient t;
301 | t.show();
302 | return a.exec();
303 | }
304 |
305 | #include "main.moc"
306 |
307 |
--------------------------------------------------------------------------------
/doc/html/qttelnet.index:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
--------------------------------------------------------------------------------
/qttelnet.pro.user:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | EnvironmentId
7 | {726dce07-67ce-4195-9f04-7a9fdd444e80}
8 |
9 |
10 | ProjectExplorer.Project.ActiveTarget
11 | 0
12 |
13 |
14 | ProjectExplorer.Project.EditorSettings
15 |
16 | true
17 | false
18 | true
19 |
20 | Cpp
21 |
22 | CppGlobal
23 |
24 |
25 |
26 | QmlJS
27 |
28 | QmlJSGlobal
29 |
30 |
31 | 2
32 | UTF-8
33 | false
34 | 4
35 | false
36 | 80
37 | true
38 | true
39 | 1
40 | true
41 | false
42 | 0
43 | true
44 | 0
45 | 8
46 | true
47 | 1
48 | true
49 | true
50 | true
51 | false
52 |
53 |
54 |
55 | ProjectExplorer.Project.PluginSettings
56 |
57 |
58 |
59 | ProjectExplorer.Project.Target.0
60 |
61 | Desktop Qt 5.3 MinGW 32bit
62 | Desktop Qt 5.3 MinGW 32bit
63 | qt.53.win32_mingw482_kit
64 | 0
65 | 0
66 | 0
67 |
68 | D:/Projects/qtelnetperso-read-only/v2/libs/solutions/build-qttelnet-Desktop_Qt_5_3_MinGW_32bit-Debug
69 |
70 |
71 | true
72 | qmake
73 |
74 | QtProjectManager.QMakeBuildStep
75 | false
76 | true
77 |
78 | false
79 |
80 |
81 | true
82 | Make
83 |
84 | Qt4ProjectManager.MakeStep
85 |
86 | false
87 |
88 |
89 |
90 | 2
91 | Build
92 |
93 | ProjectExplorer.BuildSteps.Build
94 |
95 |
96 |
97 | true
98 | Make
99 |
100 | Qt4ProjectManager.MakeStep
101 |
102 | true
103 | clean
104 |
105 |
106 | 1
107 | Clean
108 |
109 | ProjectExplorer.BuildSteps.Clean
110 |
111 | 2
112 | false
113 |
114 | Debug
115 |
116 | Qt4ProjectManager.Qt4BuildConfiguration
117 | 2
118 | true
119 |
120 |
121 | D:/Projects/qtelnetperso-read-only/v2/libs/solutions/build-qttelnet-Desktop_Qt_5_3_MinGW_32bit-Release
122 |
123 |
124 | true
125 | qmake
126 |
127 | QtProjectManager.QMakeBuildStep
128 | false
129 | true
130 |
131 | false
132 |
133 |
134 | true
135 | Make
136 |
137 | Qt4ProjectManager.MakeStep
138 |
139 | false
140 |
141 |
142 |
143 | 2
144 | Build
145 |
146 | ProjectExplorer.BuildSteps.Build
147 |
148 |
149 |
150 | true
151 | Make
152 |
153 | Qt4ProjectManager.MakeStep
154 |
155 | true
156 | clean
157 |
158 |
159 | 1
160 | Clean
161 |
162 | ProjectExplorer.BuildSteps.Clean
163 |
164 | 2
165 | false
166 |
167 | Release
168 |
169 | Qt4ProjectManager.Qt4BuildConfiguration
170 | 0
171 | true
172 |
173 | 2
174 |
175 |
176 | 0
177 | Deploy
178 |
179 | ProjectExplorer.BuildSteps.Deploy
180 |
181 | 1
182 | Deploy locally
183 |
184 | ProjectExplorer.DefaultDeployConfiguration
185 |
186 | 1
187 |
188 |
189 |
190 | false
191 | false
192 | false
193 | false
194 | true
195 | 0.01
196 | 10
197 | true
198 | 1
199 | 25
200 |
201 | 1
202 | true
203 | false
204 | true
205 | valgrind
206 |
207 | 0
208 | 1
209 | 2
210 | 3
211 | 4
212 | 5
213 | 6
214 | 7
215 | 8
216 | 9
217 | 10
218 | 11
219 | 12
220 | 13
221 | 14
222 |
223 | 2
224 |
225 | simpleClient
226 |
227 | Qt4ProjectManager.Qt4RunConfiguration:D:/Projects/qtelnetperso-read-only/v2/libs/solutions/qttelnet-2.1-opensource/examples/simpleClient/simpleClient.pro
228 |
229 | examples/simpleClient/simpleClient.pro
230 | false
231 | false
232 |
233 | 3768
234 | false
235 | true
236 | false
237 | false
238 | true
239 |
240 | 1
241 |
242 |
243 |
244 | ProjectExplorer.Project.TargetCount
245 | 1
246 |
247 |
248 | ProjectExplorer.Project.Updater.FileVersion
249 | 16
250 |
251 |
252 | Version
253 | 16
254 |
255 |
256 |
--------------------------------------------------------------------------------
/doc/html/qttelnet.html:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 | QtTelnet Class Reference
8 |
9 |
10 |
11 |
The QtTelnet class proveds an API to connect to Telnet servers, issue commands and receive replies.
86 |
When a QtTelnet object has been created, you need to call connectToHost() to establish a connection with a Telnet server. When the connection is established the connected() signal is emitted. At this point you should call login(). The QtTelnet object will emit connectionError() if the connection fails, and authenticationFailed() if the login() failed.
87 |
Once the connection has been successfully established and you've logged in you can send control messages using sendControl() and data using sendData(). Connect to the message() signal to receive data from the Telnet server. The connection is closed with close().
88 |
You can use your own socket if you call setSocket() before connecting. The socket used by QtTelnet is available from socket().
89 |
90 |
Member Type Documentation
91 |
enum QtTelnet::Control
92 |
This enum specifies control messages you can send to the Telnet server using sendControl().
93 |
94 |
Constant
Value
Description
95 |
QtTelnet::GoAhead
0
Sends the GOAHEAD control message, meaning that the server can continue to send data.
96 |
QtTelnet::InterruptProcess
1
Interrupts the current running process on the server. This is the equivalent of pressing Ctrl+C in most terminal emulators.
97 |
QtTelnet::AreYouThere
2
Sends the AREYOUTHERE control message, to check if the connection is still alive.
98 |
QtTelnet::AbortOutput
3
Temporarily suspends the output from the server. The output will resume if you send this control message again.
99 |
QtTelnet::EraseCharacter
4
Erases the last entered character.
100 |
QtTelnet::EraseLine
5
Erases the last line.
101 |
QtTelnet::Break
6
Sends the BREAK control message.
102 |
QtTelnet::EndOfFile
7
Sends the ENDOFFILE control message.
103 |
QtTelnet::Suspend
8
Suspends the current running process on the server. Equivalent to pressing Ctrl+Z in most terminal emulators.
Calling this function will make the QtTelnet object attempt to connect to a Telnet server specified by the given host and port.
122 |
The connected() signal is emitted if the connection succeeds, and the connectionError() signal is emitted if the connection fails. Once the connection is establishe you must call login().
This signal is emitted if the underlying socket implementation receives an error. The error argument is the same as being used in QSocket::connectionError()
126 |
bool QtTelnet::isValidWindowSize () const
127 |
Returns true if the window size is valid, i.e. windowSize().isValid() returns true; otherwise returns false.
This signal is emitted when you have been logged in to the server as a result of the login() command being called. Do note that you might never see this signal even if you have been logged in, due to the Telnet specification not requiring Telnet servers to notify clients when users are logged in.
This signal is emitted when the login has failed. Do note that you might in certain cases see several loginRequired() signals being emitted but no loginFailed() signals. This is due to the Telnet specification not requiring the Telnet server to support reliable authentication methods.
Sends the Telnet SYNC sequence, meaning that the Telnet server should discard any data waiting to be processed once the SYNC sequence has been received. This is sent using a TCP urgent notification.
The pattern is used to automatically recognize when the server asks for a username. If no username has been set, the loginRequired() signal will be emitted.
The pattern is used to automatically recognize when the server asks for a password. If no password has been set, the loginRequired() signal will be emitted.
The pattern is used to automatically recognize when the client has successfully logged in. When a line is read that matches the pattern, the loggedIn() signal will be emitted.
This function allows you to use your own QSocket subclass. You should call this function before calling connectToHost(); if you call it after a connection has been established the connection will be closed, so in all cases you will need to call connectToHost() after calling this function.
202 |
203 |
--------------------------------------------------------------------------------
/LICENSE.LGPL:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 2.1, February 1999
3 |
4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | [This is the first released version of the Lesser GPL. It also counts
10 | as the successor of the GNU Library Public License, version 2, hence
11 | the version number 2.1.]
12 |
13 | Preamble
14 |
15 | The licenses for most software are designed to take away your
16 | freedom to share and change it. By contrast, the GNU General Public
17 | Licenses are intended to guarantee your freedom to share and change
18 | free software--to make sure the software is free for all its users.
19 |
20 | This license, the Lesser General Public License, applies to some
21 | specially designated software packages--typically libraries--of the
22 | Free Software Foundation and other authors who decide to use it. You
23 | can use it too, but we suggest you first think carefully about whether
24 | this license or the ordinary General Public License is the better
25 | strategy to use in any particular case, based on the explanations below.
26 |
27 | When we speak of free software, we are referring to freedom of use,
28 | not price. Our General Public Licenses are designed to make sure that
29 | you have the freedom to distribute copies of free software (and charge
30 | for this service if you wish); that you receive source code or can get
31 | it if you want it; that you can change the software and use pieces of
32 | it in new free programs; and that you are informed that you can do
33 | these things.
34 |
35 | To protect your rights, we need to make restrictions that forbid
36 | distributors to deny you these rights or to ask you to surrender these
37 | rights. These restrictions translate to certain responsibilities for
38 | you if you distribute copies of the library or if you modify it.
39 |
40 | For example, if you distribute copies of the library, whether gratis
41 | or for a fee, you must give the recipients all the rights that we gave
42 | you. You must make sure that they, too, receive or can get the source
43 | code. If you link other code with the library, you must provide
44 | complete object files to the recipients, so that they can relink them
45 | with the library after making changes to the library and recompiling
46 | it. And you must show them these terms so they know their rights.
47 |
48 | We protect your rights with a two-step method: (1) we copyright the
49 | library, and (2) we offer you this license, which gives you legal
50 | permission to copy, distribute and/or modify the library.
51 |
52 | To protect each distributor, we want to make it very clear that
53 | there is no warranty for the free library. Also, if the library is
54 | modified by someone else and passed on, the recipients should know
55 | that what they have is not the original version, so that the original
56 | author's reputation will not be affected by problems that might be
57 | introduced by others.
58 |
59 | Finally, software patents pose a constant threat to the existence of
60 | any free program. We wish to make sure that a company cannot
61 | effectively restrict the users of a free program by obtaining a
62 | restrictive license from a patent holder. Therefore, we insist that
63 | any patent license obtained for a version of the library must be
64 | consistent with the full freedom of use specified in this license.
65 |
66 | Most GNU software, including some libraries, is covered by the
67 | ordinary GNU General Public License. This license, the GNU Lesser
68 | General Public License, applies to certain designated libraries, and
69 | is quite different from the ordinary General Public License. We use
70 | this license for certain libraries in order to permit linking those
71 | libraries into non-free programs.
72 |
73 | When a program is linked with a library, whether statically or using
74 | a shared library, the combination of the two is legally speaking a
75 | combined work, a derivative of the original library. The ordinary
76 | General Public License therefore permits such linking only if the
77 | entire combination fits its criteria of freedom. The Lesser General
78 | Public License permits more lax criteria for linking other code with
79 | the library.
80 |
81 | We call this license the "Lesser" General Public License because it
82 | does Less to protect the user's freedom than the ordinary General
83 | Public License. It also provides other free software developers Less
84 | of an advantage over competing non-free programs. These disadvantages
85 | are the reason we use the ordinary General Public License for many
86 | libraries. However, the Lesser license provides advantages in certain
87 | special circumstances.
88 |
89 | For example, on rare occasions, there may be a special need to
90 | encourage the widest possible use of a certain library, so that it becomes
91 | a de-facto standard. To achieve this, non-free programs must be
92 | allowed to use the library. A more frequent case is that a free
93 | library does the same job as widely used non-free libraries. In this
94 | case, there is little to gain by limiting the free library to free
95 | software only, so we use the Lesser General Public License.
96 |
97 | In other cases, permission to use a particular library in non-free
98 | programs enables a greater number of people to use a large body of
99 | free software. For example, permission to use the GNU C Library in
100 | non-free programs enables many more people to use the whole GNU
101 | operating system, as well as its variant, the GNU/Linux operating
102 | system.
103 |
104 | Although the Lesser General Public License is Less protective of the
105 | users' freedom, it does ensure that the user of a program that is
106 | linked with the Library has the freedom and the wherewithal to run
107 | that program using a modified version of the Library.
108 |
109 | The precise terms and conditions for copying, distribution and
110 | modification follow. Pay close attention to the difference between a
111 | "work based on the library" and a "work that uses the library". The
112 | former contains code derived from the library, whereas the latter must
113 | be combined with the library in order to run.
114 |
115 | GNU LESSER GENERAL PUBLIC LICENSE
116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117 |
118 | 0. This License Agreement applies to any software library or other
119 | program which contains a notice placed by the copyright holder or
120 | other authorized party saying it may be distributed under the terms of
121 | this Lesser General Public License (also called "this License").
122 | Each licensee is addressed as "you".
123 |
124 | A "library" means a collection of software functions and/or data
125 | prepared so as to be conveniently linked with application programs
126 | (which use some of those functions and data) to form executables.
127 |
128 | The "Library", below, refers to any such software library or work
129 | which has been distributed under these terms. A "work based on the
130 | Library" means either the Library or any derivative work under
131 | copyright law: that is to say, a work containing the Library or a
132 | portion of it, either verbatim or with modifications and/or translated
133 | straightforwardly into another language. (Hereinafter, translation is
134 | included without limitation in the term "modification".)
135 |
136 | "Source code" for a work means the preferred form of the work for
137 | making modifications to it. For a library, complete source code means
138 | all the source code for all modules it contains, plus any associated
139 | interface definition files, plus the scripts used to control compilation
140 | and installation of the library.
141 |
142 | Activities other than copying, distribution and modification are not
143 | covered by this License; they are outside its scope. The act of
144 | running a program using the Library is not restricted, and output from
145 | such a program is covered only if its contents constitute a work based
146 | on the Library (independent of the use of the Library in a tool for
147 | writing it). Whether that is true depends on what the Library does
148 | and what the program that uses the Library does.
149 |
150 | 1. You may copy and distribute verbatim copies of the Library's
151 | complete source code as you receive it, in any medium, provided that
152 | you conspicuously and appropriately publish on each copy an
153 | appropriate copyright notice and disclaimer of warranty; keep intact
154 | all the notices that refer to this License and to the absence of any
155 | warranty; and distribute a copy of this License along with the
156 | Library.
157 |
158 | You may charge a fee for the physical act of transferring a copy,
159 | and you may at your option offer warranty protection in exchange for a
160 | fee.
161 |
162 | 2. You may modify your copy or copies of the Library or any portion
163 | of it, thus forming a work based on the Library, and copy and
164 | distribute such modifications or work under the terms of Section 1
165 | above, provided that you also meet all of these conditions:
166 |
167 | a) The modified work must itself be a software library.
168 |
169 | b) You must cause the files modified to carry prominent notices
170 | stating that you changed the files and the date of any change.
171 |
172 | c) You must cause the whole of the work to be licensed at no
173 | charge to all third parties under the terms of this License.
174 |
175 | d) If a facility in the modified Library refers to a function or a
176 | table of data to be supplied by an application program that uses
177 | the facility, other than as an argument passed when the facility
178 | is invoked, then you must make a good faith effort to ensure that,
179 | in the event an application does not supply such function or
180 | table, the facility still operates, and performs whatever part of
181 | its purpose remains meaningful.
182 |
183 | (For example, a function in a library to compute square roots has
184 | a purpose that is entirely well-defined independent of the
185 | application. Therefore, Subsection 2d requires that any
186 | application-supplied function or table used by this function must
187 | be optional: if the application does not supply it, the square
188 | root function must still compute square roots.)
189 |
190 | These requirements apply to the modified work as a whole. If
191 | identifiable sections of that work are not derived from the Library,
192 | and can be reasonably considered independent and separate works in
193 | themselves, then this License, and its terms, do not apply to those
194 | sections when you distribute them as separate works. But when you
195 | distribute the same sections as part of a whole which is a work based
196 | on the Library, the distribution of the whole must be on the terms of
197 | this License, whose permissions for other licensees extend to the
198 | entire whole, and thus to each and every part regardless of who wrote
199 | it.
200 |
201 | Thus, it is not the intent of this section to claim rights or contest
202 | your rights to work written entirely by you; rather, the intent is to
203 | exercise the right to control the distribution of derivative or
204 | collective works based on the Library.
205 |
206 | In addition, mere aggregation of another work not based on the Library
207 | with the Library (or with a work based on the Library) on a volume of
208 | a storage or distribution medium does not bring the other work under
209 | the scope of this License.
210 |
211 | 3. You may opt to apply the terms of the ordinary GNU General Public
212 | License instead of this License to a given copy of the Library. To do
213 | this, you must alter all the notices that refer to this License, so
214 | that they refer to the ordinary GNU General Public License, version 2,
215 | instead of to this License. (If a newer version than version 2 of the
216 | ordinary GNU General Public License has appeared, then you can specify
217 | that version instead if you wish.) Do not make any other change in
218 | these notices.
219 |
220 | Once this change is made in a given copy, it is irreversible for
221 | that copy, so the ordinary GNU General Public License applies to all
222 | subsequent copies and derivative works made from that copy.
223 |
224 | This option is useful when you wish to copy part of the code of
225 | the Library into a program that is not a library.
226 |
227 | 4. You may copy and distribute the Library (or a portion or
228 | derivative of it, under Section 2) in object code or executable form
229 | under the terms of Sections 1 and 2 above provided that you accompany
230 | it with the complete corresponding machine-readable source code, which
231 | must be distributed under the terms of Sections 1 and 2 above on a
232 | medium customarily used for software interchange.
233 |
234 | If distribution of object code is made by offering access to copy
235 | from a designated place, then offering equivalent access to copy the
236 | source code from the same place satisfies the requirement to
237 | distribute the source code, even though third parties are not
238 | compelled to copy the source along with the object code.
239 |
240 | 5. A program that contains no derivative of any portion of the
241 | Library, but is designed to work with the Library by being compiled or
242 | linked with it, is called a "work that uses the Library". Such a
243 | work, in isolation, is not a derivative work of the Library, and
244 | therefore falls outside the scope of this License.
245 |
246 | However, linking a "work that uses the Library" with the Library
247 | creates an executable that is a derivative of the Library (because it
248 | contains portions of the Library), rather than a "work that uses the
249 | library". The executable is therefore covered by this License.
250 | Section 6 states terms for distribution of such executables.
251 |
252 | When a "work that uses the Library" uses material from a header file
253 | that is part of the Library, the object code for the work may be a
254 | derivative work of the Library even though the source code is not.
255 | Whether this is true is especially significant if the work can be
256 | linked without the Library, or if the work is itself a library. The
257 | threshold for this to be true is not precisely defined by law.
258 |
259 | If such an object file uses only numerical parameters, data
260 | structure layouts and accessors, and small macros and small inline
261 | functions (ten lines or less in length), then the use of the object
262 | file is unrestricted, regardless of whether it is legally a derivative
263 | work. (Executables containing this object code plus portions of the
264 | Library will still fall under Section 6.)
265 |
266 | Otherwise, if the work is a derivative of the Library, you may
267 | distribute the object code for the work under the terms of Section 6.
268 | Any executables containing that work also fall under Section 6,
269 | whether or not they are linked directly with the Library itself.
270 |
271 | 6. As an exception to the Sections above, you may also combine or
272 | link a "work that uses the Library" with the Library to produce a
273 | work containing portions of the Library, and distribute that work
274 | under terms of your choice, provided that the terms permit
275 | modification of the work for the customer's own use and reverse
276 | engineering for debugging such modifications.
277 |
278 | You must give prominent notice with each copy of the work that the
279 | Library is used in it and that the Library and its use are covered by
280 | this License. You must supply a copy of this License. If the work
281 | during execution displays copyright notices, you must include the
282 | copyright notice for the Library among them, as well as a reference
283 | directing the user to the copy of this License. Also, you must do one
284 | of these things:
285 |
286 | a) Accompany the work with the complete corresponding
287 | machine-readable source code for the Library including whatever
288 | changes were used in the work (which must be distributed under
289 | Sections 1 and 2 above); and, if the work is an executable linked
290 | with the Library, with the complete machine-readable "work that
291 | uses the Library", as object code and/or source code, so that the
292 | user can modify the Library and then relink to produce a modified
293 | executable containing the modified Library. (It is understood
294 | that the user who changes the contents of definitions files in the
295 | Library will not necessarily be able to recompile the application
296 | to use the modified definitions.)
297 |
298 | b) Use a suitable shared library mechanism for linking with the
299 | Library. A suitable mechanism is one that (1) uses at run time a
300 | copy of the library already present on the user's computer system,
301 | rather than copying library functions into the executable, and (2)
302 | will operate properly with a modified version of the library, if
303 | the user installs one, as long as the modified version is
304 | interface-compatible with the version that the work was made with.
305 |
306 | c) Accompany the work with a written offer, valid for at
307 | least three years, to give the same user the materials
308 | specified in Subsection 6a, above, for a charge no more
309 | than the cost of performing this distribution.
310 |
311 | d) If distribution of the work is made by offering access to copy
312 | from a designated place, offer equivalent access to copy the above
313 | specified materials from the same place.
314 |
315 | e) Verify that the user has already received a copy of these
316 | materials or that you have already sent this user a copy.
317 |
318 | For an executable, the required form of the "work that uses the
319 | Library" must include any data and utility programs needed for
320 | reproducing the executable from it. However, as a special exception,
321 | the materials to be distributed need not include anything that is
322 | normally distributed (in either source or binary form) with the major
323 | components (compiler, kernel, and so on) of the operating system on
324 | which the executable runs, unless that component itself accompanies
325 | the executable.
326 |
327 | It may happen that this requirement contradicts the license
328 | restrictions of other proprietary libraries that do not normally
329 | accompany the operating system. Such a contradiction means you cannot
330 | use both them and the Library together in an executable that you
331 | distribute.
332 |
333 | 7. You may place library facilities that are a work based on the
334 | Library side-by-side in a single library together with other library
335 | facilities not covered by this License, and distribute such a combined
336 | library, provided that the separate distribution of the work based on
337 | the Library and of the other library facilities is otherwise
338 | permitted, and provided that you do these two things:
339 |
340 | a) Accompany the combined library with a copy of the same work
341 | based on the Library, uncombined with any other library
342 | facilities. This must be distributed under the terms of the
343 | Sections above.
344 |
345 | b) Give prominent notice with the combined library of the fact
346 | that part of it is a work based on the Library, and explaining
347 | where to find the accompanying uncombined form of the same work.
348 |
349 | 8. You may not copy, modify, sublicense, link with, or distribute
350 | the Library except as expressly provided under this License. Any
351 | attempt otherwise to copy, modify, sublicense, link with, or
352 | distribute the Library is void, and will automatically terminate your
353 | rights under this License. However, parties who have received copies,
354 | or rights, from you under this License will not have their licenses
355 | terminated so long as such parties remain in full compliance.
356 |
357 | 9. You are not required to accept this License, since you have not
358 | signed it. However, nothing else grants you permission to modify or
359 | distribute the Library or its derivative works. These actions are
360 | prohibited by law if you do not accept this License. Therefore, by
361 | modifying or distributing the Library (or any work based on the
362 | Library), you indicate your acceptance of this License to do so, and
363 | all its terms and conditions for copying, distributing or modifying
364 | the Library or works based on it.
365 |
366 | 10. Each time you redistribute the Library (or any work based on the
367 | Library), the recipient automatically receives a license from the
368 | original licensor to copy, distribute, link with or modify the Library
369 | subject to these terms and conditions. You may not impose any further
370 | restrictions on the recipients' exercise of the rights granted herein.
371 | You are not responsible for enforcing compliance by third parties with
372 | this License.
373 |
374 | 11. If, as a consequence of a court judgment or allegation of patent
375 | infringement or for any other reason (not limited to patent issues),
376 | conditions are imposed on you (whether by court order, agreement or
377 | otherwise) that contradict the conditions of this License, they do not
378 | excuse you from the conditions of this License. If you cannot
379 | distribute so as to satisfy simultaneously your obligations under this
380 | License and any other pertinent obligations, then as a consequence you
381 | may not distribute the Library at all. For example, if a patent
382 | license would not permit royalty-free redistribution of the Library by
383 | all those who receive copies directly or indirectly through you, then
384 | the only way you could satisfy both it and this License would be to
385 | refrain entirely from distribution of the Library.
386 |
387 | If any portion of this section is held invalid or unenforceable under any
388 | particular circumstance, the balance of the section is intended to apply,
389 | and the section as a whole is intended to apply in other circumstances.
390 |
391 | It is not the purpose of this section to induce you to infringe any
392 | patents or other property right claims or to contest validity of any
393 | such claims; this section has the sole purpose of protecting the
394 | integrity of the free software distribution system which is
395 | implemented by public license practices. Many people have made
396 | generous contributions to the wide range of software distributed
397 | through that system in reliance on consistent application of that
398 | system; it is up to the author/donor to decide if he or she is willing
399 | to distribute software through any other system and a licensee cannot
400 | impose that choice.
401 |
402 | This section is intended to make thoroughly clear what is believed to
403 | be a consequence of the rest of this License.
404 |
405 | 12. If the distribution and/or use of the Library is restricted in
406 | certain countries either by patents or by copyrighted interfaces, the
407 | original copyright holder who places the Library under this License may add
408 | an explicit geographical distribution limitation excluding those countries,
409 | so that distribution is permitted only in or among countries not thus
410 | excluded. In such case, this License incorporates the limitation as if
411 | written in the body of this License.
412 |
413 | 13. The Free Software Foundation may publish revised and/or new
414 | versions of the Lesser General Public License from time to time.
415 | Such new versions will be similar in spirit to the present version,
416 | but may differ in detail to address new problems or concerns.
417 |
418 | Each version is given a distinguishing version number. If the Library
419 | specifies a version number of this License which applies to it and
420 | "any later version", you have the option of following the terms and
421 | conditions either of that version or of any later version published by
422 | the Free Software Foundation. If the Library does not specify a
423 | license version number, you may choose any version ever published by
424 | the Free Software Foundation.
425 |
426 | 14. If you wish to incorporate parts of the Library into other free
427 | programs whose distribution conditions are incompatible with these,
428 | write to the author to ask for permission. For software which is
429 | copyrighted by the Free Software Foundation, write to the Free
430 | Software Foundation; we sometimes make exceptions for this. Our
431 | decision will be guided by the two goals of preserving the free status
432 | of all derivatives of our free software and of promoting the sharing
433 | and reuse of software generally.
434 |
435 | NO WARRANTY
436 |
437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446 |
447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456 | DAMAGES.
457 |
458 | END OF TERMS AND CONDITIONS
459 |
460 | How to Apply These Terms to Your New Libraries
461 |
462 | If you develop a new library, and you want it to be of the greatest
463 | possible use to the public, we recommend making it free software that
464 | everyone can redistribute and change. You can do so by permitting
465 | redistribution under these terms (or, alternatively, under the terms of the
466 | ordinary General Public License).
467 |
468 | To apply these terms, attach the following notices to the library. It is
469 | safest to attach them to the start of each source file to most effectively
470 | convey the exclusion of warranty; and each file should have at least the
471 | "copyright" line and a pointer to where the full notice is found.
472 |
473 |
474 | Copyright (C)
475 |
476 | This library is free software; you can redistribute it and/or
477 | modify it under the terms of the GNU Lesser General Public
478 | License as published by the Free Software Foundation; either
479 | version 2.1 of the License, or (at your option) any later version.
480 |
481 | This library is distributed in the hope that it will be useful,
482 | but WITHOUT ANY WARRANTY; without even the implied warranty of
483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
484 | Lesser General Public License for more details.
485 |
486 | You should have received a copy of the GNU Lesser General Public
487 | License along with this library; if not, write to the Free Software
488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
489 |
490 | Also add information on how to contact you by electronic and paper mail.
491 |
492 | You should also get your employer (if you work as a programmer) or your
493 | school, if any, to sign a "copyright disclaimer" for the library, if
494 | necessary. Here is a sample; alter the names:
495 |
496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the
497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker.
498 |
499 | , 1 April 1990
500 | Ty Coon, President of Vice
501 |
502 | That's all there is to it!
503 |
504 |
505 |
--------------------------------------------------------------------------------
/LICENSE.GPL3:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/src/qttelnet.cpp:
--------------------------------------------------------------------------------
1 | /****************************************************************************
2 | **
3 | ** This file is part of a Qt Solutions component.
4 | **
5 | ** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
6 | **
7 | ** Contact: Qt Software Information (qt-info@nokia.com)
8 | **
9 | ** Commercial Usage
10 | ** Licensees holding valid Qt Commercial licenses may use this file in
11 | ** accordance with the Qt Solutions Commercial License Agreement provided
12 | ** with the Software or, alternatively, in accordance with the terms
13 | ** contained in a written agreement between you and Nokia.
14 | **
15 | ** GNU Lesser General Public License Usage
16 | ** Alternatively, this file may be used under the terms of the GNU Lesser
17 | ** General Public License version 2.1 as published by the Free Software
18 | ** Foundation and appearing in the file LICENSE.LGPL included in the
19 | ** packaging of this file. Please review the following information to
20 | ** ensure the GNU Lesser General Public License version 2.1 requirements
21 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22 | **
23 | ** In addition, as a special exception, Nokia gives you certain
24 | ** additional rights. These rights are described in the Nokia Qt LGPL
25 | ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26 | ** package.
27 | **
28 | ** GNU General Public License Usage
29 | ** Alternatively, this file may be used under the terms of the GNU
30 | ** General Public License version 3.0 as published by the Free Software
31 | ** Foundation and appearing in the file LICENSE.GPL included in the
32 | ** packaging of this file. Please review the following information to
33 | ** ensure the GNU General Public License version 3.0 requirements will be
34 | ** met: http://www.gnu.org/copyleft/gpl.html.
35 | **
36 | ** Please note Third Party Software included with Qt Solutions may impose
37 | ** additional restrictions and it is the user's responsibility to ensure
38 | ** that they have met the licensing requirements of the GPL, LGPL, or Qt
39 | ** Solutions Commercial license and the relevant license of the Third
40 | ** Party Software they are using.
41 | **
42 | ** If you are unsure which license is appropriate for your use, please
43 | ** contact the sales department at qt-sales@nokia.com.
44 | **
45 | ****************************************************************************/
46 |
47 | /*!
48 | \class QtTelnet
49 | \brief The QtTelnet class proveds an API to connect to Telnet servers,
50 | issue commands and receive replies.
51 |
52 | When a QtTelnet object has been created, you need to call
53 | connectToHost() to establish a connection with a Telnet server.
54 | When the connection is established the connected() signal is
55 | emitted. At this point you should call login(). The
56 | QtTelnet object will emit connectionError() if the connection
57 | fails, and authenticationFailed() if the login() failed.
58 |
59 | Once the connection has been successfully established and
60 | you've logged in you can send control messages using sendControl()
61 | and data using sendData(). Connect to the message() signal to
62 | receive data from the Telnet server. The connection is closed with
63 | close().
64 |
65 | You can use your own socket if you call setSocket() before
66 | connecting. The socket used by QtTelnet is available from
67 | socket().
68 | */
69 |
70 | #include "qttelnet.h"
71 | #include
72 | #include
73 | #include
74 | #include
75 | #include
76 | #include
77 | #include
78 | #include
79 |
80 |
81 | #ifdef Q_OS_WIN
82 | # include
83 | #endif
84 | #if defined (Q_OS_UNIX)
85 | # include
86 | # include
87 | # include
88 | #endif
89 |
90 | // #define QTTELNET_DEBUG
91 |
92 | #ifdef QTTELNET_DEBUG
93 | #include
94 | #endif
95 |
96 | class QtTelnetAuth
97 | {
98 | public:
99 | enum State { AuthIntermediate, AuthSuccess, AuthFailure };
100 |
101 | QtTelnetAuth(char code) : st(AuthIntermediate), cd(code) {};
102 | virtual ~QtTelnetAuth() {}
103 |
104 | int code() const { return cd; }
105 | State state() const { return st; }
106 | void setState(State state) { st = state; };
107 |
108 | virtual QByteArray authStep(const QByteArray &data) = 0;
109 |
110 | private:
111 | State st;
112 | int cd;
113 | };
114 |
115 | class QtTelnetReceiveBuffer
116 | {
117 | public:
118 | QtTelnetReceiveBuffer() : bytesAvailable(0) {}
119 | void append(const QByteArray &data) { buffers.append(data); }
120 | void push_back(const QByteArray &data) { buffers.prepend(data); }
121 | long size() const { return bytesAvailable; }
122 | QByteArray readAll()
123 | {
124 | QByteArray a;
125 | while (!buffers.isEmpty()) {
126 | a.append(buffers.takeFirst());
127 | }
128 | return a;
129 | }
130 |
131 | private:
132 | QList buffers;
133 | long bytesAvailable;
134 | };
135 |
136 | namespace Common // RFC854
137 | {
138 | // Commands
139 | const uchar CEOF = 236;
140 | const uchar SUSP = 237;
141 | const uchar ABORT = 238;
142 | const uchar SE = 240;
143 | const uchar NOP = 241;
144 | const uchar DM = 242;
145 | const uchar BRK = 243;
146 | const uchar IP = 244;
147 | const uchar AO = 245;
148 | const uchar AYT = 246;
149 | const uchar EC = 247;
150 | const uchar EL = 248;
151 | const uchar GA = 249;
152 | const uchar SB = 250;
153 | const uchar WILL = 251;
154 | const uchar WONT = 252;
155 | const uchar DO = 253;
156 | const uchar DONT = 254;
157 | const uchar IAC = 255;
158 |
159 | // Types
160 | const char IS = 0;
161 | const char SEND = 1;
162 |
163 | const char Authentication = 37; // RFC1416,
164 | // implemented to always return NULL
165 | const char SuppressGoAhead = 3; // RFC858
166 | const char Echo = 1; // RFC857, not implemented (returns WONT/DONT)
167 | const char LineMode = 34; // RFC1184, implemented
168 | const uchar LineModeEOF = 236, // RFC1184, not implemented
169 | LineModeSUSP = 237,
170 | LineModeABORT = 238;
171 | const char Status = 5; // RFC859, should be implemented!
172 | const char Logout = 18; // RFC727, implemented
173 | const char TerminalType = 24; // RFC1091,
174 | // implemented to always return UNKNOWN
175 | const char NAWS = 31; // RFC1073, implemented
176 | const char TerminalSpeed = 32; // RFC1079, not implemented
177 | const char FlowControl = 33; // RFC1372, should be implemented?
178 | const char XDisplayLocation = 35; // RFC1096, not implemented
179 | const char EnvironmentOld = 36; // RFC1408, should not be implemented!
180 | const char Environment = 39; // RFC1572, should be implemented
181 | const char Encrypt = 38; // RFC2946, not implemented
182 |
183 | #ifdef QTTELNET_DEBUG
184 | QString typeStr(char op)
185 | {
186 | QString str;
187 | switch (op) {
188 | case IS:
189 | str = "IS";
190 | break;
191 | case SEND:
192 | str = "SEND";
193 | break;
194 | default:
195 | str = QString("Unknown common type (%1)").arg(op);
196 | }
197 | return str;
198 | }
199 | QString operationStr(char op)
200 | {
201 | QString str;
202 | switch (quint8(op)) {
203 | case quint8(WILL):
204 | str = "WILL";
205 | break;
206 | case quint8(WONT):
207 | str = "WONT";
208 | break;
209 | case quint8(DO):
210 | str = "DO";
211 | break;
212 | case quint8(DONT):
213 | str = "DONT";
214 | break;
215 | case quint8(SB):
216 | str = "SB";
217 | break;
218 | default:
219 | str = QString("Unknown operation (%1)").arg(quint8(op));
220 | }
221 | return str;
222 | }
223 |
224 | QString optionStr(char op)
225 | {
226 | QString str;
227 | switch (op) {
228 | case Authentication:
229 | str = "AUTHENTICATION";
230 | break;
231 | case SuppressGoAhead:
232 | str = "SUPPRESS GO AHEAD";
233 | break;
234 | case Echo:
235 | str = "ECHO";
236 | break;
237 | case LineMode:
238 | str = "LINEMODE";
239 | break;
240 | case Status:
241 | str = "STATUS";
242 | break;
243 | case Logout:
244 | str = "LOGOUT";
245 | break;
246 | case TerminalType:
247 | str = "TERMINAL-TYPE";
248 | break;
249 | case TerminalSpeed:
250 | str = "TERMINAL-SPEED";
251 | break;
252 | case NAWS:
253 | str = "NAWS";
254 | break;
255 | case FlowControl:
256 | str = "TOGGLE-FLOW-CONTROL";
257 | break;
258 | case XDisplayLocation:
259 | str = "X-DISPLAY-LOCATION";
260 | break;
261 | case EnvironmentOld:
262 | str = "ENVIRON";
263 | break;
264 | case Environment:
265 | str = "NEW-ENVIRON";
266 | break;
267 | case Encrypt:
268 | str = "ENCRYPT";
269 | break;
270 | default:
271 | str = QString("Unknown option (%1)").arg(op);
272 | }
273 | return str;
274 | }
275 | #endif
276 | };
277 |
278 | namespace Auth // RFC1416
279 | {
280 | enum Auth
281 | {
282 | REPLY = 2,
283 | NAME
284 | };
285 | enum Types
286 | {
287 | AUTHNULL, // Can't have enum values named NULL :/
288 | KERBEROS_V4,
289 | KERBEROS_V5,
290 | SPX,
291 | SRA = 6,
292 | LOKI = 10
293 | };
294 | enum Modifiers
295 | {
296 | AUTH_WHO_MASK = 1,
297 | AUTH_CLIENT_TO_SERVER = 0,
298 | AUTH_SERVER_TO_CLIENT = 1,
299 | AUTH_HOW_MASK = 2,
300 | AUTH_HOW_ONE_WAY = 0,
301 | AUTH_HOW_MUTUAL = 2
302 | };
303 | enum SRA
304 | {
305 | SRA_KEY = 0,
306 | SRA_USER = 1,
307 | SRA_CONTINUE = 2,
308 | SRA_PASSWORD = 3,
309 | SRA_ACCEPT = 4,
310 | SRA_REJECT = 5
311 | };
312 |
313 | #ifdef QTTELNET_DEBUG
314 | QString authStr(int op)
315 | {
316 | QString str;
317 | switch (op) {
318 | case REPLY:
319 | str = "REPLY";
320 | break;
321 | case NAME:
322 | str = "NAME";
323 | break;
324 | default:
325 | str = QString("Unknown auth (%1)").arg(op);
326 | }
327 | return str;
328 | }
329 | QString typeStr(int op)
330 | {
331 | QString str;
332 | switch (op) {
333 | case AUTHNULL:
334 | str = "NULL";
335 | break;
336 | case KERBEROS_V4:
337 | str = "KERBEROS_V4";
338 | break;
339 | case KERBEROS_V5:
340 | str = "KERBEROS_V5";
341 | break;
342 | case SPX:
343 | str = "SPX";
344 | break;
345 | case SRA:
346 | str = "SRA";
347 | break;
348 | case LOKI:
349 | str = "LOKI";
350 | break;
351 | default:
352 | str = QString("Unknown auth type (%1)").arg(op);
353 | }
354 | return str;
355 | }
356 | QString whoStr(int op)
357 | {
358 | QString str;
359 | op = op & AUTH_WHO_MASK;
360 | switch (op) {
361 | case AUTH_CLIENT_TO_SERVER:
362 | str = "CLIENT";
363 | break;
364 | case AUTH_SERVER_TO_CLIENT:
365 | str = "SERVER";
366 | break;
367 | default:
368 | str = QString("Unknown who type (%1)").arg(op);
369 | }
370 | return str;
371 | }
372 | QString howStr(int op)
373 | {
374 | QString str;
375 | op = op & AUTH_HOW_MASK;
376 | switch (op) {
377 | case AUTH_HOW_ONE_WAY:
378 | str = "ONE-WAY";
379 | break;
380 | case AUTH_HOW_MUTUAL:
381 | str = "MUTUAL";
382 | break;
383 | default:
384 | str = QString("Unknown how type (%1)").arg(op);
385 | }
386 | return str;
387 | }
388 | QString sraStr(int op)
389 | {
390 | QString str;
391 | switch (op) {
392 | case SRA_KEY:
393 | str = "KEY";
394 | break;
395 | case SRA_REJECT:
396 | str = "REJECT";
397 | break;
398 | case SRA_ACCEPT:
399 | str = "ACCEPT";
400 | break;
401 | case SRA_USER:
402 | str = "USER";
403 | break;
404 | case SRA_CONTINUE:
405 | str = "CONTINUE";
406 | break;
407 | case SRA_PASSWORD:
408 | str = "PASSWORD";
409 | break;
410 | default:
411 | str = QString("Unknown SRA option (%1)").arg(op);
412 | }
413 | return str;
414 | }
415 | #endif
416 | };
417 |
418 | namespace LineMode // RFC1184
419 | {
420 | const char Mode = 1;
421 | const char ForwardMask = 2;
422 | const char SLC = 3;
423 | enum Modes
424 | {
425 | EDIT = 1,
426 | TRAPSIG = 2,
427 | MODE_ACK = 4,
428 | SOFT_TAB = 8,
429 | LIT_ECHO = 16
430 | };
431 | enum SLCs
432 | {
433 | SLC_SYNCH = 1,
434 | SLC_BRK = 2,
435 | SLC_IP = 3,
436 | SLC_AO = 4,
437 | SLC_AYT = 5,
438 | SLC_EOR = 6,
439 | SLC_ABORT = 7,
440 | SLC_EOF = 8,
441 | SLC_SUSP = 9,
442 | SLC_EC = 10,
443 | SLC_EL = 11,
444 | SLC_EW = 12,
445 | SLC_RP = 13,
446 | SLC_LNEXT = 14,
447 | SLC_XON = 15,
448 | SLC_XOFF = 16,
449 | SLC_FORW1 = 17,
450 | SLC_FORW2 = 18,
451 | SLC_MCL = 19,
452 | SLC_MCR = 20,
453 | SLC_MCWL = 21,
454 | SLC_MCWR = 22,
455 | SLC_MCBOL = 23,
456 | SLC_MCEOL = 24,
457 | SLC_INSRT = 25,
458 | SLC_OVER = 26,
459 | SLC_ECR = 27,
460 | SLC_EWR = 28,
461 | SLC_EBOL = 29,
462 | SLC_EEOL = 30,
463 | SLC_DEFAULT = 3,
464 | SLC_VALUE = 2,
465 | SLC_CANTCHANGE = 1,
466 | SLC_NOSUPPORT = 0,
467 | SLC_LEVELBITS = 3,
468 | SLC_ACK = 128,
469 | SLC_FLUSHIN = 64,
470 | SLC_FLUSHOUT = 32
471 | };
472 | };
473 |
474 | class QtTelnetAuthNull : public QtTelnetAuth
475 | {
476 | public:
477 | QtTelnetAuthNull() : QtTelnetAuth(0) {}
478 |
479 | QByteArray authStep(const QByteArray &data);
480 | };
481 |
482 | QByteArray QtTelnetAuthNull::authStep(const QByteArray &data)
483 | {
484 | Q_ASSERT(data[0] == Common::Authentication);
485 |
486 | if (data.size() < 2 || data[1] != Common::SEND)
487 | return QByteArray();
488 |
489 | char buf[8] = {Common::IAC, Common::SB, Common::Authentication,
490 | Common::IS, Auth::AUTHNULL, 0, // CLIENT|ONE-WAY
491 | Common::IAC, Common::SE};
492 | setState(AuthSuccess);
493 | return QByteArray(buf, sizeof(buf));
494 | }
495 |
496 | class QtTelnetPrivate : public QObject
497 | {
498 | Q_OBJECT
499 | public:
500 | QtTelnetPrivate(QtTelnet *parent);
501 | ~QtTelnetPrivate();
502 |
503 | QMap modes;
504 | QList< QPair > osent;
505 |
506 | QtTelnet *q;
507 | QTcpSocket *socket;
508 | QtTelnetReceiveBuffer buffer;
509 | QSocketNotifier *notifier;
510 |
511 | QSize windowSize;
512 |
513 | bool connected, nocheckp;
514 | bool triedlogin, triedpass, firsttry;
515 |
516 | QMap auths;
517 | QtTelnetAuth *curauth;
518 | bool nullauth;
519 |
520 | QRegExp loginp, passp, promptp;
521 | QString login, pass;
522 |
523 | bool allowOption(int oper, int opt);
524 | void sendOptions();
525 | void sendCommand(const QByteArray &command);
526 | void sendCommand(const char *command, int length);
527 | void sendCommand(const char operation, const char option);
528 | void sendString(const QString &str);
529 | bool replyNeeded(uchar operation, uchar option);
530 | void setMode(uchar operation, uchar option);
531 | bool alreadySent(uchar operation, uchar option);
532 | void addSent(uchar operation, uchar option);
533 | void sendWindowSize();
534 |
535 | int parsePlaintext(const QByteArray &data);
536 | int parseIAC(const QByteArray &data);
537 | bool isOperation(const uchar c);
538 | bool isCommand(const uchar c);
539 | QByteArray getSubOption(const QByteArray &data);
540 | void parseSubAuth(const QByteArray &data);
541 | void parseSubTT(const QByteArray &data);
542 | void parseSubNAWS(const QByteArray &data);
543 | uchar opposite(uchar operation, bool positive);
544 |
545 | void consume();
546 |
547 | void setSocket(QTcpSocket *socket);
548 |
549 | public slots:
550 | void socketConnected();
551 | void socketConnectionClosed();
552 | void socketReadyRead();
553 | void socketError(QAbstractSocket::SocketError error);
554 | void socketException(int);
555 | };
556 |
557 | QtTelnetPrivate::QtTelnetPrivate(QtTelnet *parent)
558 | : q(parent), socket(0), notifier(0),
559 | connected(false), nocheckp(false),
560 | triedlogin(false), triedpass(false), firsttry(true),
561 | curauth(0), nullauth(false),
562 | loginp("ogin:\\s*$"), passp("assword:\\s*$")
563 | {
564 | setSocket(new QTcpSocket(this));
565 | }
566 |
567 | QtTelnetPrivate::~QtTelnetPrivate()
568 | {
569 | delete socket;
570 | delete notifier;
571 | delete curauth;
572 | }
573 |
574 | void QtTelnetPrivate::setSocket(QTcpSocket *s)
575 | {
576 | if (socket) {
577 | q->logout();
578 | socket->flush();
579 | }
580 | delete socket;
581 | socket = s;
582 | connected = false;
583 | if (socket) {
584 | connect(socket, SIGNAL(connected()), this, SLOT(socketConnected()));
585 | connect(socket, SIGNAL(disconnected()),
586 | this, SLOT(socketConnectionClosed()));
587 | connect(socket, SIGNAL(readyRead()), this, SLOT(socketReadyRead()));
588 | connect(socket, SIGNAL(error(QAbstractSocket::SocketError)),
589 | this, SLOT(socketError(QAbstractSocket::SocketError)));
590 | }
591 | }
592 |
593 | /*
594 | Returns the opposite value of the one we pass in.
595 | */
596 | uchar QtTelnetPrivate::opposite(uchar operation, bool positive)
597 | {
598 | if (operation == Common::DO)
599 | return (positive ? Common::WILL : Common::WONT);
600 | else if (operation == Common::DONT) // Not allowed to say WILL
601 | return Common::WONT;
602 | else if (operation == Common::WILL)
603 | return (positive ? Common::DO : Common::DONT);
604 | else if (operation == Common::WONT) // Not allowed to say DO
605 | return Common::DONT;
606 | return 0;
607 | }
608 |
609 | void QtTelnetPrivate::consume()
610 | {
611 | const QByteArray data = buffer.readAll();
612 | int currpos = 0;
613 | int prevpos = -1;;
614 | while (prevpos < currpos && currpos < data.size()) {
615 | prevpos = currpos;
616 | const uchar c = uchar(data[currpos]);
617 | if (c == Common::DM)
618 | ++currpos;
619 | else if (c == Common::IAC)
620 | currpos += parseIAC(data.mid(currpos));
621 | else // Assume plain text
622 | currpos += parsePlaintext(data.mid(currpos));
623 | }
624 | if (currpos < data.size())
625 | buffer.push_back(data.mid(currpos));
626 | }
627 |
628 | bool QtTelnetPrivate::isCommand(const uchar c)
629 | {
630 | return (c == Common::DM);
631 | }
632 |
633 | bool QtTelnetPrivate::isOperation(const uchar c)
634 | {
635 | return (c == Common::WILL || c == Common::WONT
636 | || c == Common::DO ||c == Common::DONT);
637 | }
638 |
639 | QByteArray QtTelnetPrivate::getSubOption(const QByteArray &data)
640 | {
641 | Q_ASSERT(!data.isEmpty() && uchar(data[0]) == Common::IAC);
642 |
643 | if (data.size() < 4 || uchar(data[1]) != Common::SB)
644 | return QByteArray();
645 |
646 | for (int i = 2; i < data.size() - 1; ++i) {
647 | if (uchar(data[i]) == Common::IAC && uchar(data[i+1]) == Common::SE) {
648 | return data.mid(2, i-2);
649 | }
650 | }
651 | return QByteArray();
652 | }
653 |
654 | void QtTelnetPrivate::parseSubNAWS(const QByteArray &data)
655 | {
656 | Q_UNUSED(data);
657 | }
658 |
659 | void QtTelnetPrivate::parseSubTT(const QByteArray &data)
660 | {
661 | Q_ASSERT(!data.isEmpty() && data[0] == Common::TerminalType);
662 |
663 | if (data.size() < 2 || data[1] != Common::SEND)
664 | return;
665 |
666 | const char c1[4] = { Common::IAC, Common::SB,
667 | Common::TerminalType, Common::IS};
668 | sendCommand(c1, sizeof(c1));
669 | sendString("UNKNOWN");
670 | const char c2[2] = { Common::IAC, Common::SE };
671 | sendCommand(c2, sizeof(c2));
672 | }
673 |
674 | void QtTelnetPrivate::parseSubAuth(const QByteArray &data)
675 | {
676 | Q_ASSERT(data[0] == Common::Authentication);
677 |
678 | if (!curauth && data[1] == Common::SEND) {
679 | int pos = 2;
680 | while (pos < data.size() && !curauth) {
681 | curauth = auths[data[pos]];
682 | pos += 2;
683 |
684 | if (curauth) {
685 | emit q->loginRequired();
686 | break;
687 | }
688 | }
689 | if (!curauth) {
690 | curauth = new QtTelnetAuthNull;
691 | nullauth = true;
692 | if (loginp.isEmpty() && passp.isEmpty()) {
693 | // emit q->loginRequired();
694 | nocheckp = true;
695 | }
696 | }
697 | }
698 | if (curauth) {
699 | const QByteArray a = curauth->authStep(data);
700 | if (!a.isEmpty())
701 | sendCommand(a);
702 |
703 | if (curauth->state() == QtTelnetAuth::AuthFailure)
704 | emit q->loginFailed();
705 | else if (curauth->state() == QtTelnetAuth::AuthSuccess) {
706 | if (loginp.isEmpty() && passp.isEmpty())
707 | emit q->loggedIn();
708 | if (!nullauth)
709 | nocheckp = true;
710 | }
711 | }
712 | }
713 |
714 | /*
715 | returns number of bytes consumed
716 | */
717 | int QtTelnetPrivate::parseIAC(const QByteArray &data)
718 | {
719 | if (data.isEmpty())
720 | return 0;
721 |
722 | Q_ASSERT(uchar(data.at(0)) == Common::IAC);
723 |
724 | if (data.size() >= 3 && isOperation(data[1])) { // IAC, Operation, Option
725 | const uchar operation = data[1];
726 | const uchar option = data[2];
727 | if (operation == Common::WONT && option == Common::Logout) {
728 | q->close();
729 | return 3;
730 | }
731 | if (operation == Common::DONT && option == Common::Authentication) {
732 | if (loginp.isEmpty() && passp.isEmpty())
733 | emit q->loggedIn();
734 | nullauth = true;
735 | }
736 | if (replyNeeded(operation, option)) {
737 | bool allowed = allowOption(operation, option);
738 | sendCommand(opposite(operation, allowed), option);
739 | setMode(operation, option);
740 | }
741 | return 3;
742 | }
743 | if (data.size() >= 2 && isCommand(data[1])) { // IAC Command
744 | return 2;
745 | }
746 |
747 | QByteArray suboption = getSubOption(data);
748 | if (suboption.isEmpty())
749 | return 0;
750 |
751 | // IAC SB Operation SubOption [...] IAC SE
752 | switch (suboption[0]) {
753 | case Common::Authentication:
754 | parseSubAuth(suboption);
755 | break;
756 | case Common::TerminalType:
757 | parseSubTT(suboption);
758 | break;
759 | case Common::NAWS:
760 | parseSubNAWS(data);
761 | break;
762 | default:
763 | qWarning("QtTelnetPrivate::parseIAC: unknown suboption %d",
764 | quint8(suboption.at(0)));
765 | break;
766 | }
767 | return suboption.size() + 4;
768 | }
769 |
770 | int QtTelnetPrivate::parsePlaintext(const QByteArray &data)
771 | {
772 | int consumed = 0;
773 | int length = data.indexOf('\0');
774 | if (length == -1) {
775 | length = data.size();
776 | consumed = length;
777 | } else {
778 | consumed = length + 1; // + 1 for removing '\0'
779 | }
780 |
781 | QString text = QString::fromLocal8Bit(data.constData(), length);
782 |
783 | if (!nocheckp && nullauth) {
784 | if (!promptp.isEmpty() && promptp.indexIn(text) != -1) {
785 | emit q->loggedIn();
786 | nocheckp = true;
787 | }
788 | }
789 | if (!nocheckp && nullauth) {
790 | if (!loginp.isEmpty() && loginp.indexIn(text) != -1) {
791 | if (triedlogin || firsttry) {
792 | emit q->message(text); // Display the login prompt
793 | text.clear();
794 | emit q->loginRequired(); // Get a (new) login
795 | firsttry = false;
796 | }
797 | if (!triedlogin) {
798 | q->sendData(login);
799 | triedlogin = true;
800 | }
801 | }
802 | if (!passp.isEmpty() && passp.indexIn(text) != -1) {
803 | if (triedpass || firsttry) {
804 | emit q->message(text); // Display the password prompt
805 | text.clear();
806 | emit q->loginRequired(); // Get a (new) pass
807 | firsttry = false;
808 | }
809 | if (!triedpass) {
810 | q->sendData(pass);
811 | triedpass = true;
812 | // We don't have to store the password anymore
813 | pass.fill(' ');
814 | pass.resize(0);
815 | }
816 | }
817 | }
818 |
819 | if (!text.isEmpty())
820 | emit q->message(text);
821 | return consumed;
822 | }
823 |
824 | bool QtTelnetPrivate::replyNeeded(uchar operation, uchar option)
825 | {
826 | if (operation == Common::DO || operation == Common::DONT) {
827 | // RFC854 requires that we don't acknowledge
828 | // requests to enter a mode we're already in
829 | if (operation == Common::DO && modes[option])
830 | return false;
831 | if (operation == Common::DONT && !modes[option])
832 | return false;
833 | }
834 | return true;
835 | }
836 |
837 | void QtTelnetPrivate::setMode(uchar operation, uchar option)
838 | {
839 | if (operation != Common::DO && operation != Common::DONT)
840 | return;
841 |
842 | modes[option] = (operation == Common::DO);
843 | if (option == Common::NAWS && modes[Common::NAWS])
844 | sendWindowSize();
845 | }
846 |
847 | void QtTelnetPrivate::sendWindowSize()
848 | {
849 | if (!modes[Common::NAWS])
850 | return;
851 | if (!q->isValidWindowSize())
852 | return;
853 |
854 | short h = htons(windowSize.height());
855 | short w = htons(windowSize.width());
856 | const char c[9] = { Common::IAC, Common::SB, Common::NAWS,
857 | (w & 0x00ff), (w >> 8), (h & 0x00ff), (h >> 8),
858 | Common::IAC, Common::SE };
859 | sendCommand(c, sizeof(c));
860 | }
861 |
862 | void QtTelnetPrivate::addSent(uchar operation, uchar option)
863 | {
864 | osent.append(QPair(operation, option));
865 | }
866 |
867 | bool QtTelnetPrivate::alreadySent(uchar operation, uchar option)
868 | {
869 | QPair value(operation, option);
870 | if (osent.contains(value)) {
871 | osent.removeAll(value);
872 | return true;
873 | }
874 | return false;
875 | }
876 |
877 | void QtTelnetPrivate::sendString(const QString &str)
878 | {
879 | if (!connected || str.length() == 0)
880 | return;
881 |
882 | socket->write(str.toLocal8Bit());
883 | }
884 |
885 | void QtTelnetPrivate::sendCommand(const QByteArray &command)
886 | {
887 | if (!connected || command.isEmpty())
888 | return;
889 |
890 | if (command.size() == 3) {
891 | const char operation = command.at(1);
892 | const char option = command.at(2);
893 | if (alreadySent(operation, option))
894 | return;
895 | addSent(operation, option);
896 | }
897 | socket->write(command);
898 | }
899 |
900 | void QtTelnetPrivate::sendCommand(const char operation, const char option)
901 | {
902 | const char c[3] = { Common::IAC, operation, option };
903 | sendCommand(c, 3);
904 | }
905 |
906 | void QtTelnetPrivate::sendCommand(const char *command, int length)
907 | {
908 | QByteArray a(command, length);
909 | sendCommand(a);
910 | }
911 |
912 | bool QtTelnetPrivate::allowOption(int /*oper*/, int opt)
913 | {
914 | if (opt == Common::Authentication ||
915 | opt == Common::SuppressGoAhead ||
916 | opt == Common::LineMode ||
917 | opt == Common::Status ||
918 | opt == Common::Logout ||
919 | opt == Common::TerminalType)
920 | return true;
921 | if (opt == Common::NAWS && q->isValidWindowSize())
922 | return true;
923 | return false;
924 | }
925 |
926 | void QtTelnetPrivate::sendOptions()
927 | {
928 | sendCommand(Common::WILL, Common::Authentication);
929 | sendCommand(Common::DO, Common::SuppressGoAhead);
930 | sendCommand(Common::WILL, Common::LineMode);
931 | sendCommand(Common::DO, Common::Status);
932 | if (q->isValidWindowSize())
933 | sendCommand(Common::WILL, Common::NAWS);
934 | }
935 |
936 | void QtTelnetPrivate::socketConnected()
937 | {
938 | connected = true;
939 | delete notifier;
940 | notifier = new QSocketNotifier(socket->socketDescriptor(),
941 | QSocketNotifier::Exception, this);
942 | connect(notifier, SIGNAL(activated(int)),
943 | this, SLOT(socketException(int)));
944 | sendOptions();
945 | }
946 |
947 | void QtTelnetPrivate::socketException(int)
948 | {
949 | // qDebug("out-of-band data received, should handle that here!");
950 | }
951 |
952 | void QtTelnetPrivate::socketConnectionClosed()
953 | {
954 | delete notifier;
955 | notifier = 0;
956 | connected = false;
957 | emit q->loggedOut();
958 | }
959 |
960 | void QtTelnetPrivate::socketReadyRead()
961 | {
962 | buffer.append(socket->readAll());
963 | consume();
964 | }
965 |
966 | void QtTelnetPrivate::socketError(QAbstractSocket::SocketError error)
967 | {
968 | emit q->connectionError(error);
969 | }
970 |
971 | /*!
972 | \enum QtTelnet::Control
973 |
974 | This enum specifies control messages you can send to the Telnet server
975 | using sendControl().
976 |
977 | \value GoAhead Sends the \c GO \c AHEAD control message, meaning that the
978 | server can continue to send data.
979 |
980 | \value InterruptProcess Interrupts the current running process on
981 | the server. This is the equivalent of pressing \key{Ctrl+C} in most
982 | terminal emulators.
983 |
984 | \value AreYouThere Sends the \c ARE \c YOU \c THERE control
985 | message, to check if the connection is still alive.
986 |
987 | \value AbortOutput Temporarily suspends the output from the server.
988 | The output will resume if you send this control message again.
989 |
990 | \value EraseCharacter Erases the last entered character.
991 |
992 | \value EraseLine Erases the last line.
993 |
994 | \value Break Sends the \c BREAK control message.
995 |
996 | \value EndOfFile Sends the \c END \c OF \c FILE control message.
997 |
998 | \value Suspend Suspends the current running process on the server.
999 | Equivalent to pressing \key{Ctrl+Z} in most terminal emulators.
1000 |
1001 | \value Abort Sends the \c ABORT control message.
1002 |
1003 | \sa sendControl()
1004 | */
1005 |
1006 | /*!
1007 | Constructs a QtTelnet object.
1008 |
1009 | You must call connectToHost() before calling any of the other
1010 | member functions.
1011 |
1012 | The \a parent is sent to the QObject constructor.
1013 |
1014 | \sa connectToHost()
1015 | */
1016 | QtTelnet::QtTelnet(QObject *parent)
1017 | : QObject(parent), d(new QtTelnetPrivate(this))
1018 | {
1019 | }
1020 |
1021 | /*!
1022 | Destroys the QtTelnet object. This will also close
1023 | the connection to the server.
1024 |
1025 | \sa logout()
1026 | */
1027 | QtTelnet::~QtTelnet()
1028 | {
1029 | delete d;
1030 | }
1031 |
1032 | /*!
1033 | Calling this function will make the QtTelnet object attempt to
1034 | connect to a Telnet server specified by the given \a host and \a
1035 | port.
1036 |
1037 | The connected() signal is emitted if the connection
1038 | succeeds, and the connectionError() signal is emitted if the
1039 | connection fails. Once the connection is establishe you must call
1040 | login().
1041 |
1042 | \sa close()
1043 | */
1044 | void QtTelnet::connectToHost(const QString &host, quint16 port)
1045 | {
1046 | if (d->connected)
1047 | return;
1048 | d->socket->connectToHost(host, port);
1049 | }
1050 |
1051 | /*!
1052 | Closes the connection to a Telnet server.
1053 |
1054 | \sa connectToHost() login()
1055 | */
1056 | void QtTelnet::close()
1057 | {
1058 | if (!d->connected)
1059 | return;
1060 | delete d->notifier;
1061 | d->notifier = 0;
1062 | d->connected = false;
1063 | d->socket->close();
1064 | emit loggedOut();
1065 | }
1066 |
1067 | /*!
1068 | Sends the control message \a ctrl to the Telnet server the
1069 | QtTelnet object is connected to.
1070 |
1071 | \sa Control sendData() sendSync()
1072 | */
1073 | void QtTelnet::sendControl(Control ctrl)
1074 | {
1075 | bool sendsync = false;
1076 | char c;
1077 | switch (ctrl) {
1078 | case InterruptProcess: // Ctrl-C
1079 | c = Common::IP;
1080 | sendsync = true;
1081 | break;
1082 | case AbortOutput: // suspend/resume output
1083 | c = Common::AO;
1084 | sendsync = true;
1085 | break;
1086 | case Break:
1087 | c = Common::BRK;
1088 | break;
1089 | case Suspend: // Ctrl-Z
1090 | c = Common::SUSP;
1091 | break;
1092 | case EndOfFile:
1093 | c = Common::CEOF;
1094 | break;
1095 | case Abort:
1096 | c = Common::ABORT;
1097 | break;
1098 | case GoAhead:
1099 | c = Common::GA;
1100 | break;
1101 | case AreYouThere:
1102 | c = Common::AYT;
1103 | sendsync = true;
1104 | break;
1105 | case EraseCharacter:
1106 | c = Common::EC;
1107 | break;
1108 | case EraseLine:
1109 | c = Common::EL;
1110 | break;
1111 | default:
1112 | return;
1113 | }
1114 | const char command[2] = {Common::IAC, c};
1115 | d->sendCommand(command, sizeof(command));
1116 | if (sendsync)
1117 | sendSync();
1118 | }
1119 |
1120 | /*!
1121 | Sends the string \a data to the Telnet server. This is often a
1122 | command the Telnet server will execute.
1123 |
1124 | \sa sendControl()
1125 | */
1126 | void QtTelnet::sendData(const QString &data)
1127 | {
1128 | if (!d->connected)
1129 | return;
1130 |
1131 | QByteArray str = data.toLocal8Bit();
1132 | d->socket->write(str);
1133 | //d->socket->write("\r\n\0", 3);
1134 | }
1135 |
1136 | /*!
1137 | This function will log you out of the Telnet server.
1138 | You cannot send any other data after sending this command.
1139 |
1140 | \sa login() sendData() sendControl()
1141 | */
1142 | void QtTelnet::logout()
1143 | {
1144 | d->sendCommand(Common::DO, Common::Logout);
1145 | }
1146 |
1147 | /*!
1148 | Sets the client window size to \a size.
1149 |
1150 | The width and height are given in number of characters.
1151 | Non-visible clients should pass an invalid size (i.e. QSize()).
1152 |
1153 | \sa isValidWindowSize()
1154 | */
1155 | void QtTelnet::setWindowSize(const QSize &size)
1156 | {
1157 | setWindowSize(size.width(), size.height());
1158 | }
1159 |
1160 | /*!
1161 | Sets the client window size.
1162 |
1163 | The \a width and \a height are given in number of characters.
1164 |
1165 | \overload
1166 | */
1167 | void QtTelnet::setWindowSize(int width, int height)
1168 | {
1169 | bool wasvalid = isValidWindowSize();
1170 |
1171 | d->windowSize.setWidth(width);
1172 | d->windowSize.setHeight(height);
1173 |
1174 | if (wasvalid && isValidWindowSize())
1175 | d->sendWindowSize();
1176 | else if (isValidWindowSize())
1177 | d->sendCommand(Common::WILL, Common::NAWS);
1178 | else if (wasvalid)
1179 | d->sendCommand(Common::WONT, Common::NAWS);
1180 | }
1181 |
1182 | /*!
1183 | Returns the window's size. This will be an invalid size
1184 | if the Telnet server is not using the NAWS option (RFC1073).
1185 |
1186 | \sa isValidWindowSize()
1187 | */
1188 | QSize QtTelnet::windowSize() const
1189 | {
1190 | return (d->modes[Common::NAWS] ? d->windowSize : QSize());
1191 | }
1192 |
1193 | /*!
1194 | Returns true if the window size is valid, i.e.
1195 | windowSize().isValid() returns true; otherwise returns false.
1196 |
1197 | \sa setWindowSize()
1198 | */
1199 | bool QtTelnet::isValidWindowSize() const
1200 | {
1201 | return windowSize().isValid();
1202 | }
1203 |
1204 | /*!
1205 | Set the \a socket to be used in the communication.
1206 |
1207 | This function allows you to use your own QSocket subclass. You
1208 | should call this function before calling connectToHost(); if you
1209 | call it after a connection has been established the connection
1210 | will be closed, so in all cases you will need to call
1211 | connectToHost() after calling this function.
1212 |
1213 | \sa socket(), connectToHost(), logout()
1214 | */
1215 | void QtTelnet::setSocket(QTcpSocket *socket)
1216 | {
1217 | d->setSocket(socket);
1218 | }
1219 |
1220 | /*!
1221 | Returns the QTcpSocket instance used by this telnet object.
1222 |
1223 | \sa setSocket()
1224 | */
1225 | QTcpSocket *QtTelnet::socket() const
1226 | {
1227 | return d->socket;
1228 | }
1229 |
1230 | /*!
1231 | Sends the Telnet \c SYNC sequence, meaning that the Telnet server
1232 | should discard any data waiting to be processed once the \c SYNC
1233 | sequence has been received. This is sent using a TCP urgent
1234 | notification.
1235 |
1236 | \sa sendControl()
1237 | */
1238 | void QtTelnet::sendSync()
1239 | {
1240 | if (!d->connected)
1241 | return;
1242 | d->socket->flush(); // Force the socket to send all the pending data before
1243 | // sending the SYNC sequence.
1244 | int s = d->socket->socketDescriptor();
1245 | char tosend = (char)Common::DM;
1246 | ::send(s, &tosend, 1, MSG_OOB); // Send the DATA MARK as out-of-band
1247 | }
1248 |
1249 | /*!
1250 | Sets the expected shell prompt pattern.
1251 |
1252 | The \a pattern is used to automatically recognize when the client
1253 | has successfully logged in. When a line is read that matches the
1254 | \a pattern, the loggedIn() signal will be emitted.
1255 |
1256 | \sa login(), loggedIn()
1257 | */
1258 | void QtTelnet::setPromptPattern(const QRegExp &pattern)
1259 | {
1260 | d->promptp = pattern;
1261 | }
1262 |
1263 | /*!
1264 | \fn void QtTelnet::setPromptString(const QString &pattern)
1265 |
1266 | Sets the expected shell prompt to \a pattern.
1267 |
1268 | \overload
1269 | */
1270 |
1271 | /*!
1272 | Sets the expected login pattern.
1273 |
1274 | The \a pattern is used to automatically recognize when the server
1275 | asks for a username. If no username has been set, the
1276 | loginRequired() signal will be emitted.
1277 |
1278 | \sa login()
1279 | */
1280 | void QtTelnet::setLoginPattern(const QRegExp &pattern)
1281 | {
1282 | d->loginp = pattern;
1283 | }
1284 |
1285 | /*!
1286 | \fn void QtTelnet::setLoginString(const QString &login)
1287 |
1288 | Sets the expected login string to \a login.
1289 |
1290 | \overload
1291 | */
1292 |
1293 | /*!
1294 | Sets the expected password prompt pattern.
1295 |
1296 | The \a pattern is used to automatically recognize when the server
1297 | asks for a password. If no password has been set, the loginRequired()
1298 | signal will be emitted.
1299 |
1300 | \sa login()
1301 | */
1302 | void QtTelnet::setPasswordPattern(const QRegExp &pattern)
1303 | {
1304 | d->passp = pattern;
1305 | }
1306 |
1307 | /*!
1308 | \fn void QtTelnet::setPasswordString(const QString &pattern)
1309 |
1310 | Sets the expected password prompt to \a pattern.
1311 |
1312 | \overload
1313 | */
1314 |
1315 | /*!
1316 | Sets the \a username and \a password to be used when logging in to
1317 | the server.
1318 |
1319 | \sa setLoginPattern(), setPasswordPattern()
1320 | */
1321 | void QtTelnet::login(const QString &username, const QString &password)
1322 | {
1323 | d->triedpass = d->triedlogin = false;
1324 | d->login = username;
1325 | d->pass = password;
1326 | }
1327 |
1328 | /*!
1329 | \fn void QtTelnet::loginRequired()
1330 |
1331 | This signal is emitted when the QtTelnet class sees
1332 | that the Telnet server expects authentication and you
1333 | have not already called login().
1334 |
1335 | As a reply to this signal you should either call
1336 | login() or logout()
1337 |
1338 | \sa login(), logout()
1339 | */
1340 |
1341 | /*!
1342 | \fn void QtTelnet::loginFailed()
1343 |
1344 | This signal is emitted when the login has failed.
1345 | Do note that you might in certain cases see several
1346 | loginRequired() signals being emitted but no
1347 | loginFailed() signals. This is due to the Telnet
1348 | specification not requiring the Telnet server to
1349 | support reliable authentication methods.
1350 |
1351 | \sa login(), loginRequired()
1352 | */
1353 |
1354 | /*!
1355 | \fn void QtTelnet::loggedOut()
1356 |
1357 | This signal is emitted when you have called logout()
1358 | and the Telnet server has actually logged you out.
1359 |
1360 | \sa logout(), login()
1361 | */
1362 |
1363 | /*!
1364 | \fn void QtTelnet::loggedIn()
1365 |
1366 | This signal is emitted when you have been logged in
1367 | to the server as a result of the login() command
1368 | being called. Do note that you might never see this
1369 | signal even if you have been logged in, due to the
1370 | Telnet specification not requiring Telnet servers
1371 | to notify clients when users are logged in.
1372 |
1373 | \sa login(), setPromptPattern()
1374 | */
1375 |
1376 | /*!
1377 | \fn void QtTelnet::connectionError(QAbstractSocket::SocketError error)
1378 |
1379 | This signal is emitted if the underlying socket
1380 | implementation receives an error. The \a error
1381 | argument is the same as being used in
1382 | QSocket::connectionError()
1383 | */
1384 |
1385 | /*!
1386 | \fn void QtTelnet::message(const QString &data)
1387 |
1388 | This signal is emitted when the QtTelnet object
1389 | receives more \a data from the Telnet server.
1390 |
1391 | \sa sendData()
1392 | */
1393 |
1394 | #include "qttelnet.moc"
1395 |
1396 |
--------------------------------------------------------------------------------
