Рисунок 2.3 Посылка сообщения собеседнику(DFD)

2.2 Разработка спецификаций требований к программному средству

Разрабатываемое программное средство может быть использовано в соответствии со следующей диаграммой, представленной на рис. 2.1

К нему предъявляется следующая спецификация требований:

1) Программное средство должно быть разработано на платформе .NET с помощью языка программирования C# (Sharp);

2) Удобный и понятный интерфейс;

3) Минимизация используемых объемов памяти;

4) Реализовать хранение истории сообщений;

5)Реализовать возможность отправки и получения файлов;

6) Размер программного средства не должен превышать 1024 Кб.

Размещено на http://www.allbest.ru/

Размещено на http://www.allbest.ru/

Рисунок 2.3 Диаграмма вариантов использования UML

3. Разработка ПРОГРАММНОГО СРЕДСТВА

3.1 Обоснование выбора среды разработки

В качестве среды разработки была выбрана IDE Visual Studio 2010 и платформа .NET Framework, сочетающие в себе удобство переносимости и мощь объектно - ориентированного программирования.

Для разработки пользовательского интерфейса была использована платформа Windows Presentation Foundation (WPF).

Windows Presentation Foundation (WPF, кодовое название -- Avalon) -- система для построения клиентских приложений Windows с визуально привлекательными возможностями взаимодействия с пользователем, графическая (презентационная) подсистема в составе .NET Framework (начиная с версии 3.0), имеющая прямое отношение к XAML.

В основе WPF лежит векторная система визуализации, не зависящая от разрешения и созданная с расчетом на возможности современного графического оборудования. WPF предоставляет средства для создания визуального интерфейса, включая Язык XAML (Extensible Application Markup Language), элементы управления, привязку данных, макеты, двухмерную и трехмерную графику, анимацию, стили, шаблоны, документы, текст, мультимедиа и оформление [1].

Графической технологией, лежащей в основе WPF является DirectX, в отличие от Windows Forms, где используется GDI/GDI+[2]. Производительность WPF выше, чем у GDI+ за счёт использования аппаратного ускорения графики через DirectX.

XAML представляет собой XML, в котором фактически реализованы классы .NET Framework. Так же реализована модель разделения кода и дизайна, позволяющая кооперироваться программисту и дизайнеру. Кроме того, есть встроенная поддержка стилей элементов, а сами элементы легко разделить на элементы управления второго уровня, которые в свою очередь разлагаются до уровня векторных фигур и свойств/действий.

3.2 Особенности реализации

ICQ - клиент реализован на базе протокола OSCAR.

OSCAR -- открытый (с 5 марта 2008 года), но не свободный сетевой протокол, обеспечивающий обмен мгновенными и оффлайновыми текстовыми сообщениями. В данный момент используется для двух систем: AIM (компания AOL, управляемая Time Warner) и ICQ (компания Mail.Ru).

OSCAR. "Open System for Communication in Realtime" (рус. "Открытая система для общения в реальном времени") - внутреннее название проекта (в отличие от внешнего маркетингового названия) используется для определения протокола обмена мгновенными сообщениями.

FLAP - это низкоуровневый протокол передачи данных, который облегчает разработку высокоуровневых, дейтаграмно-ориентированных слоев по передачи данных. Он использует TCP-соединения между клиентами и серверами.

Байт FLAP-идентификатора всегда 0х2А. FLAP datagram sequence number - используется для выявления ошибок.

FLAP channel - это идентификатор, используемый для определения различных типов данных во FLAP-пакете, для передачи данных через один и тот же TCP-сокет. В некотором роде это аналог TCP/UPD номеров портов. В OSCAR используются пять видов каналов:

0x01 - договор о новом соединении;

0х02 - SNAC-пакет;

0х03 - ошибка FLAP-уровня;

0х04 - договор о завершении соединения;

0х05 - оставаться в сети.

Наиболее часто используется канал 0х02, так как только по нему могут передаваться SNAC-пакеты.

