kocoded/oqtane.framework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

user import improvements

Browse Source
This commit is contained in:
sbwalker 2023-09-21 09:37:29 -04:00
parent 44f093b2fa
commit 98257de005
9 changed files with 131 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Oqtane.Client/Modules/Admin/Users/Users.razor
View File

@ -7,16 +7,16 @@
<div class="container"> <div class="container">
<div class="row mb-1 align-items-center"> <div class="row mb-1 align-items-center">
<Label Class="col-sm-3" For="userfile" HelpText="Select or upload a CSV file containing user information. The CSV file must be in the Template format specified." ResourceKey="UserFile">User File:</Label> <Label Class="col-sm-3" For="importfile" HelpText="Upload or select a tab delimited text file containing user information. The file must be in the Template format specified (Roles can be specified as a comma delimited list)." ResourceKey="ImportFile">Import File:</Label>
<div class="col-sm-9"> <div class="col-sm-9">
<FileManager Id="userfile" @ref="_filemanager" Filter="csv" /> <FileManager Id="importfile" @ref="_filemanager" Filter="txt" />
</div> </div>
</div> </div>
</div> </div>
<br /> <br />
<button type="button" class="btn btn-success" @onclick="ImportUsers">@Localizer["Import"]</button>&nbsp; <button type="button" class="btn btn-success" @onclick="ImportUsers">@Localizer["Import"]</button>&nbsp;
<NavLink class="btn btn-secondary" href="@NavigateUrl()">@SharedLocalizer["Cancel"]</NavLink>&nbsp; <NavLink class="btn btn-secondary" href="@NavigateUrl()">@SharedLocalizer["Cancel"]</NavLink>&nbsp;
<a class="btn btn-info" href="/users.csv" target="_new">@Localizer["Template"]</a> <a class="btn btn-info" href="/users.txt" target="_new">@Localizer["Template"]</a>
@code { @code {
private FileManager _filemanager; private FileManager _filemanager;
@ -32,14 +32,17 @@
var fileid = _filemanager.GetFileId(); var fileid = _filemanager.GetFileId();
if (fileid != -1) if (fileid != -1)
{ {
if (await UserService.ImportUsersAsync(PageState.Site.SiteId, fileid)) ShowProgressIndicator();
var results = await UserService.ImportUsersAsync(PageState.Site.SiteId, fileid);
if (bool.Parse(results["Success"]))
{ {
AddModuleMessage(Localizer["Message.Import.Success"], MessageType.Success); AddModuleMessage(string.Format(Localizer["Message.Import.Success"], results["Rows"], results["Users"]), MessageType.Success);
} }
else else
{ {
AddModuleMessage(Localizer["Message.Import.Failure"], MessageType.Error); AddModuleMessage(Localizer["Message.Import.Failure"], MessageType.Error);
} }
HideProgressIndicator();
} }
else else
{ {

12
Oqtane.Client/Resources/Modules/Admin/Users/Users.resx
View File

@ -117,11 +117,11 @@
<resheader name="writer"> <resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value> <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader> </resheader>
<data name="UserFile.HelpText" xml:space="preserve"> <data name="ImportFile.HelpText" xml:space="preserve">
<value>Select or upload a CSV file containing user information. The CSV file must be in the Template format specified.</value> <value>Upload or select a tab delimited text file containing user information. The file must be in the Template format specified (Roles can be specified as a comma delimited list).</value>
</data> </data>
<data name="UserFile.Text" xml:space="preserve"> <data name="ImportFile.Text" xml:space="preserve">
<value>User File:</value> <value>Import File:</value>
</data> </data>
<data name="Error.Import" xml:space="preserve"> <data name="Error.Import" xml:space="preserve">
<value>Error Importing Users</value> <value>Error Importing Users</value>
@ -130,10 +130,10 @@
<value>Import</value> <value>Import</value>
</data> </data>
<data name="Message.Import.Failure" xml:space="preserve"> <data name="Message.Import.Failure" xml:space="preserve">
<value>User Import Failed</value> <value>User Import Failed. Please Review Your Event Log For More Detailed Information.</value>
</data> </data>
<data name="Message.Import.Success" xml:space="preserve"> <data name="Message.Import.Success" xml:space="preserve">
<value>Users Imported Successfully</value> <value>Users Imported Successfully. {0} Rows Processed, {1} Users Imported.</value>
</data> </data>
<data name="Message.Import.Validation" xml:space="preserve"> <data name="Message.Import.Validation" xml:space="preserve">
<value>You Must Specify A User File For Import</value> <value>You Must Specify A User File For Import</value>

2
Oqtane.Client/Services/Interfaces/IUserService.cs
View File

@ -148,6 +148,6 @@ namespace Oqtane.Services
/// </summary> /// </summary>
/// <param name="fileId">ID of a <see cref="File"/></param> /// <param name="fileId">ID of a <see cref="File"/></param>
/// <returns></returns> /// <returns></returns>
Task<bool> ImportUsersAsync(int siteId, int fileId); Task<Dictionary<string, string>> ImportUsersAsync(int siteId, int fileId);
} }
} }

