softphoneplugin.java.svn-base

开源项目openfire的完整源程序

/**
 * $Revision: $
 * $Date: $
 *
 * Copyright (C) 2007 Jive Software. All rights reserved.
 *
 * This software is published under the terms of the GNU Lesser Public License (LGPL),
 * a copy of which is included in this distribution.
 */

package org.jivesoftware.sparkplugin;

import org.jivesoftware.sparkplugin.ui.ContactDialControl;
import org.jivesoftware.sparkplugin.ui.RegistrationStatusPanel;
import org.jivesoftware.sparkplugin.ui.TelephoneTextField;
import org.jivesoftware.sparkplugin.ui.call.SoftPhoneTabHandler;
import org.jivesoftware.spark.plugin.phone.resource.PhoneRes;
import net.java.sipmack.sip.Call;
import net.java.sipmack.sip.SipRegisterStatus;
import net.java.sipmack.sip.event.CallRejectedEvent;
import net.java.sipmack.sip.event.CallStateEvent;
import net.java.sipmack.sip.event.MessageEvent;
import net.java.sipmack.sip.event.UnknownMessageEvent;
import net.java.sipmack.softphone.SoftPhoneManager;
import net.java.sipmack.softphone.VoiceMail;
import net.java.sipmack.softphone.listeners.RegisterEvent;
import net.java.sipmack.softphone.listeners.SoftPhoneListener;
import org.jivesoftware.smack.ConnectionListener;
import org.jivesoftware.smack.Roster;
import org.jivesoftware.smack.RosterEntry;
import org.jivesoftware.spark.SparkManager;
import org.jivesoftware.spark.phone.PhoneManager;
import org.jivesoftware.spark.plugin.Plugin;
import org.jivesoftware.spark.util.SwingWorker;
import org.jivesoftware.spark.util.TaskEngine;

import javax.sip.message.Request;
import javax.swing.UIManager;

import java.awt.Color;
import java.awt.GridBagConstraints;
import java.awt.Insets;
import java.util.TimerTask;

/**
 * Title: Spark Phone
 * Description:JAIN-SIP Audio/Video phone application
 *
 * @author Thiago Rocha Camargo ([e-mail])
 *         <p/>
 *         The <code>SoftPhonePlugin</code> class build and implements a Spark SIP
 *         plugin
 * @version 1.0, 20/07/2006
 */

public class SoftPhonePlugin implements Plugin, SoftPhoneListener {

    private SoftPhoneManager softPhone;

    private ContactDialControl dialControl;

    private RegistrationStatusPanel loadingPanel;

    private boolean isRegistered;

    /**
     * Called after Spark is loaded to initialize the new plugin. Load
     * Configuration from VCard and Instantiate a SoftPhoneManager
     */
    public void initialize() {
        final SwingWorker initializeThread = new SwingWorker() {
            public Object construct() {
                PhoneManager.getInstance();
                softPhone = SoftPhoneManager.getInstance();
                return true;
            }

            public void finished() {
                if (softPhone.isPhoneEnabled()) {
                    // Add TabHandler
                    SparkManager.getChatManager().addSparkTabHandler(new SoftPhoneTabHandler());
                    initializeUI();
                }
            }
        };

        initializeThread.start();
    }

    private void initializeUI() {
        dialControl = new ContactDialControl();
        dialControl.setVisible(false);

        // Add Dial control to main window
        SparkManager.getWorkspace().add(dialControl, new GridBagConstraints(0, 2, 1, 1, 1.0, 0.0, GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(2, 4, 4, 4), 0, 0));

        // Add Loading Panel
        loadingPanel = new RegistrationStatusPanel();
        SparkManager.getWorkspace().add(loadingPanel, new GridBagConstraints(0, 3, 1, 1, 1.0, 0.0, GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(2, 4, 4, 4), 0, 0));
        loadingPanel.setVisible(false);


        softPhone.addSoftPhoneListener(this);

        SparkManager.getConnection().addConnectionListener(new ConnectionListener() {

            public void connectionClosed() {
                softPhone.handleUnregisterRequest();
            }

            public void connectionClosedOnError(Exception exception) {
                softPhone.handleUnregisterRequest();
            }

            public void reconnectingIn(int i) {
            }

            public void reconnectionSuccessful() {
                // Wait a bit before registering
                TimerTask registerTask = new TimerTask() {
                    public void run() {
                        softPhone.register();
                    }
                };

                TaskEngine.getInstance().schedule(registerTask, 15000);
            }

            public void reconnectionFailed(Exception exception) {

            }

        });
    }