SNAC - это базовый модуль передачи данных между клиентом и сервером. SNAC-слой находится выше FLAP-слоя, он является содержимым поля данных FLAP-а, передается только по каналу 0х02. Формат SNAC:

Нет никакой информации о длине данных в SNAC. Она должна быть определена из заголовка FLAP-а.Флаги являются одним из главных свойств пакета данных. Например, первый бит двухбайтового флага устанавлявается, если да данного id запроса было послано более одного SPAC.

TLV (type-length-value - тип-длина-значение) - очень удобный и эффективный метод для передачи данных в организованном формате, особенно строк переменной длины. 16 бит кода типа, 16 бит значения длины данных, сами данные:

TLV-блоки могут находиться внутри SNAC-блоков, но это не обязательно. Иногда их располагают непосредственно во FLAP-поле с данными, но чаще внутри SNAC. TLV-блоков в SNAC может быть несколько. Введение этих блоков было большим прорывом, ведь стало удобно посылать несколько строк или значений различной длины одним пакетом, например как {0x0011, 0x000c, "afritz@iname.com"}.

3.3 Разработка программной архитектуры

Сам проект состоит из двух подпроектов: Core и ICQLite. Первый отвечает за базовые функции ICQ, авторизацию, передачу данных и прочую бизнес-логику. ICQLite - содержит классы и окна, используемые для построения пользовательского интерфейса.

3.3.1 Core

Основной класс - Session, представляет собой ICQ сессию. Он агрегирует в себе классы-менеджеры ConnectionManager, SSIManager, MessageManager, StatusManager, и т.д. Ниже будут рассмотрены некоторые из них. Класс содержит методы InitializeLogger, Logon, Logoff, AddBuddy, RemoveBuddy, ActivateBuddyList, SendAuthorizationRequest и многие другие (все они располагаются в папке ObjectManagers проекта), которые далее оперируют с методами менеджеров. Также в нем имеются множество событий, которые срабатывают при происхождении каких-либо действий, на которые можно назначить обработчики событий из пользовательского интерфейса для его обновления.

AuthorizationManager - отвечает за авторизацию, содержит методы LoginToService, ProcessIncomingPacket, SendAuthorizationRequest, ProcessLoginResponse и др.

ConnectionManager - класс, отвечающий за установку соединения с сервером. Содержит методы CreateNewConnection, DeregisterConnection, CreateNewChatConnection, CreateNewFileTransferConnection, RemoveChatConnection и многие другие.

Если рассмотреть подробнее методы классов-менеджеров, то можно заметить, что во многих происходит построение TLV-блоков с данными, которые потом обворачиваются в SNAC-пакеты и отправляются на сервер.

Различные SNAC-и описаны как классы в папке SNACs, также там представлены методы работы с ними.

Класс Logging отвечает за логгирование поступивших и отправленных пакетов, что намного упрощает разработку и отладку проекта.

Также имеются классы с описанием делегатов для событий и аргументов различных событий.

3.3.2 ICQLite

В данном подпроекте реализован пользовательский интерфейс приложения. В нем используется концепция событийно-ориентированного программирования. Это значит, что в коде явным образом выделяется главный цикл программы, тело которого состоит из двух основных частей: выборки события и обработки события. Понятно, что недопустимы для приложения длительные выполнения обработчиков событий, поэтому многие операции выполняются в фоновом потоке. Но тут встает проблема обновления пользовательского интерфейса результатами обработки, ведь технология WPF не позволяет изменять UI из потоков, не являющихся основным. Решение - ставить обработчики событий в очередь на выполнение главному потоку методом Dispatcher.Invoke(…).

Первое окно, видимое пользователю при запуске приложения - класса LoginWindow, в нем имеются поля для ввода номера ICQ и пароля, в нем же происходит отправка на сервер этих данных. При успешно прошедшей авторизации это окно загружает окно с контактами класса ContactListWindow, а само закрывается.

