gkeys/seed.py

   1 #
   2 #-*- coding:utf-8 -*-
   3
   4 '''Gentoo-keys - seed.py
   5 This is gentoo-keys superclass which wraps the pyGPG lib
   6 with gentoo-keys specific convienience functions.
   7
   8  Distributed under the terms of the GNU General Public License v2
   9
  10  Copyright:
  11              (c) 2011 Brian Dolbec
  12              Distributed under the terms of the GNU General Public License v2
  13
  14  Author(s):
  15              Brian Dolbec <dolsen@gentoo.org>
  16
  17 '''
  18
  19 from gkeys.log import logger
  20 from gkeys.config import GKEY
  21
  22
  23 class Seeds(object):
  24     '''Handles all seed key file operations'''
  25
  26
  27     def __init__(self, filepath=None):
  28         '''Seeds class init function
  29
  30         @param filepath: string of the file to load
  31         '''
  32         self.filename = filepath
  33         self.seeds = []
  34
  35
  36     def load(self, filename=None):
  37         '''Load the seed file into memory'''
  38         if filename:
  39             self.filename = filename
  40         if not self.filename:
  41             logger.debug("Seed: load; Not a valid filename: '%s'" % str(self.filename))
  42             return False
  43         logger.debug("Seeds: load; Begin loading seed file %s" % self.filename)
  44         seedlines = None
  45         self.seeds = []
  46         try:
  47             with open(self.filename) as seedfile:
  48                 seedlines = seedfile.readlines()
  49         except IOError as err:
  50             logger.debug("Seed: load; IOError occurred while loading file")
  51             self._error(err)
  52             return False
  53
  54         for seed in seedlines:
  55             #try:
  56             seed = seed.strip('\n')
  57             self.seeds.append(GKEY.make_packed(seed))
  58             #except Exception as err:
  59                 #logger.debug("Seed: load; Error splitting seed: %s" % seed)
  60                 #logger.debug("Seed: load; ...............parts: %s" % str(parts))
  61                 #self._error(err)
  62         logger.debug("Seed: load; Completed loading seed file %s" % self.filename)
  63         return True
  64
  65
  66     def save(self, filename=None):
  67         '''Save the seeds to the file'''
  68         if filename:
  69             self.filename = filename
  70         if not self.filename:
  71             logger.debug("Seed: save; Not a valid filename: '%s'" % str(self.filename))
  72             return False
  73         logger.debug("Seed: save; Begin saving seed file %s" % self.filename)
  74         try:
  75             with open(self.filename, 'w') as seedfile:
  76                 seedlines = [x.packed_string for x in self.seeds]
  77                 seedfile.write('\n'.join(seedlines))
  78                 seedfile.write("\n")
  79         except IOError as err:
  80             self._error(err)
  81             return False
  82         return True
  83
  84
  85     def add(self, gkey):
  86         '''Add a new seed key to memory'''
  87         if isinstance(gkey, GKEY):
  88             self.seeds.append(gkey)
  89             return True
  90         return False
  91
  92
  93
  94     def delete(self, gkey=None, index=None):
  95         '''Delete the key from the seeds in memory
  96
  97         @param gkey: GKEY, the matching GKEY to delete
  98         @param index: int, '''
  99         if gkey:
 100             try:
 101                 self.seeds.remove(gkey)
 102             except ValueError:
 103                 return False
 104             return True
 105         elif index:
 106             self.seeds.pop(index)
 107             return True
 108
 109
 110     def list(self, **kwargs):
 111         '''List the key or keys matching the kwargs argument or all
 112
 113         @param kwargs: dict of GKEY._fields and values
 114         @returns list
 115         '''
 116         if not kwargs:
 117             return self.seeds
 118         # discard any invalid keys
 119         keys = set(list(kwargs)).intersection(GKEY._fields)
 120         result = self.seeds[:]
 121         for key in keys:
 122             result = [x for x in result if getattr(x , key) == kwargs[key]]
 123         return result
 124
 125
 126     def search(self, pattern):
 127         '''Search for the keys matching the regular expression pattern'''
 128         pass
 129
 130
 131     def index(self, gkey):
 132         '''The index of the gkey in the seeds list
 133
 134         @param gkey: GKEY, the matching GKEY to delete
 135         @return int
 136         '''
 137         try:
 138             index = self.seeds.index(gkey)
 139         except ValueError:
 140             return None
 141         return index
 142
 143
 144     def _error(self, err):
 145         '''Class error logging function'''
 146         logger.error("Seed: Error processing seed file %s" % self.filename)
 147         logger.error("Seed: Error was: %s" % str(err))
 148