    /**
     * Called when Spark is shutting down to allow for persistence of
     * information or releasing of resources. Unregister from SIP Server
     */
    public void shutdown() {
        if (softPhone.isPhoneEnabled()) {
            softPhone.getLogManager().commit();
            softPhone.handleExitRequest();
            SparkManager.getWorkspace().remove(loadingPanel);
            SparkManager.getWorkspace().remove(dialControl);
        }
    }

    /**
     * Return true if the Spark can shutdown on users request.
     *
     * @return true if Spark can shutdown on users request.
     */
    public boolean canShutDown() {
        return true;
    }

    public void uninstall() {
    }


    /**
     * Fired when a message is received
     *
     * @param evt MessageEvent
     */
    public void messageReceived(MessageEvent evt) {
        if (evt.getSource() instanceof Request) {
            Request request = (Request)evt.getSource();
            if (request.getMethod().equals(Request.NOTIFY)) {
                VoiceMail vm = new VoiceMail(evt);
                dialControl.setVoiceMailLabel(vm.getUnread());
                dialControl.setVoiceMailDescription("You have " + vm.getUnread() + " new voice mails.");
            }
        }
    }

    /**
     * Fired when an Unknow message is received
     *
     * @param evt UnknownMessageEvent
     */
    public void receivedUnknownMessage(UnknownMessageEvent evt) {

    }

    /**
     * Fired when global status of SIP Registering changed
     *
     * @param evt RegisterEvent
     */
    public void registerStatusChanged(RegisterEvent evt) {
        if (evt.getStatus() == SipRegisterStatus.Registered) {
            dialControl.setVisible(true);
            loadingPanel.setVisible(false);
            SparkManager.getWorkspace().getStatusBar().setDescriptiveText(softPhone.getSipAccount().getDisplayName());
            if (!isRegistered) {
                loadVCards();
                isRegistered = true;
            }
        }
        else if (evt.getStatus() == SipRegisterStatus.Unregistered) {
            dialControl.setVoiceMailLabel("");
            dialControl.setVisible(false);
            loadingPanel.setVisible(false);
            SparkManager.getWorkspace().getStatusBar().setDescriptiveText("");
        }
        else if (evt.getStatus() == SipRegisterStatus.Registering) {
            if (!loadingPanel.isVisible()) {
                dialControl.setVisible(false);
                loadingPanel.setVisible(true);
                loadingPanel.showRegistrationProgress();
            }
        }
        else if (evt.getStatus() == SipRegisterStatus.RegistrationFailed) {
            loadingPanel.setVisible(true);
            dialControl.setVisible(false);
            loadingPanel.showRegistrationFailed(evt);
        }
    }

    /**
     * Perform some GUI Changes when call State Changes
     */
    public void callStateChanged(CallStateEvent evt) {

    }

    /**
     * Handle invalid dialed numbers or NOT Found numbers
     *
     * @param evt the rejection Event
     */
    public void callRejectedRemotely(CallRejectedEvent evt) {
        Call call = evt.getCall();

        TelephoneTextField telephoneTextField = dialControl.getCallField();
        telephoneTextField.setForeground((Color)UIManager.get("TextField.lightforeground"));
        telephoneTextField.setText(PhoneRes.getIString("phone.invalidnumber")+":" + call.getNumber());

    }

    private void loadVCards() {
        // Load vCard information.
        final Roster roster = SparkManager.getConnection().getRoster();
        for (RosterEntry entry : roster.getEntries()) {
            SparkManager.getVCardManager().getVCardFromMemory(entry.getUser());
        }
    }

}