ContactListWindow отображает контакты, расформированные по группам, в виде дерева элементов. В главном меню окна имеется возможность добавить контакт - за это отвечает окно AddContactWindow. Каждый контакт из списка контактов имеет контекстное меню, в нем присутствуют опции отображения информации о контакте (AboutWindow) и удаления контакта из серверного списка контактов.

При двойном щелчке на контакте открывается окно с чатом для данного контакта. При повторном двойном щелчке на нем же - то же самое окно повторно выходит на передний план.

ChatWindow. Имееет RichTextBox для ввода текста, а сама переписка отображается выше, с датой отправки сообщения. CheckBox внизу позволяет управлять отправкой сообщения по нажатию клавиши Enter, либо по нажатию кнопки “Send”.

Если окно ChatWindow c перепиской с определенным контактом не было открыто, либо было закрыто, а этот контакт отправил сообщение пользователю, то напротив него в списке контактов отображается значок в виде сообщения, по нажатию на который он пропадает, и открывается окно с чатом.

4 ТЕСТИРОВАНИЕ ПРОГРАММНОГО СРЕДСТВА

Для данного программного средства было использовано и функциональное тестирование:

Тестовые сценарии приведены в таблице 1.

Таблица 1 - Тестовые сценарии

ЛИСТИНГ ПРОГРАММНОГО СРЕДСТВА

using System;

using System.Collections;

using System.IO;

using System.Security.Cryptography;

using System.Text;

using csammisrun.OscarLib.Utility;

namespace csammisrun.OscarLib

