Skip to content

Commit de136f1

Browse files
pmachapmanpmachapman
authored
SF-3618 Write permissions for new books on sync (#3528)
1 parent e2dd725 commit de136f1

File tree

9 files changed

+442
-42
lines changed

9 files changed

+442
-42
lines changed

‎src/SIL.XForge.Scripture/Models/SyncMetrics.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ public record SyncMetrics : IIdentifiable
5858
/// </summary>
5959
public SyncMetricInfo ParatextNotes { get; set; } = new SyncMetricInfo();
6060

61+
/// <summary>
62+
/// Gets or sets the info for changes to permissions outgoing to Paratext.
63+
/// </summary>
64+
public SyncMetricInfo ParatextPermissions { get; set; } = new SyncMetricInfo();
65+
6166
/// <summary>
6267
/// Gets or sets the info for changes to questions incoming from Paratext.
6368
/// </summary>

‎src/SIL.XForge.Scripture/Models/SyncPhase.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
namespace SIL.XForge.Scripture.Models;
2+
13
/// <summary>
24
/// The sync phase.
35
/// </summary>

‎src/SIL.XForge.Scripture/Services/IParatextService.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,12 @@ SyncMetricInfo UpdateBiblicalTerms(
7777
string paratextId,
7878
IReadOnlyList<BiblicalTerm> biblicalTerms
7979
);
80+
Task<SyncMetricInfo> UpdateParatextPermissionsForNewBooksAsync(
81+
UserSecret userSecret,
82+
string paratextId,
83+
IDocument<SFProject> projectDoc,
84+
bool writeToParatext
85+
);
8086
string? GetLatestSharedVersion(UserSecret userSecret, string paratextId);
8187
string GetRepoRevision(UserSecret userSecret, string paratextId);
8288
void SetRepoToRevision(UserSecret userSecret, string paratextId, string desiredRevision);

‎src/SIL.XForge.Scripture/Services/MachineApiService.cs‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ CancellationToken cancellationToken
115115
cancellationToken
116116
);
117117

118+
// Retrieve the user secret
119+
Attempt<UserSecret> attempt = await userSecrets.TryGetAsync(curUserId, cancellationToken);
120+
if (!attempt.TryResult(out UserSecret userSecret))
121+
{
122+
throw new DataNotFoundException("The user does not exist.");
123+
}
124+
118125
// Connect to the realtime server
119126
await using IConnection connection = await realtimeService.ConnectAsync(curUserId);
120127

@@ -126,13 +133,6 @@ CancellationToken cancellationToken
126133
List<(ChapterDelta chapterDelta, int bookNum)> chapterDeltas = [];
127134
try
128135
{
129-
// Retrieve the user secret
130-
Attempt<UserSecret> attempt = await userSecrets.TryGetAsync(curUserId, cancellationToken);
131-
if (!attempt.TryResult(out UserSecret userSecret))
132-
{
133-
throw new DataNotFoundException("The user does not exist.");
134-
}
135-
136136
// Load the target project
137137
targetProjectDoc = await connection.FetchAsync<SFProject>(targetProjectId);
138138
if (!targetProjectDoc.IsLoaded)
@@ -404,13 +404,27 @@ await hubContext.NotifyDraftApplyProgress(
404404
sfProjectId,
405405
new DraftApplyState { State = "Loading permissions from Paratext." }
406406
);
407-
await projectService.UpdatePermissionsAsync(
408-
curUserId,
409-
targetProjectDoc,
410-
users: null,
411-
books: chapterDeltas.Select(c => c.bookNum).Distinct().ToList(),
412-
cancellationToken
413-
);
407+
if (createdBooks.Count == 0)
408+
{
409+
// Update books for which chapters were added
410+
await projectService.UpdatePermissionsAsync(
411+
curUserId,
412+
targetProjectDoc,
413+
users: null,
414+
books: chapterDeltas.Select(c => c.bookNum).Distinct().ToList(),
415+
cancellationToken
416+
);
417+
}
418+
else
419+
{
420+
// Update permissions for new books
421+
await paratextService.UpdateParatextPermissionsForNewBooksAsync(
422+
userSecret,
423+
targetProjectDoc.Data.ParatextId,
424+
targetProjectDoc,
425+
writeToParatext: false
426+
);
427+
}
414428
}
415429

