Utility.py

import pickle
import socket
import enum
import logging
from pyproj import Geod
import Entities


formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')


# get_cc_sock() - creating a new socket for cc and returns it
def get_cc_listen_sock():
    # Initialize socket
    try:
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
        logging.debug("Socket Successfully Created!")
    except socket.error as err:
        logging.error("Socket creation failed with error {}".format(err))

    return sock


# get_bc_sock() - creating a new socket for bc and returns it
def get_bc_listen_sock():
    # Initialize socket
    try:
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
        logging.debug("Socket Successfully Created!")
    except socket.error as err:
        logging.error("Socket creation failed with error {}".format(err))

    return sock


def get_cc_send_sock():
    # Initialize socket
    try:
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        logging.debug("Socket Successfully Created!")
    except socket.error as err:
        logging.error("Socket creation failed with error {}".format(err))

    return sock


def get_cc_to_bc_send_sock():
    # Initialize socket
    try:
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
        logging.debug("Socket Successfully Created!")
    except socket.error as err:
        logging.error("Socket creation failed with error {}".format(err))

    return sock


# get_field_sock() - creating a new socket for field and returns it
def get_field_sock():
    # Initialize socket
    try:
        sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
        logging.debug("Socket Successfully Created!")
    except socket.error as err:
        logging.error("Socket creation failed with error {}".format(err))

    return sock


# Getters
def get_field_address():
    IP = '127.0.0.1'
    port = 5007
    return IP, port


# for FieldUDP
def get_cc_address():
    return '255.255.255.255', 5008


def get_bc_address():
    return '255.255.255.255', 5014


# for CompanyCommanderUDP
def get_cc_receive_address():
    return '', 5008


def get_cc_send_address(company_num):
    IP = '127.0.0.1'

    if int(company_num) == Company.company1.value:
        port = 5011
        return IP, port

    elif int(company_num) == Company.company2.value:
        port = 5012
        return IP, port

    elif int(company_num) == Company.company3.value:
        port = 5013
        return IP, port

    else:
        return Case.error.value


def get_cc_to_bc_send_address(company_num):
    IP = '127.0.0.1'

    if int(company_num) == Company.company1.value:
        port = 5015
        return IP, port

    elif int(company_num) == Company.company2.value:
        port = 5016
        return IP, port

    elif int(company_num) == Company.company3.value:
        port = 5017
        return IP, port

    else:
        return Case.error.value


def init_cc_address(company_num):
    IP = ''

    if int(company_num) == Company.company1.value:
        port = 5004
        return IP, port

    elif int(company_num) == Company.company2.value:
        port = 5005
        return IP, port

    elif int(company_num) == Company.company3.value:
        port = 5006
        return IP, port

    else:
        return Case.error.value


def get_bc_receive_address():
    IP = ''
    port = 5014
    return IP, port


def company_num_by_port(port):
    if port == 5004:
        return 1
    elif port == 5005:
        return 2
    elif port == 5006:
        return 3
    else:
        return Case.error.value


# in_use(IP, port) - return a boolean variable that tells if address (IP, port) is in use. True = already open
#                                                                                           False = free to use
def in_use(address):
    IP = address[0]
    port = address[1]

    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

    try:
        sock.bind((IP, port))
        result = False
    except:
        result = True
    sock.close()
    return result


# create_move_to_message(company_num, field_object_id, new_location) - create a MoveOrderMessage and Packet and returns
#                                                                      the Packet
def create_move_to_message(company_num, field_object_id, new_location):

    message = Entities.MoveOrderMessage(company_num, field_object_id, new_location)
    packet = Entities.Packet(Sender.company_commander.value, company_num, Receiver.soldier.value,
                             MessageType.move_order.value, message)

    return packet


# contain(company, id) - check if FieldObject is in company list by ID. If the searched FieldObject is in the list,
#                        it returns the index of the object. else, it returns -1.
def contain(company, id):
    count = 0
    for field_object in company:
        if field_object.get_id() == id:
            return count
        else:
            count += 1
    return -1