{

#region Logged in / out exceptions

/// <summary>

/// Thrown when an operation is requested that requires the <see cref="Session"/>

/// to be logged in

/// </summary>

public class NotLoggedInException : Exception

{

}

/// <summary>

/// Thrown when an operation is requested that requires the <see cref="Session"/>

/// to be logged out

/// </summary>

public class LoggedInException : Exception

{

private readonly string _message;

/// <summary>

/// Creates a new LoggedInException with a blank message

/// </summary>

public LoggedInException()

{

_message = "";

}

/// <summary>

/// Creates a new LoggedInException

/// </summary>

/// <param name="message">The message to be passed with the exception</param>

public LoggedInException(string message)

{

_message = message;

}

/// <summary>

/// Gets a message that describes the current exception

/// </summary>

public override string Message

{

get { return _message; }

}

}

#endregion

/// <summary>

/// The representation of an AOL Instant Messenger or ICQ session

/// </summary>

public class Session

{

private readonly OSCARIdentification _clientid = new OSCARIdentification();

private readonly string _password;

private readonly Hashtable _requestidstorage = new Hashtable();

private readonly AuthorizationManager authManager;

private readonly ChatRoomManager chatRoomManager;

private readonly ConnectionManager connectionManager;

private readonly PacketDispatcher dispatcher = new PacketDispatcher();

private readonly FamilyManager familyManager = new FamilyManager();

private readonly GraphicsManager graphicsManager;

private readonly IcqManager icqManager;

private readonly LimitManager limitManager = new LimitManager();

private readonly MessageManager messageManager;

private readonly RateClassManager rateManager;

private readonly SearchManager searchManager;

private readonly ServiceManager serviceManager;

private readonly SSIManager ssiManager;

private readonly StatusManager statusManager;

private Capabilities _caps = Capabilities.OscarLib;

private bool _loggedin;

private ushort _loginport = 5190;

private ushort _parametercount;

private PrivacySetting _privacy;

private bool _publicidletime;

private string _screenname;

/// <summary>

/// Create a new OSCAR session

/// </summary>

/// <param name="screenname">The screenname to log in</param>

/// <param name="password">The password associated with the screenname</param>

/// <exception cref="ArgumentException">Thrown when <paramref name="screenname"/> is not

/// a valid AIM or ICQ screenname.</exception>

public Session(string screenname, string password)

{

// Check to make sure the screenname is something valid

if (!ScreennameVerifier.IsValidAIM(screenname) &&

!ScreennameVerifier.IsValidICQ(screenname))

{

throw new ArgumentException(screenname + " is not a valid AIM or ICQ screenname", "screenname");

}

// Save parameter values

_screenname = screenname;

_password = password;

connectionManager = new ConnectionManager(this);

serviceManager = new ServiceManager(this);

ssiManager = new SSIManager(this);

icqManager = new IcqManager(this);

messageManager = new MessageManager(this);

statusManager = new StatusManager(this);

chatRoomManager = new ChatRoomManager(this);

graphicsManager = new GraphicsManager(this);

authManager = new AuthorizationManager(this);

searchManager = new SearchManager(this);

rateManager = new RateClassManager(this);

connectionManager.CreateNewConnection(0x0017);

// Create a default set of capabilities for this session

SetDefaultIdentification();

// Set up some default values for public properties

_publicidletime = true;

// Set initial values for internal properties

_loggedin = false;

_privacy = PrivacySetting.AllowAllUsers;

_parametercount = 0;

}

#region Public methods

/// <summary>

/// Sets the session's <see cref="ClientIdentification"/> to the AOL defaults

/// </summary>

/// <exception cref="LoggedInException">Thrown when the <see cref="Session"/> is already logged in</exception>

public void SetDefaultIdentification()

{

if (LoggedIn)

{

throw new LoggedInException("Identification cannot be changed after the session is logged in");

}

_clientid.ClientName = Constants.CLIENT_NAME;

_clientid.ClientId = Constants.CLIENT_ID;

_clientid.ClientMajor = Constants.CLIENT_MAJOR;

_clientid.ClientMinor = Constants.CLIENT_MINOR;

_clientid.ClientLesser = Constants.CLIENT_LESSER;

_clientid.ClientBuild = Constants.CLIENT_BUILD;

_clientid.ClientDistribution = Constants.CLIENT_DISTRIBUTION;

}

/// <summary>

/// Initialize the logging system

/// </summary>

/// <param name="baseDir">The directory in which to save log files</param>

/// <returns>The full logfile path</returns>

public string InitializeLogger(string baseDir)

{

// Initialize the logging system

DateTime currentTime = DateTime.Now;

string logfileName = String.Empty;

logfileName += ScreenName + "_";

logfileName += currentTime.Year.ToString("0000") + "-" + currentTime.Month.ToString("00") + "-" +

currentTime.Day.ToString("00") + "_";

logfileName += currentTime.Hour.ToString("00") + "." + currentTime.Minute.ToString("00") + "." +

currentTime.Second.ToString("00") + ".";

logfileName += currentTime.Millisecond.ToString("000") + "_";

logfileName += "OscarLib.log";

string logFilePath = Path.Combine(baseDir, logfileName);

if (!Directory.Exists(Path.GetDirectoryName(logFilePath)))

{

Directory.CreateDirectory(Path.GetDirectoryName(logFilePath));

}

Logging.sw = new StreamWriter(logFilePath);

return logFilePath;

}

/// <summary>

/// Begins the process of logging in to the OSCAR service

/// </summary>

/// <param name="loginserver">The OSCAR login server</param>

/// <param name="port">The OSCAR service port</param>

/// <remarks>

/// <para>

/// This function is non-blocking, because the login process does not happen

/// instantly. The OSCAR library will raise the <see cref="Session.LoginCompleted"/> event

/// when the login process has finished successfully.

/// </para>

/// <para>

/// The OSCAR library raises periodic status update events throughout the login process

/// via the <see cref="Session.StatusUpdate"/> event.

/// </para>

/// <para>

/// Errors may occur during the login process; if an error occurs, the OSCAR library raises

/// the <see cref="Session.ErrorMessage"/> event, and stops the remaining login sequence.

/// </para>

/// </remarks>

/// <exception cref="LoggedInException">Thrown when the <see cref="Session"/> is already logged in</exception>

public void Logon(string loginserver, int port)

{

if (LoggedIn)

{

throw new LoggedInException();

}

LoggedIn = false;

Authorization.LoginToService(loginserver, port);

OnLoginStatusUpdate("Connecting...", 0.00);

}

/// <summary>

/// Disconnects all active OSCAR connections and resets the session

/// </summary>

public void Logoff()

{

LoggedIn = false;

foreach (Connection conn in connectionManager.UniqueConnections())

{

conn.DisconnectFromServer(false);

}

}

/// <summary>

/// Adds a buddy to the client's server-side buddy list

/// </summary>

/// <param name="screenname">The screenname of the buddy to add</param>

/// <param name="parentID">The ID of the parent group of the buddy</param>

/// <param name="index">The index of the buddy in the group</param>

/// <param name="alias">The alias of the buddy ("" for none)</param>

/// <param name="email">The email address of the buddy ("" for none)</param>

/// <param name="comment">The comment to be stored for the buddy ("" for none)</param>

/// <param name="SMS">The SMS number for the buddy ("" for none)</param>

/// <param name="soundfile">The soundfile for the buddy ("" for none)</param>

/// <param name="authorziationRequired"><c>true</c> if we require authorization for this buddy, <c>false</c> otherwise</param>

///<param name="authorizationReason">The authorization reason/message that will be send to the client</param>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

/// <remarks>This function will probably not remain here; the SSI Manager will be made public</remarks>

[Obsolete(

"This method is obsolete and will be removed soon. Use the overloaded AddBuddy method without the index parameter."

)]

public void AddBuddy(string screenname, ushort parentID, int index, string alias, string email, string comment,

string SMS, string soundfile, bool authorziationRequired, string authorizationReason)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.AddBuddy(screenname, parentID, index, alias, email, SMS, comment, soundfile, authorziationRequired,

authorizationReason);

}

/// <summary>

/// Adds a buddy to the client's server-side buddy list

/// </summary>

/// <param name="screenname">The screenname of the buddy to add</param>

/// <param name="parentID">The ID of the parent group of the buddy</param>

/// <param name="alias">The alias of the buddy ("" for none)</param>

/// <param name="email">The email address of the buddy ("" for none)</param>

/// <param name="comment">The comment to be stored for the buddy ("" for none)</param>

/// <param name="SMS">The SMS number for the buddy ("" for none)</param>

/// <param name="soundfile">The soundfile for the buddy ("" for none)</param>

/// <param name="authorziationRequired"><c>true</c> if we require authorization for this buddy, <c>false</c> otherwise</param>

///<param name="authorizationReason">The authorization reason/message that will be send to the client</param>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

/// <remarks>This function will probably not remain here; the SSI Manager will be made public</remarks>

public void AddBuddy(string screenname, ushort parentID, string alias, string email, string comment,

string SMS, string soundfile, bool authorziationRequired, string authorizationReason)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.AddBuddy(screenname, parentID, alias, email, SMS, comment, soundfile, authorziationRequired,

authorizationReason);

}

