source4/scripting/python/samba/common.py

   1 #!/usr/bin/env python
   2 #
   3 # Samba common functions
   4 #
   5 # Copyright (C) Matthieu Patou <mat@matws.net>
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20
  21 import ldb, dsdb
  22
  23 def confirm(msg, forced=False, allow_all=False):
  24     """confirm an action with the user
  25
  26     :param msg: A string to print to the user
  27     :param forced: Are the answer forced
  28     """
  29     if forced:
  30         print("%s [YES]" % msg)
  31         return True
  32
  33     mapping = {
  34         'Y': True,
  35         'YES': True,
  36         '': False,
  37         'N': False,
  38         'NO': False,
  39         }
  40
  41     prompt = '[y/N]'
  42
  43     if allow_all:
  44         mapping['ALL'] = 'ALL'
  45         mapping['NONE'] = 'NONE'
  46         prompt = '[y/N/all/none]'
  47
  48     while True:
  49         v = raw_input(msg + ' %s ' % prompt)
  50         v = v.upper()
  51         if v in mapping:
  52             return mapping[v]
  53         print("Unknown response '%s'" % v)
  54
  55
  56 def normalise_int32(ivalue):
  57     '''normalise a ldap integer to signed 32 bit'''
  58     if int(ivalue) & 0x80000000 and int(ivalue) > 0:
  59         return str(int(ivalue) - 0x100000000)
  60     return str(ivalue)
  61
  62
  63 class dsdb_Dn(object):
  64     '''a class for binary DN'''
  65
  66     def __init__(self, samdb, dnstring, syntax_oid=None):
  67         '''create a dsdb_Dn'''
  68         if syntax_oid is None:
  69             # auto-detect based on string
  70             if dnstring.startswith("B:"):
  71                 syntax_oid = dsdb.DSDB_SYNTAX_BINARY_DN
  72             elif dnstring.startswith("S:"):
  73                 syntax_oid = dsdb.DSDB_SYNTAX_STRING_DN
  74             else:
  75                 syntax_oid = dsdb.DSDB_SYNTAX_OR_NAME
  76         if syntax_oid in [ dsdb.DSDB_SYNTAX_BINARY_DN, dsdb.DSDB_SYNTAX_STRING_DN ]:
  77             # it is a binary DN
  78             colons = dnstring.split(':')
  79             if len(colons) < 4:
  80                 raise RuntimeError("Invalid DN %s" % dnstring)
  81             prefix_len = 4 + len(colons[1]) + int(colons[1])
  82             self.prefix = dnstring[0:prefix_len]
  83             self.binary = self.prefix[4:-1]
  84             self.dnstring = dnstring[prefix_len:]
  85         else:
  86             self.dnstring = dnstring
  87             self.prefix = ''
  88             self.binary = ''
  89         self.dn = ldb.Dn(samdb, self.dnstring)
  90
  91     def __str__(self):
  92         return self.prefix + str(self.dn.extended_str(mode=1))
  93
  94     def get_binary_integer(self):
  95         '''return binary part of a dsdb_Dn as an integer, or None'''
  96         if self.prefix == '':
  97             return None
  98         return int(self.binary, 16)