You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
976 lines
31 KiB
976 lines
31 KiB
// //=============================================================================
|
|
//
|
|
// File : kvi_kvs_coresimplecommands_sz.cpp
|
|
// Created on Fri 31 Oct 2003 00:04:25 by Szymon Stefanek
|
|
//
|
|
// This file is part of the KVIrc IRC client distribution
|
|
// Copyright (C) 2003 Szymon Stefanek <pragma at kvirc dot net>
|
|
//
|
|
// This program is FREE software. You can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License
|
|
// as published by the Free Software Foundation; either version 2
|
|
// of the License, or (at your opinion) any later version.
|
|
//
|
|
// This program is distributed in the HOPE that it will be USEFUL,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
// See the GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, write to the Free Software Foundation,
|
|
// Inc. ,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
//
|
|
//=============================================================================
|
|
|
|
#define __KVIRC__
|
|
|
|
#include "kvi_kvs_coresimplecommands.h"
|
|
|
|
#include "kvi_kvs_popupmanager.h"
|
|
#include "kvi_kvs_script.h"
|
|
|
|
#include "kvi_ircconnection.h"
|
|
#include "kvi_console.h"
|
|
#include "kvi_locale.h"
|
|
#include "kvi_app.h"
|
|
#include "kvi_asynchronousconnectiondata.h"
|
|
#include "kvi_frame.h"
|
|
#include "kvi_netutils.h"
|
|
#include "kvi_menubar.h"
|
|
#include "kvi_userinput.h"
|
|
#include <cstdlib>
|
|
|
|
namespace KviKvsCoreSimpleCommands
|
|
{
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: say
|
|
@type:
|
|
command
|
|
@title:
|
|
say
|
|
@syntax:
|
|
say [-x] [-q] [-r=<window_id>] <text:string>
|
|
@switches:
|
|
!sw: -q | --quiet
|
|
Run quietly
|
|
!sw: -r=<window_id> | --rebind=<window_id>
|
|
Standard command rebinding switch
|
|
!sw: -x | --allow-exec
|
|
Allow the execution of commands by interpreting the leading slash in th <text>
|
|
@short:
|
|
Type text in a window
|
|
@description:
|
|
This command is more or less equivalent to typing text in the input
|
|
entry of the current window. If the -r switch is used
|
|
then the command is rebound to the window specified by <window_id>.
|
|
The main difference is that the variables and identifiers in <text>
|
|
are always parsed (when typing this happen only if the text is a command).[br]
|
|
With -x you can also use this command to execute "variable" commands too:
|
|
if <text> begins with a slash then it will be treated as a command
|
|
to be executed (after parsing the identifiers etc.).[br]
|
|
Please note that using /say -x with a <text> that isn't a constant
|
|
in the script but comes from some unidentified external source (e.g. the network)
|
|
is a potential security flaw: don't do it.
|
|
When the -x switch is not used, the text is never interpreted as command.
|
|
-q causes the command to run quietly.[br]
|
|
Please note that /say will also trigger the [event:ontextinput]OnTextInput[/event] event.
|
|
[b]Handle with care.[/b]
|
|
*/
|
|
|
|
KVSCSC(say)
|
|
{
|
|
TQString szText;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("text",KVS_PT_STRING,KVS_PF_APPENDREMAINING,szText)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
if(KVSCSC_pSwitches->find('x',"allow-exec"))
|
|
{
|
|
// allow execution of commands
|
|
if(!KviUserInput::parse(szText,KVSCSC_pWindow,__tr2qs("say: injected commandline")))
|
|
{
|
|
if(!KVSCSC_pSwitches->find('q',"quiet"))
|
|
KVSCSC_pContext->warning(__tr2qs("Say parse error: Broken command"));
|
|
}
|
|
} else {
|
|
KviUserInput::parseNonCommand(szText,KVSCSC_pWindow);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: server
|
|
@type:
|
|
command
|
|
@title:
|
|
server
|
|
@syntax:
|
|
server [switches] [<server:string> [<port:uint>]]
|
|
@keyterms:
|
|
connecting to a server
|
|
@short:
|
|
Connects to the specified server
|
|
@switches:
|
|
!sw: -b=<local address:string> | --bind-address=<local address:string>
|
|
Bind the outgoing connection to <local address>. The <local address> must be
|
|
the IP address of a local interface suitable for contacting the remote <server>:
|
|
this means that if you're going to use the -i switch, the <local address>
|
|
must be an IPV6 address.
|
|
On most systems it is also possible to use a local interface name as <local address>;
|
|
in this way the interface address can be resolved at runtime by the KVIrc network engine.
|
|
|
|
!sw: -c=<command sequence:string> | --command=<command sequence:string>
|
|
The <command sequence> will be executed just after the login operations
|
|
have been completed.
|
|
|
|
!sw: -f=<socket filter:string> | --filter=<socket filter:string>
|
|
Activates <socket filter> on the connection.
|
|
A socket filter is a plugin that can adapt the IRC protocol to other existing protocols such as OpenNap.
|
|
For plain IRC it is not needed.
|
|
|
|
!sw: -i | --ipv6
|
|
Makes the connection by using the IPV6 protocol
|
|
(if supported by the executable)
|
|
|
|
!sw: -n | --new-context
|
|
Forces the connection to be attempted in a new IRC context instead of the current one.
|
|
|
|
!sw: -p=<password:string> | --password=<password:string>
|
|
Uses <password> to login to the server (the password will be stored in the server
|
|
entry too).
|
|
|
|
!sw: -q=<nick:string> | --nickname=<nick:string>
|
|
Uses <nick> to login to the server (the nicknames will be stored in the server
|
|
entry too).
|
|
|
|
!sw: -s | --ssl
|
|
Activates the SSL support for this connection
|
|
|
|
!sw: -u | --unused-context
|
|
Forces the connection to be attempted in the first IRC context that has
|
|
no connection in progress. If all the IRC contexts have connections in progress
|
|
then a new one is created.
|
|
|
|
!sw: -l | --last
|
|
When <server> and <port> are empty use the last
|
|
@description:
|
|
Attempts a connection to the specified <server>
|
|
on the specified <port>. If no <port> is specified
|
|
the default 6667 is used. If no <server> is specified,
|
|
the currently selected server from the server list is used
|
|
unless the -l switch is passed: in this case the last server
|
|
that was used in the IRC context is re-used.
|
|
If the <server> is a valid IPV6 address, the -i switch is implied.[br]
|
|
The <server> is added to the server list (if not already
|
|
there) and set as current.[br]
|
|
[br]
|
|
If <server> is in the form "id:<some_string>" then <some_string>
|
|
is interpreted as the server's internal id (specified in the options dialog).
|
|
This is useful when you need to force kvirc to choose between multiple
|
|
server entries with the same hostname and port stored in the database.[br]
|
|
Please note that this form causes most of the switches to have no effect
|
|
since the entry in the database will override them. If no server
|
|
entry with the specified identifier is found then an error will be generated
|
|
and the connection attempt will stop.
|
|
[br]
|
|
If <server> doesn't seem to be a valid ip address or hostname (i.e. it contains no dots)
|
|
and it doesn't look to be in the form "id:<some_string>" then
|
|
it is assumed to be a network name and if such a network is found
|
|
in the server list then the best server for that network is contacted.
|
|
(KVIrc tries to guess the round-robin (random) servers first).[br]
|
|
This behaviour can be forced by adding the "net:" prefix to the <server>
|
|
(so it will work even if the network name contains a dot).[br]
|
|
[br]
|
|
The connection is attempted in the current IRC context. If there is already
|
|
a connection in progress then it is "brutally" terminated.[br]
|
|
@examples:
|
|
[example]
|
|
server irc.tin.it
|
|
server -i irc6.ircd.it
|
|
server -i ircd.stealth.net 6667
|
|
server irc.undernet.org 6665
|
|
server -n irc.openprojects.net
|
|
server -c="join #kvirc" irc.stealth.net 6665
|
|
server -b=ppp0 irc.tin.it
|
|
server undernet
|
|
server id:mybouncerwithusername1
|
|
server id:mybouncerwithusername2
|
|
server net:under.net
|
|
[/example]
|
|
*/
|
|
|
|
KVSCSC(server)
|
|
{
|
|
TQString szServer;
|
|
kvs_uint_t uPort;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("server",KVS_PT_STRING,KVS_PF_OPTIONAL,szServer)
|
|
KVSCSC_PARAMETER("port",KVS_PT_UINT,KVS_PF_OPTIONAL,uPort)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
KviConsole * console = 0;
|
|
if(KVSCSC_pSwitches->find('n',"new-context"))console = KVSCSC_pWindow->frame()->createNewConsole();
|
|
else {
|
|
if(KVSCSC_pSwitches->find('u',"unused-context"))
|
|
{
|
|
// first try the current console
|
|
console = KVSCSC_pWindow->console();
|
|
if(console)
|
|
{
|
|
// if there is a connection in progress, proceed in searching
|
|
if(console->connectionInProgress())
|
|
{
|
|
console = 0;
|
|
}
|
|
}
|
|
if(!console)
|
|
{
|
|
// yep , have to search
|
|
console = KVSCSC_pWindow->frame()->firstNotConnectedConsole();
|
|
if(!console)
|
|
{
|
|
console = KVSCSC_pWindow->frame()->createNewConsole();
|
|
}
|
|
}
|
|
} else console = KVSCSC_pWindow->console();
|
|
}
|
|
|
|
TQString szCmd,szBindAddress,szSocketFilter,szPassword,szNick;
|
|
KVSCSC_pSwitches->getAsStringIfExisting('c',"command",szCmd);
|
|
KVSCSC_pSwitches->getAsStringIfExisting('b',"bind-address",szBindAddress);
|
|
KVSCSC_pSwitches->getAsStringIfExisting('f',"filter",szSocketFilter);
|
|
KVSCSC_pSwitches->getAsStringIfExisting('p',"password",szPassword);
|
|
KVSCSC_pSwitches->getAsStringIfExisting('q',"nickname",szNick);
|
|
|
|
if(!console)
|
|
{
|
|
KVSCSC_pContext->error(__tr2qs("Couldn't find a suitable IRC context for the connection, try using -n or -u"));
|
|
return false;
|
|
}
|
|
|
|
if(szServer.isEmpty())
|
|
{
|
|
// just as hitting "connect"
|
|
if(console->connectionInProgress())
|
|
{
|
|
KVSCSC_pContext->error(__tr2qs("Another connection is already in progress in the selected IRC context"));
|
|
return false;
|
|
} else {
|
|
KviAsynchronousConnectionData * d = new KviAsynchronousConnectionData();
|
|
d->bUseLastServerInContext = KVSCSC_pSwitches->find('l',"last") != 0;
|
|
d->szCommandToExecAfterConnect = szCmd;
|
|
d->szBindAddress = szBindAddress;
|
|
d->szPass = szPassword;
|
|
d->szNick = szNick;
|
|
d->szLinkFilter = szSocketFilter;
|
|
console->context()->setAsynchronousConnectionData(d);
|
|
console->context()->connectToCurrentServer();
|
|
}
|
|
} else {
|
|
// server is not empty.
|
|
KviAsynchronousConnectionData * d = new KviAsynchronousConnectionData();
|
|
d->bUseSSL = (KVSCSC_pSwitches->find('s',"ssl") != 0);
|
|
d->szServer = szServer;
|
|
d->uPort = (kvi_u32_t)uPort;
|
|
d->szLinkFilter = szSocketFilter;
|
|
d->bPortIsOk = (uPort > 0);
|
|
#ifdef COMPILE_IPV6_SUPPORT
|
|
d->bUseIpV6 = (KVSCSC_pSwitches->find('i',"ipv6") != 0) || KviNetUtils::isValidStringIp_V6(szServer);
|
|
#else
|
|
d->bUseIpV6 = false;
|
|
#endif
|
|
d->szCommandToExecAfterConnect = szCmd;
|
|
d->szBindAddress = szBindAddress;
|
|
d->szPass = szPassword;
|
|
d->szNick = szNick;
|
|
console->context()->setAsynchronousConnectionData(d);
|
|
console->context()->beginAsynchronousConnect(0);
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: service
|
|
@type:
|
|
command
|
|
@title:
|
|
service
|
|
@syntax:
|
|
service <nickname> <reserved> <distribution> <type> <reserved> [:]<info>
|
|
@short:
|
|
Registers a new service
|
|
@description:
|
|
Registers a new IRC service: this is for IRC operators only.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
WARNING: the <info> parameter may contain spaces: in that case you MUST add the leading ':' character.[br]
|
|
*/
|
|
// RFC2921 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: setmenu
|
|
@type:
|
|
command
|
|
@title:
|
|
setmenu
|
|
@syntax:
|
|
setmenu [-q] [-i=<index:integer>] <visible_text:string> [menu_name:string]
|
|
@short:
|
|
Adds a popup menu to the menu bar
|
|
@switches:
|
|
!sw: -q | --quiet
|
|
Run quietly: do not print any warnings
|
|
!sw: -i=<index:integer> | --index=<index:integer>
|
|
Place the popup menu on the left of the existing menubar item at the specified index
|
|
@description:
|
|
Adds an [b]existing[/b] popup menu to the current frame's menu bar.[br]
|
|
<visible_text> is used as menu identification and obviously as the visible
|
|
menu bar text for the new popup.[br]
|
|
If a popup menu with the same <visible_text> already exists in the current frame
|
|
it is removed first.[br]
|
|
<visible_text> can optionally contain the "&" character to identify
|
|
the popup menu accelerator.[br]
|
|
[menu_name] , if given , must be avalid name of a popup menu created earlier
|
|
with [cmd]defpopup[/cmd] (or the script center).[br]
|
|
If [menu_name] is not given , the popup menu identified by <visible_text> is removed.[br]
|
|
If the -i switch is used , <index> is a [b]zero based index[/b] of the default
|
|
menu-bar text item: the new popup menu will be placed on the left of that default item.[br]
|
|
If -q is used , this command prints no warnings (so you can safely use it to remove
|
|
popup menus without being sure that they actually are in there).
|
|
The warning itself serves to debugging purposes for the scripter.[br]
|
|
@seealso:
|
|
[cmd]defpopup[/cmd]
|
|
@examples:
|
|
setmenu -q -i=2 Test apopup
|
|
setmenu Test
|
|
setmenu ThisDoesNotExist
|
|
setmenu -q ThisDoesNotExist
|
|
*/
|
|
|
|
KVSCSC(setmenu)
|
|
{
|
|
TQString szVisibleText,szPopupName;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("visible_text",KVS_PT_NONEMPTYSTRING,0,szVisibleText)
|
|
KVSCSC_PARAMETER("popup_name",KVS_PT_STRING,KVS_PF_OPTIONAL,szPopupName)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
if(szPopupName.isEmpty())
|
|
{
|
|
if(!(KVSCSC_pWindow->frame()->mainMenuBar()->removeMenu(szVisibleText)))
|
|
{
|
|
if(!KVSCSC_pSwitches->find('q',"quiet"))KVSCSC_pContext->warning(__tr2qs("No menu bar item with text '%Q'"),&szPopupName);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
KviKvsPopupMenu * p = KviKvsPopupManager::instance()->lookup(szPopupName);
|
|
int idx = -1;
|
|
if(KviKvsVariant * pIdx = KVSCSC_pSwitches->find('i',"index"))
|
|
{
|
|
kvs_int_t iIdx;
|
|
if(pIdx->asInteger(iIdx))
|
|
idx = iIdx;
|
|
else {
|
|
if(!KVSCSC_pSwitches->find('q',"quiet"))
|
|
KVSCSC_pContext->warning(__tr2qs("Invalid index specified: ignored"));
|
|
}
|
|
}
|
|
KVSCSC_pWindow->frame()->mainMenuBar()->removeMenu(szVisibleText);
|
|
|
|
idx = KVSCSC_pWindow->frame()->mainMenuBar()->getDefaultItemRealIndex(idx);
|
|
|
|
if(p)KVSCSC_pWindow->frame()->mainMenuBar()->addMenu(szVisibleText,p,idx);
|
|
else {
|
|
if(!KVSCSC_pSwitches->find('q',"quiet"))KVSCSC_pContext->warning(__tr2qs("The popup '%Q' is not defined"),&szPopupName);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: setreturn
|
|
@type:
|
|
command
|
|
@title:
|
|
setreturn
|
|
@syntax:
|
|
setreturn <string>
|
|
@short:
|
|
Sets the return value of the current command sequence
|
|
@description:
|
|
Sets the return value of the current command sequence to <string>.
|
|
You can call this command multiple times in a command sequence
|
|
(so in fact use it as a write-only variable).
|
|
@examples:
|
|
@seealso:
|
|
[cmd]return[/cmd]
|
|
*/
|
|
|
|
KVSCSC(setreturn)
|
|
{
|
|
if(KVSCSC_pParams->count() == 0)
|
|
{
|
|
KVSCSC_pContext->returnValue()->setNothing();
|
|
return false;
|
|
}
|
|
if(KVSCSC_pParams->count() == 1)
|
|
{
|
|
KVSCSC_pContext->returnValue()->copyFrom(*(KVSCSC_pParams->first()));
|
|
return false;
|
|
}
|
|
|
|
TQString all;
|
|
KVSCSC_pParams->allAsString(all);
|
|
KVSCSC_pContext->returnValue()->setString(all);
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: sockets
|
|
@type:
|
|
command
|
|
@title:
|
|
sockets
|
|
@syntax:
|
|
sockets [[remote server] server tqmask]
|
|
@short:
|
|
Requests the sockets info from a server
|
|
@description:
|
|
Requests the sockets information from the specified server or the current server if no [remote server] is specified.[br]
|
|
The reply can be filtered by <server tqmask>.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: squery
|
|
@type:
|
|
command
|
|
@title:
|
|
squery
|
|
@syntax:
|
|
squery <target> :<text>
|
|
@short:
|
|
Sends a message to a service
|
|
@description:
|
|
Sends a message to a service in a form similar to [cmd]privmsg[/cmd].[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: squit
|
|
@type:
|
|
command
|
|
@title:
|
|
squit
|
|
@syntax:
|
|
squit <server> [:]<comment>
|
|
@short:
|
|
Disconnects a server socket (ircops only)
|
|
@description:
|
|
Disconnects a server socket: this is for IRC operators only.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
WARNING: the <comment> parameter may contain spaces: in that case you MUST add the leading ':' character
|
|
before.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: srand
|
|
@type:
|
|
command
|
|
@title:
|
|
srand
|
|
@syntax:
|
|
srand <seed:integer>
|
|
@short:
|
|
Initializes the random number generator
|
|
@description:
|
|
Initializes the random number generator "seeding" it with
|
|
<seed> which must be an integer. If no <seed> is passed it defaults to 1.
|
|
Sequences of random numbers can be repeated by using the
|
|
same <seed> value.
|
|
@examples:
|
|
*/
|
|
|
|
KVSCSC(srand)
|
|
{
|
|
kvs_int_t iSeed;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("seed",KVS_PT_INT,KVS_PF_OPTIONAL,iSeed)
|
|
KVSCSC_PARAMETERS_END
|
|
if(KVSCSC_pParams->count() < 1)iSeed = 1;
|
|
::srand(iSeed);
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: stats
|
|
@type:
|
|
command
|
|
@title:
|
|
stats
|
|
@syntax:
|
|
stats [query [target server]]
|
|
@short:
|
|
Requests the stats info from a server
|
|
@description:
|
|
Requests the stats information from the specified server or the current server if no [target server] is specified.[br]
|
|
The query parameter is usually a letter indicating the type of the query requested: some query letters
|
|
are defined by [doc]rfc2812[/doc] and some others are server implementation dependant.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: time
|
|
@type:
|
|
command
|
|
@title:
|
|
time
|
|
@syntax:
|
|
time [target server]
|
|
@short:
|
|
Requests the current local time info from a server
|
|
@description:
|
|
Requests time information from the specified server or the current server if no [target server] is specified.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: topic
|
|
@type:
|
|
command
|
|
@title:
|
|
topic
|
|
@syntax:
|
|
topic [<channel:string> [topic text:string]]
|
|
@short:
|
|
Changes topic for the specified channel
|
|
@description:
|
|
Changes the topic for the specified <channel> to <topic text>.
|
|
If no topic is specified, the current channel topic will be returned.[br]
|
|
This command is "server based"; you will see its results only
|
|
after the server acknowledges it.[br]
|
|
This command is [doc:connection_dependant_commands]connection dependant[/doc].
|
|
@examples:
|
|
[example]
|
|
topic #kvirc KVIrc 3.4.0 has been released!
|
|
[/example]
|
|
*/
|
|
|
|
KVSCSC(topic)
|
|
{
|
|
TQString szChannel;
|
|
TQString szTopic;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("channel",KVS_PT_NONEMPTYSTRING,KVS_PF_OPTIONAL,szChannel)
|
|
KVSCSC_PARAMETER("topic",KVS_PT_STRING,KVS_PF_OPTIONAL | KVS_PF_APPENDREMAINING,szTopic)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
KVSCSC_RETQUIRE_CONNECTION
|
|
|
|
if(szChannel.isEmpty())
|
|
{
|
|
if(KVSCSC_pWindow->type() == KVI_WINDOW_TYPE_CHANNEL)
|
|
szChannel = KVSCSC_pWindow->target();
|
|
else {
|
|
KVSCSC_pContext->error(__tr2qs("No target channel specified and the current window is not a channel"));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
KviTQCString szC = KVSCSC_pConnection->encodeText(szChannel);
|
|
KviTQCString szT = KVSCSC_pConnection->encodeText(szTopic);
|
|
if(szTopic.isEmpty())
|
|
{
|
|
if(!KVSCSC_pConnection->sendFmtData("TOPIC %s",szC.data()))
|
|
return KVSCSC_pContext->warningNoIrcConnection();
|
|
} else {
|
|
if(!KVSCSC_pConnection->sendFmtData("TOPIC %s :%s",szC.data(),szT.data()))
|
|
return KVSCSC_pContext->warningNoIrcConnection();
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: trace
|
|
@type:
|
|
command
|
|
@title:
|
|
trace
|
|
@syntax:
|
|
trace <target>
|
|
@short:
|
|
Requests trace information about a specified machine in the network
|
|
@description:
|
|
Requests trace information about a specified machine in the network.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: trload
|
|
@type:
|
|
command
|
|
@title:
|
|
trload
|
|
@syntax:
|
|
trload [-v] <catalogue:string> [<catalogue_dir:string>]
|
|
@switches:
|
|
!sw: -v | --verbose
|
|
Warn if a catalogue for the current language cannot be found
|
|
@short:
|
|
Loads a translation catalogue
|
|
@description:
|
|
Loads the specified translation <catalogue> in the current user language.[br]
|
|
The translation catalogues are *.mo files compiled with the standard
|
|
msgfmt program from the gettext package.[br]
|
|
The syntax of the catalogue names is:[br]
|
|
[b]<catalogue_dir>/<catalogue>_<language>.mo[/b][br]
|
|
KVIrc looks for the catalogues in <catalogue_dir> (if specified)
|
|
and in the locale subdirectory of the global and local KVIrc directories.[br]
|
|
<language> is choose automatically by KVIrc depending on the user's locale.[br]
|
|
Catalogues MUST be in UTF8 encoding.[br]
|
|
After a translation catalogue has been loaded you can
|
|
access its strings by the means of [fnc]$tr[/fnc].[br]
|
|
This function doesn't print any warning unless -v is specified.[br]
|
|
Please note that KVIrc attempts to load the <catalogue> automatically
|
|
when $tr() is used but it looks only in [fnc]$file.localdir[/fnc]/locale/
|
|
and in [fnc]$file.globaldir[/fnc]/locale/. This command is then useful
|
|
to load catalogues that reside in different directories.[br]
|
|
[b]NOTE[/b][br]
|
|
This feature is currently work in progress: the scripting engine
|
|
is not yet fully tqunicode and thus some more exotic translations may still suffer...
|
|
@seealso:
|
|
[fnc]$tr[/fnc], [cmd]trunload[/cmd]
|
|
*/
|
|
|
|
KVSCSC(trload)
|
|
{
|
|
TQString szCatalogue,szDir;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("catalogue",KVS_PT_NONEMPTYSTRING,0,szCatalogue)
|
|
KVSCSC_PARAMETER("catalogueDir",KVS_PT_STRING,KVS_PF_OPTIONAL,szDir)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
if(!szDir.isEmpty())
|
|
{
|
|
if(KviLocale::loadCatalogue(szCatalogue,szDir))
|
|
return true;
|
|
}
|
|
|
|
g_pApp->getLocalKvircDirectory(szDir,KviApp::Locale);
|
|
|
|
if(KviLocale::loadCatalogue(szCatalogue,szDir))
|
|
return true;
|
|
|
|
g_pApp->getGlobalKvircDirectory(szDir,KviApp::Locale);
|
|
|
|
if(KviLocale::loadCatalogue(szCatalogue,szDir))
|
|
return true;
|
|
|
|
if(KVSCSC_pSwitches->find('v',"verbose"))
|
|
KVSCSC_pContext->warning(__tr2qs("No catalogue %Q for the current language found"),&szCatalogue);
|
|
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: trunload
|
|
@type:
|
|
command
|
|
@title:
|
|
trunload
|
|
@syntax:
|
|
trunload [-v] <catalogue:string>
|
|
@switches:
|
|
!sw: -v | --verbose
|
|
Warn if the specified catalogue wasn't loaded at all
|
|
@short:
|
|
Unloads a translation catalogue
|
|
@description:
|
|
Unloads a specified translation catalogue.[br]
|
|
When you no longer need the translation strings contained in the
|
|
catalogue just unload it to free memory.[br]
|
|
This command prints no warnings unload -v is used.[br]
|
|
@seealso:
|
|
[fnc]$tr[/fnc], [cmd]trload[/cmd]
|
|
*/
|
|
|
|
KVSCSC(trunload)
|
|
{
|
|
TQString szCatalogue;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("catalogue",KVS_PT_NONEMPTYSTRING,0,szCatalogue)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
if(!KviLocale::unloadCatalogue(szCatalogue))
|
|
{
|
|
if(KVSCSC_pSwitches->find('v',"verbose"))
|
|
KVSCSC_pContext->warning(__tr2qs("The catalogue %Q was not loaded"),&szCatalogue);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: unban
|
|
@type:
|
|
command
|
|
@title:
|
|
unban
|
|
@syntax:
|
|
unban <mask_list>
|
|
@short:
|
|
Unsets ban masks for the channel
|
|
@description:
|
|
Removes the ban masks specified in the <mask_list>,
|
|
which is a comma separated list of nicknames.
|
|
This command works only if executed in a channel window.
|
|
The command is translated to a set of MODE messages containing
|
|
a variable number of -b flags.
|
|
This command is [doc:connection_dependant_commands]connection dependant[/doc].
|
|
@examples:
|
|
[example]
|
|
# Unban people on the current channel (say #kvirc)
|
|
unban Maxim,Gizmo!*@*,*!root@*
|
|
# Do the same but from another window belongin to this IRC context
|
|
unban -r=[fnc]$channel[/fnc](#kvirc) Maxim,Gizmo!*@*,*!root@*
|
|
# Do the same from any window
|
|
unban -r=[fnc]$channel[/fnc](#kvirc,[fnc]$context[/fnc](irc.myirc.net,Pragma)) Maxim,Gizmo!*@*,*!root*@*
|
|
[/example]
|
|
@seealso:
|
|
[cmd]op[/cmd],
|
|
[cmd]deop[/cmd],
|
|
[cmd]voice[/cmd],
|
|
[cmd]devoice[/cmd],
|
|
[cmd]ban[/cmd]
|
|
*/
|
|
|
|
KVSCSC(unban)
|
|
{
|
|
return multipleModeCommand(__pContext,__pParams,__pSwitches,'-','b');
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: version
|
|
@type:
|
|
command
|
|
@title:
|
|
version
|
|
@syntax:
|
|
version [target server]
|
|
@short:
|
|
Requests the version of a server
|
|
@description:
|
|
Requests the version information from the specified server or the current server if no [target server] is specified.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: voice
|
|
@type:
|
|
command
|
|
@title:
|
|
voice
|
|
@syntax:
|
|
voice <nickname_list>
|
|
@short:
|
|
Sets voice flag for the specified users
|
|
@description:
|
|
Sets the voice flag for the users specified in <nickname_list>,
|
|
which is a comma separated list of nicknames.
|
|
This command works only if executed in a channel window.
|
|
The command is translated to a set of MODE messages containing
|
|
a variable number of +v flags.
|
|
This command is [doc:connection_dependant_commands]connection dependant[/doc].
|
|
@examples:
|
|
[example]
|
|
voice Pragma,Crocodile
|
|
[/example]
|
|
@seealso:
|
|
[cmd]op[/cmd], [cmd]deop[/cmd], [cmd]devoice[/cmd]
|
|
*/
|
|
|
|
KVSCSC(voice)
|
|
{
|
|
return multipleModeCommand(__pContext,__pParams,__pSwitches,'+','v');
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: warning
|
|
@type:
|
|
command
|
|
@title:
|
|
warning
|
|
@syntax:
|
|
warning <message:text>
|
|
@short:
|
|
Prints a warning message
|
|
@description:
|
|
Prints a warning message with the appropriate color and message type.
|
|
It doesn't alter the execution of the current script.
|
|
@seealso:
|
|
[cmd]error[/cmd]
|
|
*/
|
|
|
|
KVSCSC(warning)
|
|
{
|
|
TQString szAll;
|
|
KVSCSC_pParams->allAsString(szAll);
|
|
KVSCSC_pContext->warning("%Q",&szAll);
|
|
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: who
|
|
@type:
|
|
command
|
|
@title:
|
|
who
|
|
@syntax:
|
|
who {[tqmask] | [channel]}
|
|
@short:
|
|
Requests WHO information
|
|
@description:
|
|
Requests WHO information about the specified user or channel.[br]
|
|
This command is a [doc:rfc2821wrappers]RFC2821 command wrapper[/doc]; see that document for more information.[br]
|
|
*/
|
|
// RFC2821 wrapper
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: whois
|
|
@type:
|
|
command
|
|
@title:
|
|
whois
|
|
@syntax:
|
|
whois [server] <nickname>
|
|
@short:
|
|
Requests user information
|
|
@description:
|
|
Requests information about an irc user specified by <nickname>.[br]
|
|
If [server] is specified, the request is directed to that one. [server]
|
|
may be a nickname so that the request is redirected to the server that
|
|
the user with that nickname is connected to.[br]
|
|
An useful trick is to use the following syntax:[br]
|
|
whois <nickname> <nickname>[br]
|
|
This will requests information about the user <nickname> to the server that he is currently
|
|
connected to; returning the idle time among the other common information.[br]
|
|
This command is [doc:connection_dependant_commands]connection dependant[/doc].
|
|
@examples:
|
|
[example]
|
|
[comment]# Query info about Pragma[/comment]
|
|
whois Pragma
|
|
[comment]# Get the Pragma idle time[/comment]
|
|
whois Pragma Pragma
|
|
[/example]
|
|
@seealso:
|
|
[cmd]whowas[/cmd]
|
|
*/
|
|
|
|
KVSCSC(whois)
|
|
{
|
|
TQString szNick;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("nickname",KVS_PT_NONEMPTYSTRING,KVS_PF_APPENDREMAINING,szNick)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
KviTQCString szData = KVSCSC_pContext->window()->encodeText(szNick);
|
|
|
|
if(!KVSCSC_pContext->connection())return KVSCSC_pContext->warningNoIrcConnection();
|
|
if(!KVSCSC_pContext->connection()->sendFmtData("WHOIS %s",szData.data()))return KVSCSC_pContext->warningNoIrcConnection();
|
|
|
|
return true;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*
|
|
@doc: whowas
|
|
@type:
|
|
command
|
|
@title:
|
|
whowas
|
|
@syntax:
|
|
whowas <nickname>
|
|
@short:
|
|
Requests user information
|
|
@description:
|
|
Requests information about an irc user specified by <nickname>.[br]
|
|
Whowas requests "history" records. See [doc:rfc2812]RFC2812[/doc] for more info.[br]
|
|
This command is [doc:connection_dependant_commands]connection dependant[/doc].
|
|
@examples:
|
|
[example]
|
|
[comment]# Query past info about Pragma[/comment]
|
|
whowas Pragma
|
|
[/example]
|
|
@seealso:
|
|
[cmd]whois[/cmd]
|
|
*/
|
|
|
|
KVSCSC(whowas)
|
|
{
|
|
TQString szNick;
|
|
KVSCSC_PARAMETERS_BEGIN
|
|
KVSCSC_PARAMETER("nickname",KVS_PT_NONEMPTYSTRING,KVS_PF_APPENDREMAINING,szNick)
|
|
KVSCSC_PARAMETERS_END
|
|
|
|
KviTQCString szData = KVSCSC_pContext->window()->encodeText(szNick);
|
|
|
|
if(!KVSCSC_pContext->connection())return KVSCSC_pContext->warningNoIrcConnection();
|
|
if(!KVSCSC_pContext->connection()->sendFmtData("WHOWAS %s",szData.data()))return KVSCSC_pContext->warningNoIrcConnection();
|
|
|
|
return true;
|
|
}
|
|
|
|
};
|