/// <summary>

/// Moves a buddy

/// </summary>

/// <param name="buddyID">The ID of the buddy to move</param>

/// <param name="parentID">The ID of the destination group</param>

/// <param name="index">The index in the destination group to move to</param>

public void MoveBuddy(ushort buddyID, ushort parentID, int index)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.MoveBuddy(SSI.GetBuddyByID(buddyID, parentID), SSI.GetGroupByID(parentID), index);

}

/// <summary>

/// Remove a buddy

/// </summary>

/// <param name="buddyID">The ID of the buddy to remove</param>

public void RemoveBuddy(ushort buddyID, ushort parentID)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSIBuddy buddy = SSI.GetBuddyByID(buddyID, parentID);

if (buddy != null)

SSI.RemoveBuddy(buddy);

}

/// <summary>

/// Adds a group to the client's server-side buddy list

/// </summary>

/// <param name="groupname">The name of the new group</param>

/// <param name="index">The index into the current list of groups</param>

[Obsolete(

"This method is obsolete and will be removed soon. Use the overloaded AddGroup methods without the index parameter."

)]

public void AddGroup(string groupname, int index)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.AddGroup(groupname, index);

}

/// <summary>

/// Adds a group to the client's server-side buddy list

/// </summary>

/// <param name="groupname">The name of the new group</param>

