Chore: use template only for letter

Author: dorianim

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/config.py

@@ -31,8 +31,8 @@ def shares():
     if config is not None and "shares" in config:
         sharesConfig = config["shares"]
 
-    if not "nameTemplate" in sharesConfig:
-        sharesConfig["nameTemplate"] = constants.defaultShareNameTemplate
+    if not "letterTemplate" in sharesConfig:
+        sharesConfig["letterTemplate"] = constants.defaultShareLetterTemplate
 
     return sharesConfig
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/constants.py

@@ -10,7 +10,7 @@
 shareMountBasepath = "/home/{}/media"
 hiddenShareMountBasepath = "/srv/samba/{}"
 machineAccountSysvolMountPath = "/var/lib/samba/sysvol"
-defaultShareNameTemplate = "{label} ({letter}:)"
+defaultShareLetterTemplate = " ({letter}:)"
 
 etcBaseDir = "/etc/linuxmuster-linuxclient7"
 shareBaseDir = "/usr/share/linuxmuster-linuxclient7"

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/gpo.py

@@ -239,8 +239,8 @@ def _processDrivesPolicy(policyBasepath):
 
     for drive in shareList:
         if drive["useLetter"] == "1":
-            nameTemplate = config.shares()["nameTemplate"]
-            shareName = nameTemplate.format(label=drive['label'], letter=drive['letter'])
+            formattedLetter = config.shares()["letterTemplate"].format(letter=drive['letter'])
+            shareName = f"{drive['label']}{formattedLetter}"
         else:
             shareName = drive["label"]
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/config.yml

@@ -1,5 +1,5 @@
 shares:
-  nameTemplate: "{label}_{letter}"
+  letterTemplate: "_{letter}"
 
 network:
   serverHostname: server.linuxmuster.lan

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/test_config.py

@@ -50,22 +50,22 @@ def test_network_invalid():
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{MOCK_FILE_PATH}/config.yml")
 def test_shares():
     sharesConfig = config.shares()
-    assert "nameTemplate" in sharesConfig
-    assert sharesConfig["nameTemplate"] == "{label}_{letter}"
+    assert "letterTemplate" in sharesConfig
+    assert sharesConfig["letterTemplate"] == "_{letter}"
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"/does/not/exist/config.yml")
 def test_shares_none():
     sharesConfig = config.shares()
-    assert "nameTemplate" in sharesConfig
-    assert sharesConfig["nameTemplate"] == config.constants.defaultShareNameTemplate
+    assert "letterTemplate" in sharesConfig
+    assert sharesConfig["letterTemplate"] == config.constants.defaultShareLetterTemplate
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{MOCK_FILE_PATH}/config.no-shares.yml")
 def test_shares_missing():
     sharesConfig = config.shares()
-    assert "nameTemplate" in sharesConfig
-    assert sharesConfig["nameTemplate"] == config.constants.defaultShareNameTemplate
+    assert "letterTemplate" in sharesConfig
+    assert sharesConfig["letterTemplate"] == config.constants.defaultShareLetterTemplate
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{MOCK_FILE_PATH}/config.invalid-syntax.yml")
@@ -91,7 +91,7 @@ def test_writeNetworkConfig():
     assert networkConfig["serverHostname"] == "server.linuxmuster.new"
     assert networkConfig["domain"] == "linuxmuster.new"
     assert networkConfig["realm"] == "LINUXMUSTER.NEW"
-    assert config.shares() == {"nameTemplate": "{label}_{letter}"}
+    assert config.shares() == {"letterTemplate": "_{letter}"}
 
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"/tmp/config.yml")
@@ -206,7 +206,7 @@ def test_deleteNetworkConfig():
     assert config.deleteNetworkConfig()
     assert os.path.exists("/tmp/config.yml")
     assert config.network() == (False, None)
-    assert config.shares() == {"nameTemplate": "{label}_{letter}"}
+    assert config.shares() == {"letterTemplate": "_{letter}"}
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"/does/not/exist/config.yml")

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/test_gpo.py