4
Oqtane.Client/Services/UserService.cs
View File

@ -127,9 +127,9 @@ namespace Oqtane.Services
return string.Format(passwordValidationCriteriaTemplate, minimumlength, uniquecharacters, digitRequirement, uppercaseRequirement, lowercaseRequirement, punctuationRequirement); return string.Format(passwordValidationCriteriaTemplate, minimumlength, uniquecharacters, digitRequirement, uppercaseRequirement, lowercaseRequirement, punctuationRequirement);
} }
public async Task<bool> ImportUsersAsync(int siteId, int fileId) public async Task<Dictionary<string, string>> ImportUsersAsync(int siteId, int fileId)
{ {
return await PostJsonAsync<bool>($"{Apiurl}/import?siteid={siteId}&fileid={fileId}", true); return await PostJsonAsync<Dictionary<string, string>>($"{Apiurl}/import?siteid={siteId}&fileid={fileId}", null);
} }
} }
} }

4
Oqtane.Server/Controllers/UserController.cs
View File

@ -375,7 +375,7 @@ namespace Oqtane.Controllers
// POST api/<controller>/import?siteid=x&fileid=y // POST api/<controller>/import?siteid=x&fileid=y
[HttpPost("import")] [HttpPost("import")]
[Authorize(Roles = RoleNames.Admin)] [Authorize(Roles = RoleNames.Admin)]
public async Task<bool> Import(string siteid, string fileid) public async Task<Dictionary<string, string>> Import(string siteid, string fileid)
{ {
if (int.TryParse(siteid, out int SiteId) && SiteId == _tenantManager.GetAlias().SiteId && int.TryParse(fileid, out int FileId)) if (int.TryParse(siteid, out int SiteId) && SiteId == _tenantManager.GetAlias().SiteId && int.TryParse(fileid, out int FileId))
{ {
@ -385,7 +385,7 @@ namespace Oqtane.Controllers
{ {
_logger.Log(LogLevel.Error, this, LogFunction.Security, "Unauthorized User Import Attempt {SiteId} {FileId}", siteid, fileid); _logger.Log(LogLevel.Error, this, LogFunction.Security, "Unauthorized User Import Attempt {SiteId} {FileId}", siteid, fileid);
HttpContext.Response.StatusCode = (int)HttpStatusCode.Forbidden; HttpContext.Response.StatusCode = (int)HttpStatusCode.Forbidden;
return false; return null;
} }
} }
} }

3
Oqtane.Server/Managers/Interfaces/IUserManager.cs
View File

@ -1,3 +1,4 @@
using System.Collections.Generic;
using System.Threading.Tasks; using System.Threading.Tasks;
using Oqtane.Models; using Oqtane.Models;
@ -18,6 +19,6 @@ namespace Oqtane.Managers
User VerifyTwoFactor(User user, string token); User VerifyTwoFactor(User user, string token);
Task<User> LinkExternalAccount(User user, string token, string type, string key, string name); Task<User> LinkExternalAccount(User user, string token, string type, string key, string name);
Task<bool> ValidatePassword(string password); Task<bool> ValidatePassword(string password);
Task<bool> ImportUsers(int siteId, int fileId); Task<Dictionary<string, string>> ImportUsers(int siteId, int fileId);
} }
} }

