# =============================================================================== # Copyright (C) 2010 Diego Duclos # # This file is part of eos. # # eos is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 2 of the License, or # (at your option) any later version. # # eos is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License # along with eos. If not, see . # =============================================================================== import json import re from logbook import Logger from sqlalchemy.orm import reconstructor import eos.effects import eos.db from eos.saveddata.price import Price as types_Price from .eqBase import EqBase pyfalog = Logger(__name__) def _t(x): return x class Effect(EqBase): """ The effect handling class, it is used to proxy and load effect handler code, as well as a container for extra information regarding effects coming from the gamedata db. @ivar ID: the ID of this effect @ivar name: The name of this effect @ivar description: The description of this effect, this is usualy pretty useless @ivar published: Wether this effect is published or not, unpublished effects are typicaly unused. """ @reconstructor def init(self): """ Reconstructor, composes the object as we grab it from the database """ self.__generated = False self.__effectDef = None @property def handler(self): """ The handler for the effect, It is automaticly fetched from effects/.py if the file exists the first time this property is accessed. """ if not self.__generated: pyfalog.debug("Generating effect: {0} ({1}) [runTime: {2}]", self.name, self.effectID, self.runTime) self.__generateHandler() return self.__handler @property def runTime(self): """ The runTime that this effect should be run at. This property is also automaticly fetched from effects/.py if the file exists. the possible values are: None, "early", "normal", "late" None and "normal" are equivalent, and are also the default. effects with an early runTime will be ran first when things are calculated, followed by effects with a normal runTime and as last effects with a late runTime are ran. """ if not self.__generated: self.__generateHandler() return self.__runTime @property def activeByDefault(self): """ The state that this effect should be be in. This property is also automaticly fetched from effects/.py if the file exists. the possible values are: None, True, False If this is not set: We simply assume that missing/none = True, and set it accordingly (much as we set runTime to Normalif not otherwise set). Nearly all effect files will fall under this category. If this is set to True: We would enable it anyway, but hey, it's double enabled. No effect files are currently configured this way (and probably will never be). If this is set to False: Basically we simply skip adding the effect to the effect handler when the effect is called, much as if the run time didn't match or other criteria failed. """ if not self.__generated: self.__generateHandler() return self.__activeByDefault @activeByDefault.setter def activeByDefault(self, value): """ Just assign the input values to the activeByDefault attribute. You *could* do something more interesting here if you wanted. """ self.__activeByDefault = value @property def type(self): """ The type of the effect, automaticly fetched from effects/.py if the file exists. Valid values are: "passive", "active", "projected", "gang", "structure" Each gives valuable information to eos about what type the module having the effect is. passive vs active gives eos clues about wether to module is activatable or not (duh!) and projected and gang each tell eos that the module can be projected onto other fits, or used as a gang booster module respectivly """ if not self.__generated: self.__generateHandler() return self.__type @property def isImplemented(self): """ Whether this effect is implemented in code or not, unimplemented effects simply do nothing at all when run """ if not self.__generated: self.__generateHandler() return self.__effectDef is not None @property def dealsDamage(self): if not self.__generated: self.__generateHandler() return self.__dealsDamage def isType(self, type): """ Check if this effect is of the passed type """ if not self.__generated: self.__generateHandler() return self.type is not None and type in self.type def __generateHandler(self): """ Grab the handler, type and runTime from the effect code if it exists, if it doesn't, set dummy values and add a dummy handler """ try: effectDefName = "Effect{}".format(self.ID) pyfalog.debug("Loading {0} ({1})".format(self.name, effectDefName)) self.__effectDef = effectDef = getattr(eos.effects, effectDefName) self.__handler = getattr(effectDef, "handler", eos.effects.BaseEffect.handler) self.__runTime = getattr(effectDef, "runTime", "normal") self.__activeByDefault = getattr(effectDef, "activeByDefault", True) self.__dealsDamage = effectDef.dealsDamage effectType = getattr(effectDef, "type", None) effectType = effectType if isinstance(effectType, tuple) or effectType is None else (effectType,) self.__type = effectType except ImportError as e: # Effect probably doesn't exist, so create a dummy effect and flag it with a warning. self.__handler = eos.effects.DummyEffect.handler self.__runTime = "normal" self.__activeByDefault = True self.__dealsDamage = False self.__type = None pyfalog.debug("ImportError generating handler: {0}", e) except AttributeError as e: # Effect probably exists but there is an issue with it. Turn it into a dummy effect so we can continue, but flag it with an error. self.__handler = eos.effects.DummyEffect.handler self.__runTime = "normal" self.__activeByDefault = True self.__dealsDamage = False self.__type = None pyfalog.error("AttributeError generating handler: {0}", e) except (KeyboardInterrupt, SystemExit): raise except Exception as e: self.__handler = eos.effects.DummyEffect.handler self.__runTime = "normal" self.__activeByDefault = True self.__dealsDamage = False self.__type = None pyfalog.critical("Exception generating handler:") pyfalog.critical(e) self.__generated = True def getattr(self, key): if not self.__generated: self.__generateHandler() try: return self.__effectDef.get(key, None) except (KeyboardInterrupt, SystemExit): raise except: return getattr(self.__effectDef, key, None) class Item(EqBase): ABYSSAL_TYPES = None @reconstructor def init(self): self.__race = None self.__requiredSkills = None self.__requiredFor = None self.__offensive = None self.__assistive = None self.__overrides = None self.__priceObj = None def getShortName(self, charLimit=12): if len(self.name) <= charLimit: return self.name splitName = self.name.strip().split(' ') if len(splitName) == 1: return self.name shortName = '' for word in splitName: try: shortName += word[0].capitalize() except IndexError: pass return shortName @property def customName(self): return re.sub(_t('Caustic'), _t('Tachyon'), self.name) @property def attributes(self): return self.__attributes @property def attribsWithOverrides(self): overrides = self.overrides attribs = {} for aname, attr in self.attributes.items(): if aname in overrides: attribs[aname] = overrides[aname] else: attribs[aname] = attr return attribs def getAttribute(self, key, default=None): if key in self.attributes: return self.attributes[key].value else: return default def isType(self, type): for effect in self.effects.values(): if effect.isType(type): return True return False @property def overrides(self): if self.__overrides is None: self.__overrides = {} overrides = eos.db.getOverrides(self.ID) for x in overrides: if x.attr.name in self.__attributes: self.__overrides[x.attr.name] = x return self.__overrides def setOverride(self, attr, value): from eos.saveddata.override import Override if attr.name in self.overrides: override = self.overrides.get(attr.name) override.value = value else: override = Override(self, attr, value) self.overrides[attr.name] = override eos.db.save(override) def deleteOverride(self, attr): override = self.overrides.pop(attr.name, None) eos.db.saveddata_session.delete(override) eos.db.commit() @property def requiredSkills(self): if self.__requiredSkills is None: self.__requiredSkills = {} if self.reqskills: for skillTypeID, skillLevel in json.loads(self.reqskills).items(): skillItem = eos.db.getItem(int(skillTypeID)) if skillItem: self.__requiredSkills[skillItem] = skillLevel return self.__requiredSkills @property def requiredFor(self): if self.__requiredFor is None: self.__requiredFor = {} if self.requiredfor: for typeID, skillLevel in json.loads(self.requiredfor).items(): requiredForItem = eos.db.getItem(int(typeID)) if requiredForItem: self.__requiredFor[requiredForItem] = skillLevel return self.__requiredFor factionMap = { 500001: "caldari", 500002: "minmatar", 500003: "amarr", 500004: "gallente", 500005: "jove", 500010: "guristas", 500011: "angel", 500012: "blood", 500014: "ore", 500016: "sisters", 500018: "mordu", 500019: "sansha", 500020: "serpentis", 500026: "triglavian" } @property def race(self): if self.__race is None: try: if ( self.category.name == 'Structure' or # Here until CCP puts their shit together self.name in ("Thunderchild", "Stormbringer", "Skybreaker") ): self.__race = "upwell" else: self.__race = self.factionMap[self.factionID] # Some ships (like few limited issue ships) do not have factionID set, # thus keep old mechanism for now except KeyError: # Define race map map = { 1 : "caldari", 2 : "minmatar", 4 : "amarr", 5 : "sansha", # Caldari + Amarr 6 : "blood", # Minmatar + Amarr 8 : "gallente", 9 : "guristas", # Caldari + Gallente 10 : "angelserp", # Minmatar + Gallente, final race depends on the order of skills 12 : "sisters", # Amarr + Gallente 15 : "concord", 16 : "jove", 32 : "sansha", # Incrusion Sansha 128: "ore", 135: "triglavian" } # Race is None by default race = None # Check primary and secondary required skills' races if race is None: skillRaces = tuple([rid for rid in (s.raceID for s in tuple(self.requiredSkills.keys())) if rid]) if sum(skillRaces) in map: race = map[sum(skillRaces)] if race == "angelserp": if skillRaces == (2, 8): race = "angel" else: race = "serpentis" # Rely on item's own raceID as last resort if race is None: race = map.get(self.raceID, None) # Store our final value self.__race = race return self.__race @property def assistive(self): """Detects if item can be used as assistance""" # Make sure we cache results if self.__assistive is None: assistive = False # Go through all effects and find first assistive for effect in self.effects.values(): if effect.isAssistance is True: # If we find one, stop and mark item as assistive assistive = True break self.__assistive = assistive return self.__assistive @property def offensive(self): """Detects if item can be used as something offensive""" # Make sure we cache results if self.__offensive is None: offensive = False # Go through all effects and find first offensive for effect in self.effects.values(): if effect.isOffensive is True: # If we find one, stop and mark item as offensive offensive = True break self.__offensive = offensive return self.__offensive def requiresSkill(self, skill, level=None): for s, l in self.requiredSkills.items(): if isinstance(skill, str): if s.typeName == skill and (level is None or l == level): return True elif isinstance(skill, int) and (level is None or l == level): if s.ID == skill: return True elif skill == s and (level is None or l == level): return True elif hasattr(skill, "item") and skill.item == s and (level is None or l == level): return True return False @property def price(self): # todo: use `from sqlalchemy import inspect` instead (mac-deprecated doesn't have inspect(), was imp[lemented in 0.8) if self.__priceObj is not None and getattr(self.__priceObj, '_sa_instance_state', None) and self.__priceObj._sa_instance_state.deleted: pyfalog.debug("Price data for {} was deleted (probably from a cache reset), resetting object".format(self.ID)) self.__priceObj = None if self.__priceObj is None: db_price = eos.db.getPrice(self.ID) # do not yet have a price in the database for this item, create one if db_price is None: pyfalog.debug("Creating a price for {}".format(self.ID)) self.__priceObj = types_Price(self.ID) eos.db.add(self.__priceObj) eos.db.flush() else: self.__priceObj = db_price return self.__priceObj @property def isAbyssal(self): if Item.ABYSSAL_TYPES is None: Item.getAbyssalTypes() return self.ID in Item.ABYSSAL_TYPES @classmethod def getAbyssalTypes(cls): cls.ABYSSAL_TYPES = eos.db.getAbyssalTypes() @property def isModule(self): return self.category.name in ('Module', 'Structure Module') @property def isSubsystem(self): return self.category.name == 'Subsystem' @property def isCharge(self): return self.category.name == 'Charge' @property def isCommodity(self): return self.category.name == 'Commodity' @property def isDrone(self): return self.category.name == 'Drone' @property def isFighter(self): return self.category.name == 'Fighter' @property def isImplant(self): return self.category.name == 'Implant' and self.group.name != 'Booster' @property def isBooster(self): return self.group.name == 'Booster' and self.category.name == 'Implant' @property def isStandup(self): if self.category.name == "Structure Module": return True if self.isFighter and {'fighterSquadronIsStandupLight', 'fighterSquadronIsStandupHeavy', 'fighterSquadronIsStandupSupport'}.intersection(self.attributes): return True return False def __repr__(self): return "Item(ID={}, name={}, display={}) at {}".format( self.ID, self.typeName, self.name, hex(id(self)) ) class MetaData(EqBase): pass class ItemEffect(EqBase): pass class AttributeInfo(EqBase): pass class Attribute(EqBase): pass class Category(EqBase): pass class AlphaClone(EqBase): @reconstructor def init(self): self.skillCache = {} for x in self.skills: self.skillCache[x.typeID] = x def getSkillLevel(self, skill): if skill.item.ID in self.skillCache: return self.skillCache[skill.item.ID].level else: return None class AlphaCloneSkill(EqBase): pass class Group(EqBase): pass class DynamicItem(EqBase): @property def shortName(self): name = self.item.customName keywords = ('Decayed', 'Gravid', 'Unstable', 'Radical') for kw in keywords: if name.startswith(f'{kw} '): name = kw m = re.match('(?P\S+) (?P\S+) Drone (?P\S+) Mutaplasmid', name) if m: name = '{} {}'.format(m.group('mutagrade'), m.group('mutatype')) return name class DynamicItemAttribute(EqBase): pass class DynamicItemItem(EqBase): pass class MarketGroup(EqBase): def __repr__(self): return "MarketGroup(ID={}, name={}, parent={}) at {}".format( self.ID, self.name, getattr(self.parent, "name", None), hex(id(self))) class MetaGroup(EqBase): pass class Unit(EqBase): def __init__(self): self.name = None self.displayName = None @property def rigSizes(self): return { 1: "Small", 2: "Medium", 3: "Large", 4: "X-Large" } @property def translations(self): """ This is a mapping of various tweaks that we have to do between the internal representation of an attribute value and the display (for example, 'Millisecond' units have the display name of 's', so we have to convert value from ms to s) """ # Each entry contains: # Function to convert value to display value # Function to convert value to display format (which sometimes can be a string) # Function which controls unit name used with attribute # Function to convert display value to value return { "Inverse Absolute Percent": ( lambda v: (1 - v) * 100, lambda v: (1 - v) * 100, lambda u: u, lambda d: -1 * (d / 100) + 1), "Inversed Modifier Percent": ( lambda v: (1 - v) * 100, lambda v: (1 - v) * 100, lambda u: u, lambda d: -1 * (d / 100) + 1), "Modifier Percent": ( lambda v: (v - 1) * 100, lambda v: ("%+.2f" if ((v - 1) * 100) % 1 else "%+d") % ((v - 1) * 100), lambda u: u, lambda d: (d / 100) + 1), "Volume": ( lambda v: v, lambda v: v, lambda u: "m³", lambda d: d), "Sizeclass": ( lambda v: self.rigSizes[v], lambda v: self.rigSizes[v], lambda d: next(i for i in self.rigSizes.keys() if self.rigSizes[i] == 'Medium'), lambda u: ""), "Absolute Percent": ( lambda v: v * 100, lambda v: v * 100, lambda u: u, lambda d: d / 100), "Milliseconds": ( lambda v: v / 1000, lambda v: v / 1000, lambda u: u, lambda d: d * 1000), "Boolean": ( lambda v: True if v else False, lambda v: "Yes" if v else "No", lambda u: "", lambda d: 1.0 if d == "Yes" else 0.0), "typeID": ( self.itemIDCallback, self.itemIDCallback, lambda u: "", None), # we could probably convert these back if we really tried hard enough "groupID": ( self.groupIDCallback, self.groupIDCallback, lambda u: "", None), "attributeID": ( self.attributeIDCallback, self.attributeIDCallback, lambda u: "", None), } @staticmethod def itemIDCallback(v): v = int(v) item = eos.db.getItem(int(v)) return "%s (%d)" % (item.name, v) if item is not None else str(v) @staticmethod def groupIDCallback(v): v = int(v) group = eos.db.getGroup(v) return "%s (%d)" % (group.name, v) if group is not None else str(v) @staticmethod def attributeIDCallback(v): v = int(v) if not v: # some attributes come through with a value of 0? See #1387 return "%d" % v attribute = eos.db.getAttributeInfo(v, eager="unit") return "%s (%d)" % (attribute.name.capitalize(), v) def PreformatValue(self, value): """Attributes have to be translated certain ways based on their unit (ex: decimals converting to percentages). This allows us to get an easy representation of how the attribute should be printed """ override = self.translations.get(self.name) if override is not None: return override[1](value), override[2](self.displayName) return value, self.displayName def SimplifyValue(self, value): """Takes the internal representation value and convert it into the display value""" override = self.translations.get(self.name) if override is not None: return override[0](value) return value def ComplicateValue(self, value): """Takes the display value and turns it back into the internal representation of it""" override = self.translations.get(self.name) if override is not None: return override[3](value) return value class Traits(EqBase): pass class ImplantSet(EqBase): @property def fullName(self): if not self.gradeName: return self.setName return '{} {}'.format(self.gradeName, self.setName)