@@ -54,7 +54,7 @@ def test_allOkAllTrue(mockUserSchool, mockLdapHelperSearchOne, mockSharesGetMoun
 @mock.patch("linuxmusterLinuxclient7.gpo.shares.getMountpointOfRemotePath")
 @mock.patch("linuxmusterLinuxclient7.gpo.ldapHelper.searchOne")
 @mock.patch("linuxmusterLinuxclient7.gpo.user.school")
-def test_customShareNameTemplate(mockUserSchool, mockLdapHelperSearchOne, mockSharesGetMountpointOfRemotePath, mockSharesmMountShare, mockPrintersInstallPrinter, mockUserIsInGroup, mockComputerIsInGroup, mockConfigShares):
+def test_customShareLetterTemplate(mockUserSchool, mockLdapHelperSearchOne, mockSharesGetMountpointOfRemotePath, mockSharesmMountShare, mockPrintersInstallPrinter, mockUserIsInGroup, mockComputerIsInGroup, mockConfigShares):
     mockUserSchool.return_value = (True, "school1")
     mockLdapHelperSearchOne.return_value = (True, {
         "distinguishedName": "policy1",
@@ -66,7 +66,7 @@ def test_customShareNameTemplate(mockUserSchool, mockLdapHelperSearchOne, mockSh
     mockUserIsInGroup.return_value = True
     mockComputerIsInGroup.return_value = True
     mockConfigShares.return_value = {
-        "nameTemplate": "{label}_{letter}"
+        "letterTemplate": "_{letter}"
     }
 
     assert gpo.processAllPolicies()
@@ -78,7 +78,7 @@ def test_customShareNameTemplate(mockUserSchool, mockLdapHelperSearchOne, mockSh
 
     # Test without letter
     mockConfigShares.return_value = {
-        "nameTemplate": "{label}"
+        "letterTemplate": ""
     }
     assert gpo.processAllPolicies()
     assert len(mockSharesmMountShare.call_args_list) == 6

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/test_user.py

@@ -140,11 +140,11 @@ def test_getHomeShareMountpoint(mockUsername, mockReadAttributes):
 @mock.patch("linuxmusterLinuxclient7.gpo.config.shares")
 @mock.patch("linuxmusterLinuxclient7.user.readAttributes")
 @mock.patch("linuxmusterLinuxclient7.user.username")
-def test_getHomeShareMountpointCustomShareNameTemplate(mockUsername, mockReadAttributes, mockConfigShares):
+def test_getHomeShareMountpointCustomShareLetterTemplate(mockUsername, mockReadAttributes, mockConfigShares):
     mockUsername.return_value = "user1"
     mockReadAttributes.return_value = (True, {"homeDrive": "H:"})
     mockConfigShares.return_value = {
-        "nameTemplate": "{label}_{letter}"
+        "letterTemplate": "_{letter}"
     }
 
     rc, homeShareMountpoint = user.getHomeShareMountpoint()
@@ -153,7 +153,7 @@ def test_getHomeShareMountpointCustomShareNameTemplate(mockUsername, mockReadAtt
 
     # Test without letter
     mockConfigShares.return_value = {
-        "nameTemplate": "{label}"
+        "letterTemplate": ""
     }
     rc, homeShareMountpoint = user.getHomeShareMountpoint()
     assert rc

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/user.py

@@ -146,9 +146,9 @@ def _getHomeShareName(userAttributes=None):
 
     if rc:
         try:
-            nameTemplate = config.shares()["nameTemplate"]
             letter = userAttributes['homeDrive'].replace(':', '')
-            shareName = nameTemplate.format(label=username(), letter=letter)
+            formattedLetter = config.shares()["letterTemplate"].format(letter=letter)
+            shareName = f"{username()}{formattedLetter}"
             return True, shareName
 
         except Exception as e:

wiki/Usage/Configuration.md

@@ -3,13 +3,12 @@
   - using the linuxmuster-webui `client configuration -> Drives` menu
   - using gpedit on a Windows client
   - modifying the file `/var/lib/samba/sysvol/linuxmuster.lan/Policies/{someUUID}/User/Preferences/Drives/Drives.xml` on the linuxmuster server. (Replace `someUUID` with the UUID of the policy)
-- If you want to customize the naming of shares which have drive letters, you can use the `nameTemplate` parameter in the `shares`-section of the config file (`/etc/linuxmuster-linuxclient7/config.yml`):
+- If you want to customize how drive letters are formatted, you can use the `letterTemplate` parameter in the `shares`-section of the config file (`/etc/linuxmuster-linuxclient7/config.yml`):
   ```yaml
   shares:
-    nameTemplate: "{label} ({letter}:)"
+    letterTemplate: " ({letter}:)"
   ```
-  - Shares without drive letters always have the label as a name
-  - For the users home share, the label is the username
+  - The letter template is directly appended to the share label
 
 # Printers
 - Printers MUST have the same name in cups and devices.csv!