tweak(Admin/Import/User): add emailForwardOnly and generatePolicyConf…

…ormPassword - also adds docs for admin_user_import_csv_for_emailuser import definition
tine-groupware · Feb 25, 2025 · c32204b · c32204b
1 parent 56b4ada
commit c32204b
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/docs/admins/import/Import_Users.md b/docs/admins/import/Import_Users.md
@@ -1,7 +1,7 @@
-tine Admin docs: Admin
+tine Admin docs: Admin User Import
 =================
 
-Version: Pino 2022.11
+Version: Pelle 2024.11
 
 HowTo: set passwords for users
 =================
@@ -39,3 +39,16 @@ Anastasia,Baleva,[email protected],abelava
 ~~~
 method=Admin.importUser [-d] [-v] userlist.csv -- definition=admin_user_import_csv [password=PWFORALLNEWUSERS]
 ~~~
+
+HowTo: import list of users with email data and autogenerated password
+=================
+
+userlist.csv:
+~~~
+lastname,email,emailForwards,emailForwardOnly
+administrator,[email protected],[email protected] [email protected],1
+~~~
+
+~~~
+method=Admin.importUser [-d] [-v] userlist.csv -- definition=admin_user_import_csv_for_emailuser.xml
+~~~
diff --git a/tine20/Admin/Import/definitions/admin_user_import_csv_for_emailuser.xml b/tine20/Admin/Import/definitions/admin_user_import_csv_for_emailuser.xml
@@ -6,6 +6,7 @@
     <headline>1</headline>
     <dryrun>0</dryrun>
     <extension>csv</extension>
+    <passwordGenerator>\Tinebase_User_PasswordPolicy::generatePolicyConformPassword</passwordGenerator>
     <mapping>
         <field>
             <source>firstname</source>
@@ -35,5 +36,9 @@
             <source>emailForwards</source>
             <destination>emailForwards</destination>
         </field>
+        <field>
+            <source>emailForwardOnly</source>
+            <destination>emailForwardOnly</destination>
+        </field>
     </mapping>
 </config>
diff --git a/tine20/Tinebase/Model/FullUser.php b/tine20/Tinebase/Model/FullUser.php
@@ -320,7 +320,15 @@ public function applyOptionsAndGeneratePassword($options, $password = NULL)
         } elseif (! empty($options['password'])) {
             $userPassword = $options['password'];
         } elseif (! empty($options['passwordGenerator']) && is_callable($options['passwordGenerator'])) {
-            $userPassword = $options['passwordGenerator']($this);
+            if (is_string($options['passwordGenerator']) && str_contains($options['passwordGenerator'],
+                    'Tinebase_User_PasswordPolicy::generatePolicyConformPassword')
+            ) {
+                // TODO maybe the default should be a function call without param? how can we detect this?
+                $userPassword = $options['passwordGenerator']();
+            } else {
+                // passwordGenerator function expects user as its param
+                $userPassword = $options['passwordGenerator']($this);
+            }
         }
 
         $this->_addEmailUser($userPassword);

diff --git a/tine20/Tinebase/User.php b/tine20/Tinebase/User.php
@@ -1402,7 +1402,7 @@ static public function createSystemUser(string $accountLoginName, Tinebase_Model
      * @param int $upperCase
      * @return string
      *
-     * TODO should have a param "usePWPolicy"
+     * @deprecated replace with Tinebase_User_PasswordPolicy::generatePolicyConformPassword
      */
     public static function generateRandomPassword($length = 12, $numSpecialChar = 1, $upperCase = 1)
     {