/// <param name="id">The group id</param>

public void AddGroup(string groupname, ushort id)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.AddGroup(groupname, id);

}

/// <summary>

/// Adds a group to the client's server-side buddy list

/// </summary>

/// <param name="groupname">The name of the new group</param>

public void AddGroup(string groupname)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.AddGroup(groupname);

}

/// <summary>

/// Adds the master group. This is necessary if a contact list is empty to add further groups after

/// </summary>

/// <param name="groupname">The master group name</param>

public void AddMasterGroup(string groupname)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

AddGroup(groupname, (ushort) 0);

}

/// <summary>

/// Move a group in the buddy list

/// </summary>

/// <param name="groupID">The ID of the group to move</param>

/// <param name="index">The new index of the group</param>

public void MoveGroup(ushort groupID, int index)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSI.MoveGroup(SSI.GetGroupByID(groupID), index);

}

/// <summary>

/// Remove a group from the server-side buddy list

/// </summary>

/// <param name="groupID">ID of the group to remove</param>

public void RemoveGroup(ushort groupID)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SSIGroup group = SSI.GetGroupByID(groupID);

if (group != null)

SSI.RemoveGroup(group);

}

/// <summary>

/// Tells AIM to begin sending UserStatus objects to client (online or away)

/// Client should call in response to <see cref="ContactListFinished"/> event

/// </summary>

public void ActivateBuddyList()

{

SNAC13.ActivateSSI(this);

OnLoginComplete();

}

/// <summary>

/// Requests a list of user interests from the server

/// </summary>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

public void RequestInterestsList()

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SNAC0F.RequestInterestList(this);

}

/// <summary>

/// Sends an icq authorization request

/// </summary>

/// <param name="screenname">the destination screenname</param>

/// <param name="reason">the request reason</param>

public void SendAuthorizationRequest(string screenname, string reason)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

// TODO reason string works only with ASCII encoding until now

SNAC13.SendAuthorizationRequest(this, screenname, reason);

}

/// <summary>

/// Sends an icq authorization response

/// </summary>

/// <param name="screenname">the destination screenname</param>

/// <param name="grantAuthorization">true, if the authorization should be granted, otherwise false</param>

/// <param name="reason">the reason for the decision</param>

public void SendAuthorizationResponse(string screenname, bool grantAuthorization, string reason)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SNAC13.SendAuthorizationResponse(this, screenname, grantAuthorization, reason);

}

/// <summary>

/// Grants the authorization to another screenname for the future

/// </summary>

/// <param name="screenname">The uin/screenname</param>

/// <param name="reason">The reason message</param>

/// <remarks>TODO ... seems to be obsolete in the current Oscar version</remarks>

public void SendFutureAuthorizationGrant(string screenname, string reason)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

SNAC13.SendFutureAuthorizationGrant(this, screenname, reason);

}

/// <summary>

/// Sends a requests for the server side buddylist. Server should reply with

/// the buddylist, or with the info that the client side buddylist is up to date

/// <remarks>TODO have to be tested</remarks>

/// </summary>

public void SendContactListCheckout()

{

SendContactListCheckout(LastModificationDate);

}

/// <summary>

/// Sends a requests for the server side buddylist. Server should reply with

/// the buddylist, or with the info that the client side buddylist is up to date

/// </summary>

/// <param name="lastModificationDate">the date when the client side buddylist was updated the last time</param>

/// <remarks>TODO have to be tested</remarks>

public void SendContactListCheckout(DateTime lastModificationDate)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

ushort localSSIItemCount = SSI.GetLocalSSIItemCount();

SNAC13.SendContactListCheckout(this, LastModificationDate, true, localSSIItemCount);

}

#region File transfer methods

/// <summary>

/// Send a file to a remote client via a direct connection

/// </summary>

/// <param name="recipient">The screenname of the remote client</param>

/// <param name="filename">The path of the file to send</param>

/// <returns>A key with which to reference this file transfer, or "" if a warning was

