Skip to content

ldif.LDIFParser support for add and delete operations added. #567 #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fager wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ldif.LDIFParser support for add and delete operations added. #567 #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 119 additions & 7 deletions Lib/ldif.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
0:'add',1:'delete',2:'replace',3:'increment'
}

CHANGE_TYPES = ['add','delete','modify','modrdn']
CHANGE_TYPES = ['add','delete','modify','modrdn', 'moddn', 'rename']
valid_changetype_dict = {}
for c in CHANGE_TYPES:
valid_changetype_dict[c]=None
Expand Down Expand Up @@ -459,6 +459,17 @@ def parse(self):
"""
return self.parse_entry_records() # parse()

def handle_add(self, dn, entry, controls=None):
"""
Process a single LDIF record representing a single add operation.
This method should be implemented by applications using LDIFParser.

Args:
dn (str): DN of the new object to be created
entry (dict): Data of the new object to be created
"""
pass

def handle_modify(self,dn,modops,controls=None):
"""
Process a single LDIF record representing a single modify operation.
Expand All @@ -467,6 +478,31 @@ def handle_modify(self,dn,modops,controls=None):
controls = [] or None
pass

def handle_modrdn(self, dn, newrdn, deleteoldrdn=False, newsuperior=None,
controls=None):
"""
Process a single LDIF record representing a single modrdn/rename operation.
This method should be implemented by applications using LDIFParser.

Args:
dn (str): DN of the existing object to be renamed/moved
newrdn (str): RDN of the new object
deleteoldrdn (bool): Whether the old RDN value(s) should be removed
from the entry
newsuperior (str): DN of the new parent
"""
pass

def handle_delete(self, dn, controls=None):
"""
Process a single LDIF record representing a single delete operation.
This method should be implemented by applications using LDIFParser.

Args:
dn (str): DN of the existing object to be deleted
"""
pass

def parse_change_records(self):
# Local symbol for better performance
next_key_and_value = self._next_key_and_value
Expand Down Expand Up @@ -509,7 +545,7 @@ def parse_change_records(self):
# Consume changetype line of record
if k=='changetype':
# v is still bytes, spec says it should be valid utf-8; decode it.
v = v.decode('utf-8')
v = v.decode('utf-8').lower()
if not v in valid_changetype_dict:
raise ValueError('Invalid changetype: %s' % repr(v))
changetype = v
Expand Down Expand Up @@ -551,12 +587,60 @@ def parse_change_records(self):
except EOFError:
k,v = None,None

if modops:
# append entry to result list
self.handle_modify(dn,modops,controls)
self.handle_modify(dn, modops, controls or None)

elif changetype == 'add':
entry = {}
while k!=None:
if not k.lower() in self._ignored_attr_types:
entry.setdefault(k, []).append(v)
try:
k,v = next_key_and_value()
except EOFError:
k,v = None,None

self.handle_add(dn,entry, controls or None)

elif changetype == 'delete':
if k is not None:
raise ValueError(f'Line {self.line_counter}: Unexpected '
f'attribute {k} in LDIF delete')
self.handle_delete(dn, controls or None)
elif changetype in ('moddn', 'modrdn', 'rename'):
if k.lower() != 'newrdn':
raise ValueError(f'Line {self.line_counter}: expected "newrdn"'
f'got {k}')
newrdn = v.decode('utf-8')
k,v = next_key_and_value()
deleteoldrdn = False
if k is not None:
if k.lower() == 'deleteoldrdn':
deleteoldrdn = (v == b'1')

@droideck droideck Sep 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we require deleteoldrdn and validate that its value is exactly 0 or 1 before calling handle_modrdn? Just so stuff like deleteoldrdn: true or deleteoldrdn: 2 is not silently turned into False. Also the surrounding branches accept the field being absent.
IIUC, RFC 2849 makes this field mandatory.
So possibly we can raiseValueError for missing/invalid flags.

try:
k,v = next_key_and_value()
except EOFError:
k,v = None,None
elif k.lower() == 'newsuperior':
pass
else:
raise ValueError(f'Line {self.line_counter}: expected '
f'"deleteoldrdn" got {k}')
newsuperior = None
if k is not None:
if k.lower() != 'newsuperior':
raise ValueError(f'Line {self.line_counter}: expected '
f'"newsuperior" got {k}')
newsuperior = v.decode('utf-8')
try:
k,v = next_key_and_value()
except EOFError:
k,v = None,None
if k is not None:
raise ValueError(f'Line {self.line_counter}: {changetype} entry '
f'unexpected pseudoattribute {k}')
self.handle_modrdn(dn, newrdn, deleteoldrdn, newsuperior,
controls or None)
else:

# Consume the unhandled change record
while k!=None:
k,v = next_key_and_value()
Expand Down Expand Up @@ -592,20 +676,48 @@ def __init__(
#: List storing parsed records.
self.all_records = []
self.all_modify_changes = []
self.all_changes = []

def handle(self,dn,entry):
"""
Append a single record to the list of all records (:attr:`.all_records`).
"""
self.all_records.append((dn,entry))

def handle_add(self, dn, entry, controls=None):
"""
Process a single LDIF record representing a single add operation.
This method should be implemented by applications using LDIFParser.
"""
self.all_changes.append(('add', {'dn': dn, 'entry': entry,
'controls': controls}))

def handle_modify(self,dn,modops,controls=None):
"""
Process a single LDIF record representing a single modify operation.
This method should be implemented by applications using LDIFParser.
"""
controls = [] or None
self.all_modify_changes.append((dn,modops,controls))
self.all_changes.append(('modify', {'dn': dn, 'modops': modops,
'controls': controls}))

def handle_modrdn(self, dn, newrdn, deleteoldrdn=False, newsuperior=None,
controls=None):
"""
Process a single LDIF record representing a single modrdn/rename operation.
This method should be implemented by applications using LDIFParser.
"""
self.all_changes.append(('modrdn', {'dn': dn, 'newrdn': newrdn,
'deleteoldrdn': deleteoldrdn,
'newsuperior': newsuperior,
'controls': controls}))

def handle_delete(self, dn, controls=None):
"""
Process a single LDIF record representing a single delete operation.
This method should be implemented by applications using LDIFParser.
"""
self.all_changes.append(('delete', {'dn': dn, 'controls': controls}))


class LDIFCopy(LDIFParser):
Expand Down
Loading