185
Oqtane.Server/Managers/UserManager.cs
View File

@ -1,5 +1,4 @@
using System; using System;
using System.Collections;
using System.Collections.Generic; using System.Collections.Generic;
using System.Globalization; using System.Globalization;
using System.IO; using System.IO;
@ -461,9 +460,10 @@ namespace Oqtane.Managers
return result.Succeeded; return result.Succeeded;
} }
public async Task<bool> ImportUsers(int siteId, int fileId) public async Task<Dictionary<string, string>> ImportUsers(int siteId, int fileId)
{ {
var success = true; var success = true;
int rows = 0;
int users = 0; int users = 0;
var file = _files.GetFile(fileId); var file = _files.GetFile(fileId);
@ -477,127 +477,160 @@ namespace Oqtane.Managers
try try
{ {
string row; string row = "";
using (var reader = new StreamReader(path)) using (var reader = new StreamReader(path))
{ {
// get header row // header row
row = reader.ReadLine(); if (reader.Peek() > -1)
var header = row.Replace("\"", "").Split(',');
row = reader.ReadLine();
while (row != null)
{ {
var values = row.Replace("\"", "").Split(','); row = reader.ReadLine();
}
if (values.Length > 3) if (!string.IsNullOrEmpty(row.Trim()))
{
var header = row.Replace("\"", "").Split('\t');
// detail rows
while (reader.Peek() > -1)
{ {
// user row = reader.ReadLine();
var user = _users.GetUser(values[1], values[0]); rows++;
if (user == null)
if (!string.IsNullOrEmpty(row.Trim()))
{ {
user = new User(); var values = row.Replace("\"", "").Split('\t');
user.SiteId = siteId;
user.Email = values[0]; // user
user.Username = (!string.IsNullOrEmpty(values[1])) ? values[1] : user.Email; var email = (values.Length > 0) ? values[0].Trim() : "";
user.DisplayName = (!string.IsNullOrEmpty(values[2])) ? values[2] : user.Username; var username = (values.Length > 1) ? values[1].Trim() : "";
user = await AddUser(user); var displayname = (values.Length > 2) ? values[2].Trim() : "";
var user = _users.GetUser(username, email);
if (user == null) if (user == null)
{ {
_logger.Log(LogLevel.Error, this, LogFunction.Create, "Error Creating User {Email}", values[0]); user = new User();
success = false; user.SiteId = siteId;
} user.Email = values[0];
} user.Username = (!string.IsNullOrEmpty(username)) ? username : user.Email;
user.DisplayName = (!string.IsNullOrEmpty(displayname)) ? displayname : user.Username;
if (user != null && !string.IsNullOrEmpty(values[3])) user = await AddUser(user);
{ if (user == null)
// roles (comma delimited)
foreach (var rolename in values[3].Split(','))
{
var role = roles.FirstOrDefault(item => item.Name == rolename);
if (role == null)
{ {
role = new Role(); _logger.Log(LogLevel.Error, this, LogFunction.Create, "Error Importing User {Email} {Username} {DisplayName}", email, username, displayname);
role.SiteId = siteId; success = false;
role.Name = rolename;
role.Description = rolename;
role = _roles.AddRole(role);
roles.Add(role);
} }
if (role != null) }
else
{
if (!string.IsNullOrEmpty(displayname))
{ {
var userrole = _userRoles.GetUserRole(user.UserId, role.RoleId, false); user.DisplayName = displayname;
if (userrole == null) user = await UpdateUser(user);
}
}
var rolenames = (values.Length > 3) ? values[3].Trim() : "";
if (user != null && !string.IsNullOrEmpty(rolenames))
{
// roles (comma delimited)
foreach (var rolename in rolenames.Split(','))
{
var role = roles.FirstOrDefault(item => item.Name == rolename.Trim());
if (role == null)
{ {
userrole = new UserRole(); role = new Role();
userrole.UserId = user.UserId; role.SiteId = siteId;
userrole.RoleId = role.RoleId; role.Name = rolename.Trim();
_userRoles.AddUserRole(userrole); role.Description = rolename.Trim();
role = _roles.AddRole(role);
roles.Add(role);
}
if (role != null)
{
var userrole = _userRoles.GetUserRole(user.UserId, role.RoleId, false);
if (userrole == null)
{
userrole = new UserRole();
userrole.UserId = user.UserId;
userrole.RoleId = role.RoleId;
_userRoles.AddUserRole(userrole);
}
} }
} }
} }
}
if (user != null && values.Length > 4) if (user != null && values.Length > 4)
{
var settings = _settings.GetSettings(EntityNames.User, user.UserId);
for (int index = 4; index < values.Length - 1; index++)
{ {
if (header.Length > index && !string.IsNullOrEmpty(values[index])) // profiles
var settings = _settings.GetSettings(EntityNames.User, user.UserId);
for (int index = 4; index < values.Length - 1; index++)
{ {
var profile = profiles.FirstOrDefault(item => item.Name == header[index]); if (header.Length > index && !string.IsNullOrEmpty(values[index].Trim()))
if (profile != null)
{ {
var setting = settings.FirstOrDefault(item => item.SettingName == profile.Name); var profile = profiles.FirstOrDefault(item => item.Name == header[index].Trim());
if (setting == null) if (profile != null)
{ {
setting = new Setting(); var setting = settings.FirstOrDefault(item => item.SettingName == profile.Name);
setting.EntityName = EntityNames.User; if (setting == null)
setting.EntityId = user.UserId;
setting.SettingName = profile.Name;
setting.SettingValue = values[index];
_settings.AddSetting(setting);
}
else
{
if (setting.SettingValue != values[index])
{ {
setting.SettingValue = values[index]; setting = new Setting();
_settings.UpdateSetting(setting); setting.EntityName = EntityNames.User;
setting.EntityId = user.UserId;
setting.SettingName = profile.Name;
setting.SettingValue = values[index].Trim();
_settings.AddSetting(setting);
}
else
{
if (setting.SettingValue != values[index].Trim())
{
setting.SettingValue = values[index].Trim();
_settings.UpdateSetting(setting);
}
} }
} }
} }
} }
} }
users++;
} }
users++;
} }
}
row = reader.ReadLine(); else
{
success = false;
_logger.Log(LogLevel.Error, this, LogFunction.Create, "User Import File Contains No Header Row");
} }
} }
_logger.Log(LogLevel.Information, this, LogFunction.Create, "{Users} Users Imported", users); _logger.Log(LogLevel.Information, this, LogFunction.Create, "User Import: {Rows} Rows Processed, {Users} Users Imported", rows, users);
} }
catch (Exception ex) catch (Exception ex)
{ {
_logger.Log(LogLevel.Error, this, LogFunction.Create, ex, "Error Importing User Import File {SiteId} {FileId}", siteId, fileId);
success = false; success = false;
_logger.Log(LogLevel.Error, this, LogFunction.Create, ex, "Error Importing User Import File {SiteId} {FileId}", siteId, fileId);
} }
} }
else else
{ {
_logger.Log(LogLevel.Error, this, LogFunction.Create,"User Import File Does Not Exist {Path}", path);
success = false; success = false;
_logger.Log(LogLevel.Error, this, LogFunction.Create, "User Import File Does Not Exist {Path}", path);
} }
} }
else else
{ {
_logger.Log(LogLevel.Error, this, LogFunction.Create, "User Import File Does Not Exist {SiteId} {FileId}", siteId, fileId);
success = false; success = false;
_logger.Log(LogLevel.Error, this, LogFunction.Create, "User Import File Does Not Exist {SiteId} {FileId}", siteId, fileId);
} }
return success; // return results
var result = new Dictionary<string, string>();
result.Add("Success", success.ToString());
result.Add("Rows", rows.ToString());
result.Add("Users", users.ToString());
return result;
} }
} }
} }

1
Oqtane.Server/wwwroot/users.csv
View File

@ -1 +0,0 @@
Email,Username,DisplayName,Roles,FirstName,LastName,Street,City,Region,Country,PostalCode,Phone
1 Email Username DisplayName Roles FirstName LastName Street City Region Country PostalCode Phone

1
Oqtane.Server/wwwroot/users.txt Normal file
View File

@ -0,0 +1 @@
Email Username DisplayName Roles FirstName LastName Street City Region Country PostalCode Phone