/// generated during the initialization process</returns>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

public Cookie SendFile(string recipient, string filename)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

FileTransferConnection ftconn =

Connections.CreateNewFileTransferConnection(DirectConnectionMethod.Direct, DirectConnectRole.Initiator);

ftconn.Other.ScreenName = recipient;

ftconn.LocalFileName = filename;

ftconn.ConnectToServer();

return ftconn.Cookie;

}

/// <summary>

/// Start a DirectIM session with a remote client via a direct connection

/// </summary>

/// <param name="recipient">The screenname of the remote client</param>

/// <param name="message">A message with which to invite the remote client</param>

/// <returns>A key with which to reference this DirectIM session, or "" if a warning was

/// generated during the initialization process</returns>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

public Cookie StartDirectIM(string recipient, string message)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

DirectIMConnection dimconn =

Connections.CreateNewDirectIMConnection(DirectConnectionMethod.Direct, DirectConnectRole.Initiator);

dimconn.Other.ScreenName = recipient;

dimconn.Message = message;

dimconn.ConnectToServer();

return dimconn.Cookie;

}

/// <summary>

/// Send a file to a remote client via an AOL proxy

/// </summary>

/// <param name="recipient">The screenname of the remote client</param>

/// <param name="filename">The path of the file to send</param>

/// <returns>A key with which to reference this file transfer, or "" if a warning was

/// generated during the initialization process</returns>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

public Cookie SendFileProxied(string recipient, string filename)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

FileTransferConnection newconn =

Connections.CreateNewFileTransferConnection(DirectConnectionMethod.Proxied, DirectConnectRole.Initiator);

newconn.Other.ScreenName = recipient;

newconn.LocalFileName = filename;

newconn.ConnectToServer();

return newconn.Cookie;

}

/// <summary>

/// Start a DirectIM session with a remote client via an AOL proxy

/// </summary>

/// <param name="recipient">The screenname of the remote client</param>

/// <param name="message">A message with which to invite the remote client</param>

/// <returns>A key with which to reference this DirectIM session, or "" if a warning was

/// generated during the initialization process</returns>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

public Cookie StartDirectIMProxied(string recipient, string message)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

DirectIMConnection dimconn =

Connections.CreateNewDirectIMConnection(DirectConnectionMethod.Proxied, DirectConnectRole.Initiator);

dimconn.Other.ScreenName = recipient;

dimconn.Message = message;

dimconn.ConnectToServer();

return dimconn.Cookie;

}

/// <summary>

/// Accept an invitation to a DirectIM session

/// </summary>

/// <param name="key">The key received in the <see cref="OscarLib_DirectIMRequestReceived"/> event</param>

public void AcceptDirectIMSession(Cookie key)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

var conn = Connections.GetDirectConnectionByCookie(key) as DirectIMConnection;

if (conn != null)

{

conn.ConnectToServer();

}

else

{

throw new Exception("Invalid DirectIM session key: \"" + key + "\"");

}

}

/// <summary>

/// Accept a file being sent to the client

/// </summary>

/// <param name="key">The key received in the <see cref="FileTransferRequestReceived"/> event</param>

/// <param name="savelocation">The path to which to save the file</param>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

/// <exception cref="System.Exception">Thrown when <paramref name="key"/> is not a valid file transfer key</exception>

public void AcceptFileTransfer(Cookie key, string savelocation)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

var conn = Connections.GetDirectConnectionByCookie(key) as FileTransferConnection;

if (conn != null)

{

conn.LocalFileName = savelocation;

conn.ConnectToServer();

}

else

{

throw new Exception("Invalid file transfer key: \"" + key + "\"");

}

}

/// <summary>

/// Cancel a pending or in-progress file transfer

/// </summary>

/// <param name="key">The key received with the transfer request</param>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

/// <exception cref="System.Exception">Thrown when <paramref name="key"/> is not a valid file transfer key</exception>

public void CancelFileTransfer(Cookie key)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