416430
// Create the text data documents, using the permissions matrix calculated above for permissions

‎src/SIL.XForge.Scripture/Services/ParatextService.cs‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
using SIL.XForge.Services;
4848
using SIL.XForge.Utils;
4949
using StringUtils = SIL.XForge.Utils.StringUtils;
50+
using TextInfo = SIL.XForge.Scripture.Models.TextInfo;
5051

5152
namespace SIL.XForge.Scripture.Services;
5253

@@ -331,6 +332,7 @@ SyncMetrics syncMetrics
331332
syncMetrics.ParatextBooks != new SyncMetricInfo()
332333
|| syncMetrics.ParatextNotes != new SyncMetricInfo()
333334
|| syncMetrics.ParatextBiblicalTerms != new SyncMetricInfo()
335+
|| syncMetrics.ParatextPermissions != new SyncMetricInfo()
334336
)
335337
)
336338
{
@@ -1690,6 +1692,107 @@ IReadOnlyList<BiblicalTerm> biblicalTerms
16901692
return syncMetricInfo;
16911693
}
16921694

1695+
public async Task<SyncMetricInfo> UpdateParatextPermissionsForNewBooksAsync(
1696+
UserSecret userSecret,
1697+
string paratextId,
1698+
IDocument<SFProject> projectDoc,
1699+
bool writeToParatext
1700+
)
1701+
{
1702+
var syncMetricInfo = new SyncMetricInfo();
1703+
using ScrText scrText = ScrTextCollection.FindById(GetParatextUsername(userSecret)!, paratextId);
1704+
if (scrText is null)
1705+
{
1706+
return syncMetricInfo;
1707+
}
1708+
1709+
if (!projectDoc.Data.Editable)
1710+
{
1711+
return syncMetricInfo;
1712+
}
1713+
1714+
// Get all projects that are not on disk
1715+
for (int i = 0; i < projectDoc.Data.Texts.Count; i++)
1716+
{
1717+
TextInfo text = projectDoc.Data.Texts[i];
1718+
int bookNum = text.BookNum;
1719+
if (scrText.BookPresent(bookNum))
1720+
{
1721+
// Book is on disk, skip to the next book
1722+
continue;
1723+
}
1724+
1725+
// Add any users to the book who would have the ability to access it
1726+
foreach (var user in projectDoc.Data.ParatextUsers)
1727+
{
1728+
// If there is no SF user id or PT username, ignore this user
1729+
if (string.IsNullOrEmpty(user.SFUserId) || string.IsNullOrEmpty(user.Username))
1730+
{
1731+
continue;
1732+
}
1733+
1734+
bool hasPermissionInParatext = scrText.Permissions.CanEdit(bookNum, chapterNum: 0, user.Username);
1735+
bool hasPermissionInMongo =
1736+
text.Permissions.TryGetValue(user.SFUserId, out string permission)
1737+
&& permission == TextInfoPermission.Write;
1738+
bool userIsAdministrator = scrText.Permissions.GetUser(user.Username)?.Role == UserRoles.Administrator;
1739+
1740+
if (writeToParatext)
1741+
{
1742+
// Grant the user access to edit the new book, if we granted them access in Mongo,
1743+
// they are an administrator, but they do not have access in Paratext.
1744+
//
1745+
// This is based on ParatextData.ImportSfmText.GrantBookPermissions()
1746+
if (hasPermissionInMongo && !hasPermissionInParatext && userIsAdministrator)
1747+
{
1748+
scrText.Permissions.SetPermission(user.Username, bookNum, PermissionSet.Manual, true);
1749+
syncMetricInfo.Updated++;
1750+
}
1751+
}
1752+
else
1753+
{
1754+
// If the user can edit the book and doesn't have permission,
1755+
// or they are the current user and an administrator,
1756+
// update the Scripture Forge permissions to allow writing.
1757+
bool currentUserIsAdministrator = userIsAdministrator && user.SFUserId == userSecret.Id;
1758+
if (!hasPermissionInMongo && (currentUserIsAdministrator || hasPermissionInParatext))
1759+
{
1760+
// Add the user to the new book in SF with book permissions and available chapter permissions
1761+
// This will be empty if the current user is an administrator but has no permissions for the book
1762+
int[] editableChapters =
1763+
[
1764+
.. scrText.Permissions.GetEditableChapters(
1765+
bookNum,
1766+
scrText.Settings.Versification,
1767+
user.Username
1768+
) ?? [],
1769+
];
1770+
await projectDoc.SubmitJson0OpAsync(op =>
1771+
{
1772+
int textIndex = i;
1773+
op.Set(p => p.Texts[textIndex].Permissions[user.SFUserId], TextInfoPermission.Write);
1774+
for (int j = 0; j < text.Chapters.Count; j++)
1775+
{
1776+
int chapterIndex = j;
1777+
int chapterNumber = text.Chapters[chapterIndex].Number;
1778+
if (editableChapters.Contains(chapterNumber) || currentUserIsAdministrator)
1779+
{
1780+
op.Set(
1781+
p => p.Texts[textIndex].Chapters[chapterIndex].Permissions[user.SFUserId],
1782+
TextInfoPermission.Write
1783+
);
1784+
}
1785+
}
1786+
});
1787+
syncMetricInfo.Updated++;
1788+
}
1789+
}
1790+
}
1791+
}
1792+
1793+
return syncMetricInfo;
1794+
}
1795+
16931796
/// <summary>
16941797
/// Get the most recent revision id of a commit from the last push or pull with the PT send/receive server.
16951798
/// </summary>