def enemy_contain(enemies, id):
    count = 0
    for enemy in enemies:
        if enemy.get_id() == id:
            return count
        else:
            count += 1
    return -1


def marked_enemies_check(enemies, marked_enemies):
    enemies_list = enemies
    for m_enemy in marked_enemies:
        if m_enemy not in enemies:
            enemies_list.append(m_enemy)

    return enemies_list


# sender_receiver_case(packet) - get the packet and returns the case of sender-receiver
def sender_receiver_switch_case(packet):

    # sender = Soldier, receiver = CC
    if packet.get_sender() == Sender.soldier.value and \
       packet.get_receiver() == Receiver.company_commander.value:
        return Case.soldier_to_cc.value

    # sender = Soldier, receiver = BC
    elif packet.get_sender() == Sender.soldier.value and \
            packet.get_receiver() == Receiver.battalion_commander.value:
        return Case.soldier_to_bc.value

    # sender = BC, receiver = CC -> Soldier
    elif packet.get_sender() == Sender.soldier.value and \
            packet.get_receiver() == Receiver.battalion_commander.value:
        return Case.bc_to_cc_approval.value

    # sender = CC, receiver = soldier
    elif packet.get_sender() == Sender.company_commander.value and \
            packet.get_receiver() == Receiver.soldier.value:
        return Case.cc_to_soldier.value

    elif packet.get_sender() == Sender.company_commander.value and \
            packet.get_receiver() == Receiver.battalion_commander.value:
        return Case.cc_to_bc.value

    else:
        return Case.error.value


# get_line(start, end) - get a start and end points and return a list of lined steps
def get_line(start, end):
    x1 = start[Location.X.value]
    y1 = start[Location.Y.value]

    x2 = end[Location.X.value]
    y2 = end[Location.Y.value]

    geod = Geod("+ellps=WGS84")
    points = geod.npts(x1, y1,
                       x2, y2,
                       npts=100)

    return points


def setup_logger(name, log_file, level=logging.INFO):

    handler = logging.FileHandler(log_file)
    handler.setFormatter(formatter)

    logger = logging.getLogger(name)
    logger.setLevel(level)
    logger.addHandler(handler)

    return logger


def load(file_name):
    file_name = file_name
    with open(file_name, 'rb') as file:
        scenario = pickle.load(file)
        return scenario


# Enum Classes
# Cases
class Sender(enum.Enum):
    soldier = 1
    company_commander = 2
    battalion_commander = 3


class Receiver(enum.Enum):
    soldier = 1
    company_commander = 2
    battalion_commander = 3


class Company(enum.Enum):
    not_relevant = 0
    company1 = 1
    company2 = 2
    company3 = 3


class Case(enum.Enum):
    soldier_to_cc = 1
    cc_to_bc = 2
    cc_to_soldier = 3
    approval = 4
    error = 0


class ObjectType(enum.Enum):
    soldier = 1
    apc = 2


class EnemyType(enum.Enum):
    soldier = 1
    launcher = 2
    lookout_point = 3


class FullMessageIndexes(enum.Enum):    # sender.company_num.receiver.message_type.message
    sender = 0
    company_num = 1
    receiver = 2
    message_type = 3
    message = 4


class MessageType(enum.Enum):
    alive = 1
    move_order = 2
    engage_order = 3
    enemies_in_sight = 4
    move_approval = 5
    engage_approval = 6
    got_shot = 7
    not_approved_message = 8


class ObjectListIndex(enum.Enum):
    object_type = 0
    company_num = 1
    location = 2
    ammo = 3


class Location(enum.Enum):
    X = 0
    Y = 1


class ListAndMsg(enum.Enum):
    list = 0
    msg = 1


class ReportMessageIndexes(enum.Enum):
    company_num = 0
    id = 1
    location = 2


class MoveToMessageIndexes(enum.Enum):
    company_num = 0
    field_object_id = 1
    location = 2


class MovingTuple(enum.Enum):
    on_move = 0
    location = 1


class SpeedButtons(enum.Enum):
    normal = 0
    x2 = 1
    x4 = 2