]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
netcmd: user: move user edit command
authorRob van der Linde <rob@catalyst.net.nz>
Thu, 27 Jul 2023 05:09:23 +0000 (17:09 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Fri, 4 Aug 2023 04:31:37 +0000 (04:31 +0000)
Signed-off-by: Rob van der Linde <rob@catalyst.net.nz>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
python/samba/netcmd/user/__init__.py
python/samba/netcmd/user/edit.py [new file with mode: 0644]

index fb6a429437529ffa7246fb3182422d55821140ed..9476763ddea84a97678afbac4caa360c34d809e7 100644 (file)
@@ -19,8 +19,6 @@
 
 import samba.getopt as options
 import ldb
-import os
-from subprocess import check_call, CalledProcessError
 from samba.auth import system_session
 from samba.samdb import SamDB, SamDBError
 from samba import (
@@ -34,7 +32,6 @@ from samba.netcmd import (
     Option,
     common
 )
-from samba.common import get_bytes
 
 from .add import cmd_user_add
 from .common import (
@@ -48,6 +45,7 @@ from .common import (
 )
 from .delete import cmd_user_delete
 from .disable import cmd_user_disable
+from .edit import cmd_user_edit
 from .enable import cmd_user_enable
 from .getgroups import cmd_user_getgroups
 from .getpassword import cmd_user_getpassword, cmd_user_syncpasswords
@@ -58,113 +56,6 @@ from .setpassword import cmd_user_setpassword
 from .setprimarygroup import cmd_user_setprimarygroup
 
 
-class cmd_user_edit(Command):
-    """Modify User AD object.
-
-This command will allow editing of a user account in the Active Directory
-domain. You will then be able to add or change attributes and their values.
-
-The username specified on the command is the sAMAccountName.
-
-The command may be run from the root userid or another authorized userid.
-
-The -H or --URL= option can be used to execute the command against a remote
-server.
-
-Example1:
-samba-tool user edit User1 -H ldap://samba.samdom.example.com \\
-    -U administrator --password=passw1rd
-
-Example1 shows how to edit a users attributes in the domain against a remote
-LDAP server.
-
-The -H parameter is used to specify the remote target server.
-
-Example2:
-samba-tool user edit User2
-
-Example2 shows how to edit a users attributes in the domain against a local
-LDAP server.
-
-Example3:
-samba-tool user edit User3 --editor=nano
-
-Example3 shows how to edit a users attributes in the domain against a local
-LDAP server using the 'nano' editor.
-
-"""
-    synopsis = "%prog <username> [options]"
-
-    takes_options = [
-        Option("-H", "--URL", help="LDB URL for database or target server",
-               type=str, metavar="URL", dest="H"),
-        Option("--editor", help="Editor to use instead of the system default,"
-               " or 'vi' if no system default is set.", type=str),
-    ]
-
-    takes_args = ["username"]
-    takes_optiongroups = {
-        "sambaopts": options.SambaOptions,
-        "credopts": options.CredentialsOptions,
-        "versionopts": options.VersionOptions,
-    }
-
-    def run(self, username, credopts=None, sambaopts=None, versionopts=None,
-            H=None, editor=None):
-        lp = sambaopts.get_loadparm()
-        creds = credopts.get_credentials(lp, fallback_machine=True)
-        samdb = SamDB(url=H, session_info=system_session(),
-                      credentials=creds, lp=lp)
-
-        filter = ("(&(sAMAccountType=%d)(sAMAccountName=%s))" %
-                  (dsdb.ATYPE_NORMAL_ACCOUNT, ldb.binary_encode(username)))
-
-        domaindn = samdb.domain_dn()
-
-        try:
-            res = samdb.search(base=domaindn,
-                               expression=filter,
-                               scope=ldb.SCOPE_SUBTREE)
-            user_dn = res[0].dn
-        except IndexError:
-            raise CommandError('Unable to find user "%s"' % (username))
-
-        import tempfile
-        for msg in res:
-            result_ldif = common.get_ldif_for_editor(samdb, msg)
-
-            if editor is None:
-                editor = os.environ.get('EDITOR')
-                if editor is None:
-                    editor = 'vi'
-
-            with tempfile.NamedTemporaryFile(suffix=".tmp") as t_file:
-                t_file.write(get_bytes(result_ldif))
-                t_file.flush()
-                try:
-                    check_call([editor, t_file.name])
-                except CalledProcessError as e:
-                    raise CalledProcessError("ERROR: ", e)
-                with open(t_file.name) as edited_file:
-                    edited_message = edited_file.read()
-
-
-        msgs_edited = samdb.parse_ldif(edited_message)
-        msg_edited = next(msgs_edited)[1]
-
-        res_msg_diff = samdb.msg_diff(msg, msg_edited)
-        if len(res_msg_diff) == 0:
-            self.outf.write("Nothing to do\n")
-            return
-
-        try:
-            samdb.modify(res_msg_diff)
-        except Exception as e:
-            raise CommandError("Failed to modify user '%s': " % username, e)
-
-        self.outf.write("Modified User '%s' successfully\n" % username)
-
-
 class cmd_user_show(GetPasswordCommand):
     """Display a user AD object.
 
diff --git a/python/samba/netcmd/user/edit.py b/python/samba/netcmd/user/edit.py
new file mode 100644 (file)
index 0000000..c6d445a
--- /dev/null
@@ -0,0 +1,137 @@
+# user management
+#
+# user edit command
+#
+# Copyright Jelmer Vernooij 2010 <jelmer@samba.org>
+# Copyright Theresa Halloran 2011 <theresahalloran@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+import os
+from subprocess import CalledProcessError, check_call
+
+import samba.getopt as options
+from samba import dsdb, ldb
+from samba.auth import system_session
+from samba.common import get_bytes
+from samba.netcmd import Command, CommandError, Option, common
+from samba.samdb import SamDB
+
+
+class cmd_user_edit(Command):
+    """Modify User AD object.
+
+This command will allow editing of a user account in the Active Directory
+domain. You will then be able to add or change attributes and their values.
+
+The username specified on the command is the sAMAccountName.
+
+The command may be run from the root userid or another authorized userid.
+
+The -H or --URL= option can be used to execute the command against a remote
+server.
+
+Example1:
+samba-tool user edit User1 -H ldap://samba.samdom.example.com \\
+    -U administrator --password=passw1rd
+
+Example1 shows how to edit a users attributes in the domain against a remote
+LDAP server.
+
+The -H parameter is used to specify the remote target server.
+
+Example2:
+samba-tool user edit User2
+
+Example2 shows how to edit a users attributes in the domain against a local
+LDAP server.
+
+Example3:
+samba-tool user edit User3 --editor=nano
+
+Example3 shows how to edit a users attributes in the domain against a local
+LDAP server using the 'nano' editor.
+
+"""
+    synopsis = "%prog <username> [options]"
+
+    takes_options = [
+        Option("-H", "--URL", help="LDB URL for database or target server",
+               type=str, metavar="URL", dest="H"),
+        Option("--editor", help="Editor to use instead of the system default,"
+               " or 'vi' if no system default is set.", type=str),
+    ]
+
+    takes_args = ["username"]
+    takes_optiongroups = {
+        "sambaopts": options.SambaOptions,
+        "credopts": options.CredentialsOptions,
+        "versionopts": options.VersionOptions,
+    }
+
+    def run(self, username, credopts=None, sambaopts=None, versionopts=None,
+            H=None, editor=None):
+        lp = sambaopts.get_loadparm()
+        creds = credopts.get_credentials(lp, fallback_machine=True)
+        samdb = SamDB(url=H, session_info=system_session(),
+                      credentials=creds, lp=lp)
+
+        filter = ("(&(sAMAccountType=%d)(sAMAccountName=%s))" %
+                  (dsdb.ATYPE_NORMAL_ACCOUNT, ldb.binary_encode(username)))
+
+        domaindn = samdb.domain_dn()
+
+        try:
+            res = samdb.search(base=domaindn,
+                               expression=filter,
+                               scope=ldb.SCOPE_SUBTREE)
+            user_dn = res[0].dn
+        except IndexError:
+            raise CommandError('Unable to find user "%s"' % (username))
+
+        import tempfile
+        for msg in res:
+            result_ldif = common.get_ldif_for_editor(samdb, msg)
+
+            if editor is None:
+                editor = os.environ.get('EDITOR')
+                if editor is None:
+                    editor = 'vi'
+
+            with tempfile.NamedTemporaryFile(suffix=".tmp") as t_file:
+                t_file.write(get_bytes(result_ldif))
+                t_file.flush()
+                try:
+                    check_call([editor, t_file.name])
+                except CalledProcessError as e:
+                    raise CalledProcessError("ERROR: ", e)
+                with open(t_file.name) as edited_file:
+                    edited_message = edited_file.read()
+
+
+        msgs_edited = samdb.parse_ldif(edited_message)
+        msg_edited = next(msgs_edited)[1]
+
+        res_msg_diff = samdb.msg_diff(msg, msg_edited)
+        if len(res_msg_diff) == 0:
+            self.outf.write("Nothing to do\n")
+            return
+
+        try:
+            samdb.modify(res_msg_diff)
+        except Exception as e:
+            raise CommandError("Failed to modify user '%s': " % username, e)
+
+        self.outf.write("Modified User '%s' successfully\n" % username)