‎src/SIL.XForge.Scripture/Services/ParatextSyncRunner.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,12 @@ CancellationToken token
220220
// Update target Paratext books, notes and biblical terms, if this is not a resource
221221
if (!_paratextService.IsResource(targetParatextId))
222222
{
223+
_syncMetrics.ParatextPermissions += await _paratextService.UpdateParatextPermissionsForNewBooksAsync(
224+
_userSecret,
225+
targetParatextId,
226+
_projectDoc,
227+
writeToParatext: true
228+
);
223229
await GetAndUpdateParatextBooksAndNotes(
224230
SyncPhase.Phase2,
225231
targetParatextId,

‎test/SIL.XForge.Scripture.Tests/Services/MachineApiServiceTests.cs‎

Lines changed: 69 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -224,29 +224,28 @@ public async Task ApplyPreTranslationToProjectAsync_ExceptionFromParatext()
224224
// Set up test environment
225225
var env = new TestEnvironment();
226226
env.ConfigureDraft(
227-
Project01,
227+
Project02,
228228
bookNum: 39,
229229
numberOfChapters: 3,
230230
bookExists: true,
231231
draftExists: true,
232232
canWriteBook: true,
233233
writeChapters: 3
234234
);
235-
env.ProjectService.UpdatePermissionsAsync(
235+
env.ParatextService.UpdateParatextPermissionsForNewBooksAsync(
236+
Arg.Any<UserSecret>(),
236237
Arg.Any<string>(),
237238
Arg.Any<IDocument<SFProject>>(),
238-
users: null,
239-
books: Arg.Any<IReadOnlyList<int>>(),
240-
CancellationToken.None
239+
writeToParatext: false
241240
)
242241
.ThrowsAsync(new NotSupportedException());
243242

244243
// SUT
245244
DraftApplyResult actual = await env.Service.ApplyPreTranslationToProjectAsync(
246245
User01,
247-
Project01,
246+
Project02,
248247
scriptureRange: "MAL",
249-
targetProjectId: Project02,
248+
targetProjectId: Project01,
250249
DateTime.UtcNow,
251250
CancellationToken.None
252251
);
@@ -354,19 +353,16 @@ public async Task ApplyPreTranslationToProjectAsync_MissingUserSecret()
354353
await env.UserSecrets.DeleteAllAsync(_ => true);
355354

356355
// SUT
357-
DraftApplyResult actual = await env.Service.ApplyPreTranslationToProjectAsync(
358-
User01,
359-
Project01,
360-
scriptureRange: "GEN",
361-
Project02,
362-
DateTime.UtcNow,
363-
CancellationToken.None
356+
Assert.ThrowsAsync<DataNotFoundException>(() =>
357+
env.Service.ApplyPreTranslationToProjectAsync(
358+
User01,
359+
Project01,
360+
scriptureRange: "GEN",
361+
Project02,
362+
DateTime.UtcNow,
363+
CancellationToken.None
364+
)
364365
);
365-
366-
env.MockLogger.AssertHasEvent(logEvent => logEvent.Exception?.GetType() == typeof(DataNotFoundException));
367-
env.ExceptionHandler.Received().ReportException(Arg.Is<DataNotFoundException>(e => e.Message.Contains("user")));
368-
Assert.That(actual.Log, Is.Not.Empty);
369-
Assert.That(actual.ChangesSaved, Is.False);
370366
}
371367

372368
[Test]
@@ -4930,6 +4926,36 @@ int writeChapters
49304926
}
49314927
}
49324928
});
4929+
4930+
// Update the permissions for the user applying the draft
4931+
ParatextService
4932+
.When(x =>
4933+
x.UpdateParatextPermissionsForNewBooksAsync(
4934+
Arg.Any<UserSecret>(),
4935+
Arg.Any<string>(),
4936+
Arg.Any<IDocument<SFProject>>(),
4937+
writeToParatext: false
4938+
)
4939+
)
4940+
.Do(callInfo =>
4941+
{
4942+
UserSecret userSecret = callInfo.ArgAt<UserSecret>(0);
4943+
var projectDoc = callInfo.ArgAt<IDocument<SFProject>>(2);
4944+
foreach (var text in projectDoc.Data.Texts)
4945+
{
4946+
text.Permissions.TryAdd(
4947+
userSecret.Id,
4948+
canWriteBook ? TextInfoPermission.Write : TextInfoPermission.Read
4949+
);
4950+
foreach (var chapter in text.Chapters)
4951+
{
4952+
chapter.Permissions.TryAdd(
4953+
userSecret.Id,
4954+
chapter.Number <= writeChapters ? TextInfoPermission.Write : TextInfoPermission.Read
4955+
);
4956+
}
4957+
}
4958+
});
49334959
}
49344960

