Local Network Messenger (v0.1)

Руководство пользователя
- Клиент
  - Запустить файл Client.py
  - В поле для ввода IP-адреса указать IP сервера в локальной сети (сервер - см "Сервер")
  - Нажать кнопку "Подключится к серверу"
  - Использовать кнопку "Отправить" для отправки сообщения из поля для ввода
  - Лог чата отображается в текстовом окне
  - Для отключения от сервера использовать кнопку "Отключится от сервера"
- Сервер
  - Запустить файл Server.py
  - Ввести локальный IP машины, на которой запущен сервер
  - Для проверки подключится в качестве клиента (см. выше)
- Команды и права клиентов сервера
  - Для отображения всех команд ввести в чат /help
  - Для использования команды ввести в чат /назвние аргументы
  - Для отображения помощи по команде, использовать /help название_команды
  - Для использования некоторых команд необходимы права более высокого уровня
  - Guest - гость (при настройках по умолчанию является стандартной для всех)
  - User - пользователь, одобренный администратором
  - Admin - администратор, выдается через консоль в Server.py
  - Console - консольный пользователь с наивысшими правами, работать через Server.py
  - Для проверки своих/чужих прав использовать /pinfo ник_пользователя
  - Для смены ника использовать /setnick новый_ник (User+ права)
Клиентская часть (руководство по API)
- Основная форма клиента
  - Поле для ввода IP-адреса сервера в локальной сети
  - Кнопка соединения/разъединения с сервером
  - Поле для ввода сообщения
  - Текстовое окно (чат) с логом всех сообщений
Серверная часть (руководство по API)
- Модуль Server (класс Сервер)
  - Конструктор: адрес, права новых пользователей (стандартно Guest)
  - get_user_by_nick(nick) - получить пользователя по нику
  - ban(ip) - блокировка ip
  - unban(ip) - разблокировка ip
  - resend(message) - рассылка сообщения всем пользователям
- Модуль User (класс User и класс ConsoleUser)
  - send(message) - отправка сообщения
  - Класс ConsoleUser - определеяет супер-пользователя с правами Console
- Модуль Executor (класс Executor)
  - reload() - перезагрузка доступных команд
  - get_command(name) - получит команду по названию
  - execute(name, args, caller) - исполнить команду
- Модуль Errors
  - Класс Callback - базовый возвратный код состояния модуля серверной части
  - Класс ServerError - ошибка серверной части
  - Класс CmdCallback - базовый возвратный код состояния после исполнения команды
  - Класс CmdError - ошибка при исполнении команды
  - Класс CmdAnswer - ответ команды пользователю
  - Класс CmdSyntaxError - ошибка синтаксиса указания аргументов
  - Класс CmdNotFound - запращиваемая команда не существует
  - Класс CmdNotPermissions - нет прав на исполнение команды
- Модуль Command (класс Command)
  - load() - переопредялемый метод, вызывается при загрузки команды (Executor.reload())
  - execute(args, caller) - переопределяемый метод, вызывается при исполнении команды
  - getStr(args, index) - получение текстового параметра из аргументов команды
- Модуль Permissions (класс Permissions)
  - Anyone - любой ползователь
  - Guest - гость (по умолчанию - новый пользователь сервера)
  - User - полный пользователь (если не установлен как стандартный, выдается через /padd
  - Admin - администратор (выдается через Console)
  - Console - суперпользователь, существует в пределах программы Server.py
- Модуль Messages
  - Класс BlankMessage - сообщение отправленное из Client.py на сервер
  - Класс UserMessage - сообщение пришедшое на сервер и разосланное на Client.py
  - Класс Info - некоторая информация конкретному пользователю от сервера
  - Класс Error - ошибка, отправляется конкретному пользователю
  - Класс Bcast - Некоторая информация всем клиентам сервера
  - Класс CommandAnswer - ответ команды пользователю в виде сообщения (см Errors.CmdAnswer)
- Папка Commands
  - Содержит команды сервера, а именно модули, в которых определены классы-наследники от класса Command

Name		Name	Last commit message	Last commit date
Latest commit History 50 Commits
.idea		.idea
Commands		Commands
Release		Release
Client.py		Client.py
Client.spec		Client.spec
Command.py		Command.py
Errors.py		Errors.py
Executor.py		Executor.py
Messages.py		Messages.py
Permissions.py		Permissions.py
README.md		README.md
Server.py		Server.py
Server.spec		Server.spec
UI.py		UI.py
UI.ui		UI.ui
User.py		User.py

stasivs/Messenger

Folders and files

Latest commit

History

Repository files navigation

Local Network Messenger (v0.1)

Руководство пользователя

Клиент

Сервер

Команды и права клиентов сервера

Клиентская часть (руководство по API)

Основная форма клиента

Серверная часть (руководство по API)

Модуль Server (класс Сервер)

Модуль User (класс User и класс ConsoleUser)

Модуль Executor (класс Executor)

Модуль Errors

Модуль Command (класс Command)

Модуль Permissions (класс Permissions)

Модуль Messages

Папка Commands

About

Resources

Stars

Watchers

Forks

Languages