var conn = Connections.GetDirectConnectionByCookie(key) as FileTransferConnection;

if (conn != null)

{

conn.CancelFileTransfer("User cancelled transfer");

}

}

/// <summary>

/// Cancel a pending or in-progress Direct IM session

/// </summary>

/// <param name="key">The key received with the connection request</param>

/// <exception cref="NotLoggedInException">Thrown when the <see cref="Session"/> is not logged in</exception>

/// <exception cref="System.Exception">Thrown when <paramref name="key"/> is not a valid file transfer key</exception>

public void CancelDirectIMSession(Cookie key)

{

if (!LoggedIn)

{

throw new NotLoggedInException();

}

var conn = Connections.GetDirectConnectionByCookie(key) as DirectIMConnection;

if (conn != null)

{

Messages.SendDirectConnectionCancellation(conn, "User cancelled Direct Connection");

conn.DisconnectFromServer(false);

}

}

#endregion

#endregion

#region Internal methods

/// <summary>

/// Returns an MD5 hash of the client's password, an authorization key, and a constant string

/// </summary>

/// <param name="authkey">The authorization key sent by the server</param>

/// <returns>A 16-byte MD5 hash</returns>

/// <remarks>

/// <para>

/// The hashing process is fairly simple:

/// <list>

/// <item>The authorization key is put into a buffer</item>

/// <item>The password itself is hashed via MD5 and appended to the buffer</item>

/// <item>The constant string, "AOL Instant Messenger (SM)", is appended to the buffer in plaintext</item>

/// <item>The entire buffer is MD5 hashed and returned to the caller</item>

/// </list>

/// </para>

/// <para>

/// This method exists to prevent the password from having to be passed around in a data structure

/// </para>

/// </remarks>

protected internal byte[] HashPassword(byte[] authkey)

{

var md5 = new MD5CryptoServiceProvider();

var stream = new ByteStream();

stream.WriteByteArray(authkey);

stream.WriteByteArray(md5.ComputeHash(Encoding.ASCII.GetBytes(_password)));

stream.WriteString(Constants.AIM_MD5_STRING, Encoding.ASCII);

return md5.ComputeHash(stream.GetBytes());

}

/// <summary>

/// Stores data associated with a SNAC request/reply

/// </summary>

/// <param name="requestid">A SNAC request ID</param>

/// <param name="data">The data to be stored</param>

protected internal void StoreRequestID(uint requestid, object data)

{

_requestidstorage.Add(requestid, data);

}

/// <summary>

/// Retrieves data associated with a SNAC request/reply

/// </summary>

/// <param name="requestid">A SNAC request ID</param>

/// <returns>The data previously stored by <see cref="StoreRequestID"/></returns>

protected internal object RetrieveRequestID(uint requestid)

{

return _requestidstorage[requestid];

}

/// <summary>

/// Sets the session's privacy setting sent by the server in SNAC(13,06)

/// </summary>

/// <param name="ps">One of the <see cref="PrivacySetting"/> enumeration members</param>

protected internal void SetPrivacyFromServer(PrivacySetting ps)

{

_privacy = ps;

}

/// <summary>

/// Sets whether or not the client's idle time is public -- SNAC(13,06)

/// </summary>

/// <param name="publicidletime">true if others can see this client's idle time, false otherwise</param>

protected internal void SetPresence(bool publicidletime)

{

_publicidletime = publicidletime;

}

/// <summary>

/// Keeps track of the SNAC parameter responses that have been received thus far

/// </summary>

protected internal void ParameterSetArrived()

{

_parametercount++;

if (_parametercount == 5)

{

// We can send more stuff now

}

}

#endregion

#region Properties

#region Connection properties

private ProxyType proxySetting = ProxyType.None;

/// <summary>

/// The username to use for a proxy server

/// </summary>

public string ProxyUsername { get; set; }

/// <summary>

/// The password to use for a proxy server

/// </summary>

public string ProxyPassword { get; set; }

/// <summary>

/// The proxy server to connect through

/// </summary>

public string ProxyServer { get; set; }