/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.impl.protocol.ssh;
import java.io.*;
import java.util.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.service.protocol.event.*;
/**
* Instant messaging functionality for the SSH protocol.
*
* @author Shobhit Jindal
*/
public class OperationSetBasicInstantMessagingSSHImpl
extends AbstractOperationSetBasicInstantMessaging
{
/**
* The currently valid persistent presence operation set..
*/
private OperationSetPersistentPresenceSSHImpl opSetPersPresence = null;
/**
* The currently valid file transfer operation set
*/
private OperationSetFileTransferSSHImpl fileTransfer;
/**
* The protocol provider that created us.
*/
private ProtocolProviderServiceSSHImpl parentProvider = null;
/**
* Creates an instance of this operation set keeping a reference to the
* parent protocol provider and presence operation set.
*
* @param provider The provider instance that creates us.
*/
public OperationSetBasicInstantMessagingSSHImpl(
ProtocolProviderServiceSSHImpl provider)
{
this.parentProvider = provider;
this.opSetPersPresence
= (OperationSetPersistentPresenceSSHImpl)
provider
.getOperationSet(OperationSetPersistentPresence.class);
}
@Override
public Message createMessage(String content, String contentType,
String encoding, String subject)
{
return new MessageSSHImpl(content, contentType, encoding, subject);
}
/**
* Sends the message to the destination indicated by the
* to contact. An attempt is made to re-establish the shell
* connection if the current one is invalid.
* The reply from server is sent by a seperate reader thread
*
* @param to the Contact to send message to
* @param message the Message to send.
* @throws IllegalStateException if the underlying ICQ stack is not
* registered and initialized.
* @throws IllegalArgumentException if to is not an instance
* belonging to the underlying implementation.
*/
public void sendInstantMessage(
Contact to,
Message message)
throws IllegalStateException,
IllegalArgumentException
{
if( !(to instanceof ContactSSHImpl) )
throw new IllegalArgumentException(
"The specified contact is not a SSH contact."
+ to);
ContactSSH sshContact = (ContactSSH)to;
// making sure no messages are sent and no new threads are triggered,
// until a thread trying to connect to remote server returns
if(sshContact.isConnectionInProgress())
{
deliverMessage(
createMessage("A connection attempt is in progress"),
(ContactSSHImpl)to);
return;
}
if( !parentProvider.isShellConnected(sshContact) )
{
try
{
/**
* creating a new SSH session / shell channel
* - first message
* - session is timed out
* - network problems
*/
parentProvider.connectShell(sshContact, message);
//the first message is ignored
return;
}
catch (Exception ex)
{
throw new IllegalStateException(ex.getMessage());
}
}
if(wrappedMessage(message.getContent(), sshContact))
{
fireMessageDelivered(message, to);
return;
}
try
{
sshContact.sendLine(message.getContent());
sshContact.setCommandSent(true);
}
catch (IOException ex)
{
// Closing IO Streams
sshContact.closeShellIO();
throw new IllegalStateException(ex.getMessage());
}
fireMessageDelivered(message, to);
}
/**
* Check the message for wrapped Commands
* All commands begin with /
*
* @param message from user
* @param sshContact of the remote machine
*
* @return true if the message had commands, false otherwise
*/
private boolean wrappedMessage(
String message,
ContactSSH sshContact)
{
if(message.startsWith("/upload"))
{
int firstSpace = message.indexOf(' ');
try
{
sshContact.getFileTransferOperationSet().sendFile(
sshContact,
null,
message.substring(message.indexOf(' ', firstSpace+1) + 1),
message.substring(
firstSpace+1,
message.indexOf(' ', firstSpace+1)));
}
catch (Exception e)
{
e.printStackTrace();
}
return true;
}
else if(message.startsWith("/download"))
{
int firstSpace = message.indexOf(' ');
try
{
sshContact.getFileTransferOperationSet().sendFile(
null,
sshContact,
message.substring(firstSpace+1, message.indexOf(' ',
firstSpace+1)),
message.substring(message.indexOf(' ', firstSpace+1) + 1));
}
catch(Exception e)
{
e.printStackTrace();
}
return true;
}
return false;
}
/**
* In case the to Contact corresponds to another ssh
* protocol provider registered with SIP Communicator, we deliver
* the message to them, in case the to Contact represents us, we
* fire a MessageReceivedEvent, and if to is simply
* a contact in our contact list, then we simply echo the message.
*
* @param message the Message the message to deliver.
* @param to the Contact that we should deliver the message to.
*/
void deliverMessage(
Message message,
ContactSSH to)
{
String userID = to.getAddress();
//if the user id is owr own id, then this message is being routed to us
//from another instance of the ssh provider.
if (userID.equals(this.parentProvider.getAccountID().getUserID()))
{
//check who is the provider sending the message
String sourceUserID
= to.getProtocolProvider().getAccountID().getUserID();
//check whether they are in our contact list
Contact from = opSetPersPresence.findContactByID(sourceUserID);
//and if not - add them there as volatile.
if(from == null)
{
from = opSetPersPresence.createVolatileContact(sourceUserID);
}
//and now fire the message received event.
fireMessageReceived(message, from);
}
else
{
//if userID is not our own, try an check whether another provider
//has that id and if yes - deliver the message to them.
ProtocolProviderServiceSSHImpl sshProvider
= this.opSetPersPresence.findProviderForSSHUserID(userID);
if(sshProvider != null)
{
OperationSetBasicInstantMessagingSSHImpl opSetIM
= (OperationSetBasicInstantMessagingSSHImpl)
sshProvider
.getOperationSet(
OperationSetBasicInstantMessaging.class);
opSetIM.deliverMessage(message, to);
}
else
{
//if we got here then "to" is simply someone in our contact
//list so let's just echo the message.
fireMessageReceived(message, to);
}
}
}
/**
* Notifies all registered message listeners that a message has been
* received.
*
* @param message the Message that has been received.
* @param from the Contact that message was received from.
*/
@Override
protected void fireMessageReceived(Message message, Contact from)
{
fireMessageEvent(
new MessageReceivedEvent(
message,
from,
new Date(),
((ContactSSH) from).getMessageType()));
}
/**
* Determines whether the SSH protocol provider supports
* sending and receiving offline messages.
*
* @return false
*/
public boolean isOfflineMessagingSupported()
{
return false;
}
/**
* Determines wheter the protocol supports the supplied content type
*
* @param contentType the type we want to check
* @return true if the protocol supports it and
* false otherwise.
*/
public boolean isContentTypeSupported(String contentType)
{
return MessageSSHImpl.contentType.equals(contentType);
}
}