49354961
public async Task VerifyDraftAsync(
@@ -4941,15 +4967,30 @@ public async Task VerifyDraftAsync(
49414967
int writeChapters
49424968
)
49434969
{
4944-
await ProjectService
4945-
.Received()
4946-
.UpdatePermissionsAsync(
4947-
User01,
4948-
Arg.Any<IDocument<SFProject>>(),
4949-
users: null,
4950-
books: Arg.Any<IReadOnlyList<int>>(),
4951-
CancellationToken.None
4952-
);
4970+
if (targetProjectId == Project02)
4971+
{
4972+
await ParatextService
4973+
.Received()
4974+
.UpdateParatextPermissionsForNewBooksAsync(
4975+
Arg.Any<UserSecret>(),
4976+
Arg.Any<string>(),
4977+
Arg.Any<IDocument<SFProject>>(),
4978+
writeToParatext: false
4979+
);
4980+
}
4981+
else
4982+
{
4983+
await ProjectService
4984+
.Received()
4985+
.UpdatePermissionsAsync(
4986+
User01,
4987+
Arg.Any<IDocument<SFProject>>(),
4988+
users: null,
4989+
books: Arg.Any<IReadOnlyList<int>>(),
4990+
CancellationToken.None
4991+
);
4992+
}
4993+
49534994
ExceptionHandler.DidNotReceive().ReportException(Arg.Any<Exception>());
49544995

49554996
await Assert.ThatAsync(

0 commit comments

Comments
 (0)