Files
Umbraco-CMS/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/ExternalLoginRepository.cs
Bjarke Berg 029a261476 Improve functionality for external member logins (#11855)
* Bugfix - Take ufprt from form data if the request has form content type, otherwise fallback to use the query

* External linking for members

* Changed migration to reuse old table

* removed unnecessary web.config files

* Cleanup

* Extracted class to own file

* Clean up

* Rollback changes to Umbraco.Web.UI.csproj

* Fixed migration for SqlCE

* Change notification handler to be on deleted

* Update src/Umbraco.Infrastructure/Security/MemberUserStore.cs

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>

* Fixed issue with errors not shown on member linking

* fixed issue with errors

* clean up

* Fix issue where external logins could not be used to upgrade Umbraco, because the externalLogin table was expected to look different. (Like after the migration)

* Fixed issue in Ignore legacy column now using result column.

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>
2022-01-19 09:21:50 +01:00

310 lines
12 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Extensions.Logging;
using NPoco;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Cache;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Persistence.Querying;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Cms.Core.Security;
using Umbraco.Cms.Infrastructure.Persistence.Dtos;
using Umbraco.Cms.Infrastructure.Persistence.Factories;
using Umbraco.Cms.Infrastructure.Persistence.Querying;
using Umbraco.Extensions;
namespace Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement
{
internal class ExternalLoginRepository : EntityRepositoryBase<int, IIdentityUserLogin>, IExternalLoginRepository, IExternalLoginWithKeyRepository
{
public ExternalLoginRepository(IScopeAccessor scopeAccessor, AppCaches cache, ILogger<ExternalLoginRepository> logger)
: base(scopeAccessor, cache, logger)
{ }
/// <inheritdoc />
[Obsolete("Use method that takes guid as param")]
public void DeleteUserLogins(int memberId) => DeleteUserLogins(memberId.ToGuid());
/// <inheritdoc />
[Obsolete("Use method that takes guid as param")]
public void Save(int userId, IEnumerable<IExternalLogin> logins) => Save(userId.ToGuid(), logins);
/// <inheritdoc />
[Obsolete("Use method that takes guid as param")]
public void Save(int userId, IEnumerable<IExternalLoginToken> tokens) => Save(userId.ToGuid(), tokens);
/// <inheritdoc />
public void DeleteUserLogins(Guid userOrMemberKey) => Database.Delete<ExternalLoginDto>("WHERE userOrMemberKey=@userOrMemberKey", new { userOrMemberKey });
/// <inheritdoc />
public void Save(Guid userOrMemberKey, IEnumerable<IExternalLogin> logins)
{
var sql = Sql()
.Select<ExternalLoginDto>()
.From<ExternalLoginDto>()
.Where<ExternalLoginDto>(x => x.UserOrMemberKey == userOrMemberKey)
.ForUpdate();
// deduplicate the logins
logins = logins.DistinctBy(x => x.ProviderKey + x.LoginProvider).ToList();
var toUpdate = new Dictionary<int, IExternalLogin>();
var toDelete = new List<int>();
var toInsert = new List<IExternalLogin>(logins);
var existingLogins = Database.Fetch<ExternalLoginDto>(sql);
foreach (var existing in existingLogins)
{
var found = logins.FirstOrDefault(x =>
x.LoginProvider.Equals(existing.LoginProvider, StringComparison.InvariantCultureIgnoreCase)
&& x.ProviderKey.Equals(existing.ProviderKey, StringComparison.InvariantCultureIgnoreCase));
if (found != null)
{
toUpdate.Add(existing.Id, found);
// if it's an update then it's not an insert
toInsert.RemoveAll(x => x.ProviderKey == found.ProviderKey && x.LoginProvider == found.LoginProvider);
}
else
{
toDelete.Add(existing.Id);
}
}
// do the deletes, updates and inserts
if (toDelete.Count > 0)
{
Database.DeleteMany<ExternalLoginDto>().Where(x => toDelete.Contains(x.Id)).Execute();
}
foreach (var u in toUpdate)
{
Database.Update(ExternalLoginFactory.BuildDto(userOrMemberKey, u.Value, u.Key));
}
Database.InsertBulk(toInsert.Select(i => ExternalLoginFactory.BuildDto(userOrMemberKey, i)));
}
protected override IIdentityUserLogin PerformGet(int id)
{
var sql = GetBaseQuery(false);
sql.Where(GetBaseWhereClause(), new { id = id });
var dto = Database.Fetch<ExternalLoginDto>(SqlSyntax.SelectTop(sql, 1)).FirstOrDefault();
if (dto == null)
return null;
var entity = ExternalLoginFactory.BuildEntity(dto);
// reset dirty initial properties (U4-1946)
entity.ResetDirtyProperties(false);
return entity;
}
protected override IEnumerable<IIdentityUserLogin> PerformGetAll(params int[] ids)
{
if (ids.Any())
{
return PerformGetAllOnIds(ids);
}
var sql = GetBaseQuery(false).OrderByDescending<ExternalLoginDto>(x => x.CreateDate);
return ConvertFromDtos(Database.Fetch<ExternalLoginDto>(sql))
.ToArray();// we don't want to re-iterate again!
}
private IEnumerable<IIdentityUserLogin> PerformGetAllOnIds(params int[] ids)
{
if (ids.Any() == false) yield break;
foreach (var id in ids)
{
yield return Get(id);
}
}
private IEnumerable<IIdentityUserLogin> ConvertFromDtos(IEnumerable<ExternalLoginDto> dtos)
{
foreach (var entity in dtos.Select(ExternalLoginFactory.BuildEntity))
{
// reset dirty initial properties (U4-1946)
((BeingDirtyBase)entity).ResetDirtyProperties(false);
yield return entity;
}
}
protected override IEnumerable<IIdentityUserLogin> PerformGetByQuery(IQuery<IIdentityUserLogin> query)
{
var sqlClause = GetBaseQuery(false);
var translator = new SqlTranslator<IIdentityUserLogin>(sqlClause, query);
var sql = translator.Translate();
var dtos = Database.Fetch<ExternalLoginDto>(sql);
foreach (var dto in dtos)
{
yield return ExternalLoginFactory.BuildEntity(dto);
}
}
protected override Sql<ISqlContext> GetBaseQuery(bool isCount)
{
var sql = Sql();
if (isCount)
sql.SelectCount();
else
sql.SelectAll();
sql.From<ExternalLoginDto>();
return sql;
}
protected override string GetBaseWhereClause() => $"{Constants.DatabaseSchema.Tables.ExternalLogin}.id = @id";
protected override IEnumerable<string> GetDeleteClauses()
{
var list = new List<string>
{
"DELETE FROM umbracoExternalLogin WHERE id = @id"
};
return list;
}
protected override void PersistNewItem(IIdentityUserLogin entity)
{
entity.AddingEntity();
var dto = ExternalLoginFactory.BuildDto(entity);
var id = Convert.ToInt32(Database.Insert(dto));
entity.Id = id;
entity.ResetDirtyProperties();
}
protected override void PersistUpdatedItem(IIdentityUserLogin entity)
{
entity.UpdatingEntity();
var dto = ExternalLoginFactory.BuildDto(entity);
Database.Update(dto);
entity.ResetDirtyProperties();
}
/// <summary>
/// Query for user tokens
/// </summary>
/// <param name="query"></param>
/// <returns></returns>
public IEnumerable<IIdentityUserToken> Get(IQuery<IIdentityUserToken> query)
{
Sql<ISqlContext> sqlClause = GetBaseTokenQuery(false);
var translator = new SqlTranslator<IIdentityUserToken>(sqlClause, query);
Sql<ISqlContext> sql = translator.Translate();
List<ExternalLoginTokenDto> dtos = Database.Fetch<ExternalLoginTokenDto>(sql);
foreach (ExternalLoginTokenDto dto in dtos)
{
yield return ExternalLoginFactory.BuildEntity(dto);
}
}
/// <summary>
/// Count for user tokens
/// </summary>
/// <param name="query"></param>
/// <returns></returns>
public int Count(IQuery<IIdentityUserToken> query)
{
Sql<ISqlContext> sql = Sql().SelectCount().From<ExternalLoginDto>();
return Database.ExecuteScalar<int>(sql);
}
/// <inheritdoc />
public void Save(Guid userOrMemberKey, IEnumerable<IExternalLoginToken> tokens)
{
// get the existing logins (provider + id)
var existingUserLogins = Database
.Fetch<ExternalLoginDto>(GetBaseQuery(false).Where<ExternalLoginDto>(x => x.UserOrMemberKey == userOrMemberKey))
.ToDictionary(x => x.LoginProvider, x => x.Id);
// deduplicate the tokens
tokens = tokens.DistinctBy(x => x.LoginProvider + x.Name).ToList();
var providers = tokens.Select(x => x.LoginProvider).Distinct().ToList();
Sql<ISqlContext> sql = GetBaseTokenQuery(true)
.WhereIn<ExternalLoginDto>(x => x.LoginProvider, providers)
.Where<ExternalLoginDto>(x => x.UserOrMemberKey == userOrMemberKey);
var toUpdate = new Dictionary<int, (IExternalLoginToken externalLoginToken, int externalLoginId)>();
var toDelete = new List<int>();
var toInsert = new List<IExternalLoginToken>(tokens);
var existingTokens = Database.Fetch<ExternalLoginTokenDto>(sql);
foreach (ExternalLoginTokenDto existing in existingTokens)
{
IExternalLoginToken found = tokens.FirstOrDefault(x =>
x.LoginProvider.InvariantEquals(existing.ExternalLoginDto.LoginProvider)
&& x.Name.InvariantEquals(existing.Name));
if (found != null)
{
toUpdate.Add(existing.Id, (found, existing.ExternalLoginId));
// if it's an update then it's not an insert
toInsert.RemoveAll(x => x.LoginProvider.InvariantEquals(found.LoginProvider) && x.Name.InvariantEquals(found.Name));
}
else
{
toDelete.Add(existing.Id);
}
}
// do the deletes, updates and inserts
if (toDelete.Count > 0)
{
Database.DeleteMany<ExternalLoginTokenDto>().Where(x => toDelete.Contains(x.Id)).Execute();
}
foreach (KeyValuePair<int, (IExternalLoginToken externalLoginToken, int externalLoginId)> u in toUpdate)
{
Database.Update(ExternalLoginFactory.BuildDto(u.Value.externalLoginId, u.Value.externalLoginToken, u.Key));
}
var insertDtos = new List<ExternalLoginTokenDto>();
foreach(IExternalLoginToken t in toInsert)
{
if (!existingUserLogins.TryGetValue(t.LoginProvider, out int externalLoginId))
{
throw new InvalidOperationException($"A token was attempted to be saved for login provider {t.LoginProvider} which is not assigned to this user");
}
insertDtos.Add(ExternalLoginFactory.BuildDto(externalLoginId, t));
}
Database.InsertBulk(insertDtos);
}
private Sql<ISqlContext> GetBaseTokenQuery(bool forUpdate)
=> forUpdate ? Sql()
.Select<ExternalLoginTokenDto>(r => r.Select(x => x.ExternalLoginDto))
.From<ExternalLoginTokenDto>()
.Append(" WITH (UPDLOCK)") // ensure these table values are locked for updates, the ForUpdate ext method does not work here
.InnerJoin<ExternalLoginDto>()
.On<ExternalLoginTokenDto, ExternalLoginDto>(x => x.ExternalLoginId, x => x.Id)
: Sql()
.Select<ExternalLoginTokenDto>()
.AndSelect<ExternalLoginDto>(x => x.LoginProvider, x => x.UserOrMemberKey)
.From<ExternalLoginTokenDto>()
.InnerJoin<ExternalLoginDto>()
.On<ExternalLoginTokenDto, ExternalLoginDto>(x => x.ExternalLoginId, x => x.Id);
}
}