python/samba/common.py

   1 # Samba common functions
   2 #
   3 # Copyright (C) Matthieu Patou <mat@matws.net>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18
  19
  20 import ldb
  21 from samba import dsdb
  22 from samba.ndr import ndr_pack
  23 from samba.dcerpc import misc
  24 import binascii
  25
  26 from samba.compat import PY3
  27
  28
  29 if PY3:
  30     # cmp() exists only in Python 2
  31     def cmp(a, b):
  32         return (a > b) - (a < b)
  33
  34
  35 def confirm(msg, forced=False, allow_all=False):
  36     """confirm an action with the user
  37
  38     :param msg: A string to print to the user
  39     :param forced: Are the answer forced
  40     """
  41     if forced:
  42         print("%s [YES]" % msg)
  43         return True
  44
  45     mapping = {
  46         'Y': True,
  47         'YES': True,
  48         '': False,
  49         'N': False,
  50         'NO': False,
  51         }
  52
  53     prompt = '[y/N]'
  54
  55     if allow_all:
  56         mapping['ALL'] = 'ALL'
  57         mapping['NONE'] = 'NONE'
  58         prompt = '[y/N/all/none]'
  59
  60     while True:
  61         v = raw_input(msg + ' %s ' % prompt)
  62         v = v.upper()
  63         if v in mapping:
  64             return mapping[v]
  65         print("Unknown response '%s'" % v)
  66
  67
  68 def normalise_int32(ivalue):
  69     '''normalise a ldap integer to signed 32 bit'''
  70     if int(ivalue) & 0x80000000 and int(ivalue) > 0:
  71         return str(int(ivalue) - 0x100000000)
  72     return str(ivalue)
  73
  74
  75 class dsdb_Dn(object):
  76     '''a class for binary DN'''
  77
  78     def __init__(self, samdb, dnstring, syntax_oid=None):
  79         '''create a dsdb_Dn'''
  80         if syntax_oid is None:
  81             # auto-detect based on string
  82             if dnstring.startswith("B:"):
  83                 syntax_oid = dsdb.DSDB_SYNTAX_BINARY_DN
  84             elif dnstring.startswith("S:"):
  85                 syntax_oid = dsdb.DSDB_SYNTAX_STRING_DN
  86             else:
  87                 syntax_oid = dsdb.DSDB_SYNTAX_OR_NAME
  88         if syntax_oid in [dsdb.DSDB_SYNTAX_BINARY_DN, dsdb.DSDB_SYNTAX_STRING_DN]:
  89             # it is a binary DN
  90             colons = dnstring.split(':')
  91             if len(colons) < 4:
  92                 raise RuntimeError("Invalid DN %s" % dnstring)
  93             prefix_len = 4 + len(colons[1]) + int(colons[1])
  94             self.prefix = dnstring[0:prefix_len]
  95             self.binary = self.prefix[3+len(colons[1]):-1]
  96             self.dnstring = dnstring[prefix_len:]
  97         else:
  98             self.dnstring = dnstring
  99             self.prefix = ''
 100             self.binary = ''
 101         self.dn = ldb.Dn(samdb, self.dnstring)
 102
 103     def __str__(self):
 104         return self.prefix + str(self.dn.extended_str(mode=1))
 105
 106     def __cmp__(self, other):
 107         ''' compare dsdb_Dn values similar to parsed_dn_compare()'''
 108         dn1 = self
 109         dn2 = other
 110         guid1 = dn1.dn.get_extended_component("GUID")
 111         guid1b = ndr_pack(misc.GUID(guid1))
 112         guid2 = dn2.dn.get_extended_component("GUID")
 113         guid2b = ndr_pack(misc.GUID(guid2))
 114
 115         v = cmp(guid1, guid2)
 116         if v != 0:
 117             return v
 118         v = cmp(dn1.binary, dn2.binary)
 119         return v
 120
 121     # In Python3, __cmp__ is replaced by these 6 methods
 122     def __eq__(self, other):
 123         return self.__cmp__(other) == 0
 124
 125     def __ne__(self, other):
 126         return self.__cmp__(other) != 0
 127
 128     def __lt__(self, other):
 129         return self.__cmp__(other) < 0
 130
 131     def __le__(self, other):
 132         return self.__cmp__(other) <= 0
 133
 134     def __gt__(self, other):
 135         return self.__cmp__(other) > 0
 136
 137     def __ge__(self, other):
 138         return self.__cmp__(other) >= 0
 139
 140     def get_binary_integer(self):
 141         '''return binary part of a dsdb_Dn as an integer, or None'''
 142         if self.prefix == '':
 143             return None
 144         return int(self.binary, 16)
 145
 146     def get_bytes(self):
 147         '''return binary as a byte string'''
 148         return binascii.unhexlify(self.binary)