Skip to content

LT-22314: Add filename to media line #772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aror92 merged 1 commit into from
Mar 18, 2026
Merged

LT-22314: Add filename to media line #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion Src/LexText/Interlinear/ITextStrings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion Src/LexText/Interlinear/ITextStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@
<value>Media</value>
</data>
<data name="ksMediaNotFound" xml:space="preserve">
<value>Media not found: check Info tab for file name</value>
<value>Media not found: check Info tab for full file path</value>
<comment>Used when a media filepath is specified, but the file doesn't exist. Ensure translation of "Info" matches translation used for the tab label.</comment>
</data>
<data name="ksNoMedia" xml:space="preserve">
Expand All @@ -361,6 +361,9 @@
<data name="ksSpeaker" xml:space="preserve">
<value>Speaker</value>
</data>
<data name="ksFile" xml:space="preserve">
<value>File</value>
</data>
<data name="ksPhaseButton" xml:space="preserve">
<value>Ph{0} {1}</value>
<comment>{0} is phase number; {1} is either "Process" or "Import"</comment>
Expand Down
103 changes: 81 additions & 22 deletions Src/LexText/Interlinear/InterlinVc.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
using SIL.LCModel.DomainServices;
using SIL.LCModel.Infrastructure;
using System.IO;
using SIL.LCModel.Core.Phonology;

namespace SIL.FieldWorks.IText
{
Expand Down Expand Up @@ -1004,16 +1005,26 @@ private ITsString MakeLabel(string labelText)
return tssLabel;
}

private void AddNoMediaMessage(IVwEnv vwenv, ITsString tssMediaLabel, bool lineAndSegSameDir, bool lineAndUserSameDir, string mediaFile)
private ITsString GetSpeakerName(ICmPerson speakerRA, int ws)
{
// If speaker name is available in the writing system we want, use that.
// Otherwise, use the default stored in ChooserNameTS. Otherwise an empty string.
ITsString speakerName = speakerRA?.Name?.get_String(ws);
if (string.IsNullOrEmpty(speakerName?.ToString()))
speakerName = speakerRA?.ChooserNameTS ?? m_tssEmptyString;
return speakerName;
}

private void AddNoMediaMessage(IVwEnv vwenv, ITsString tssMediaLabel, ITsString tssFileLabel, int wsForSeg, string mediaFileName)
{
var defUserWs = m_cache.DefaultUserWs;
bool isFilePathSpecified = !string.IsNullOrEmpty(mediaFile);
ITsString tssFilePath = null;
bool isFilePathSpecified = !string.IsNullOrEmpty(mediaFileName);
ITsString tssFileName = null;
ITsString tssNoMediaMessage;

if (isFilePathSpecified)
{
tssFilePath = TsStringUtils.MakeString(mediaFile, defUserWs);
tssFileName = MakeUiElementString(mediaFileName, defUserWs, null);
// We have a media filepath, but file was not found. Build media not found message.
// Use normal label settings, except make it italic instead of bold.
tssNoMediaMessage = MakeUiElementString(
Expand All @@ -1029,7 +1040,7 @@ private void AddNoMediaMessage(IVwEnv vwenv, ITsString tssMediaLabel, bool lineA
else
{
// No media filepath was given. Build no media message.
// Use normal label settings, except make it italic instead of bold.
// Use normal label settings, except not bold.
tssNoMediaMessage = MakeUiElementString(
ITextStrings.ksNoMedia, defUserWs,
propsBldr =>
Expand All @@ -1041,12 +1052,18 @@ private void AddNoMediaMessage(IVwEnv vwenv, ITsString tssMediaLabel, bool lineA
});
}

// If the line WS and segment WS are not the same direction, OR the line WS and user WS
// are not the same direction, but not both, then we need to insert pieces in reverse
// If the user WS and segment WS are not the same direction, then we need to insert pieces in reverse
// logical order.
AddTssDirForWs(vwenv, defUserWs);
if (!lineAndSegSameDir ^ !lineAndUserSameDir)
if (IsWsRtl(wsForSeg)!=IsWsRtl(defUserWs))
{
if (isFilePathSpecified)
{
vwenv.AddString(tssFileName);
vwenv.AddString(m_tssDefaultSpace);
vwenv.AddString(tssFileLabel);
AddSeparator(vwenv);
}
vwenv.AddString(tssNoMediaMessage);
vwenv.AddString(m_tssDefaultSpace);
vwenv.AddString(tssMediaLabel);
Expand All @@ -1056,6 +1073,13 @@ private void AddNoMediaMessage(IVwEnv vwenv, ITsString tssMediaLabel, bool lineA
vwenv.AddString(tssMediaLabel);
vwenv.AddString(m_tssDefaultSpace);
vwenv.AddString(tssNoMediaMessage);
if (isFilePathSpecified)
{
AddSeparator(vwenv);
vwenv.AddString(tssFileLabel);
vwenv.AddString(m_tssDefaultSpace);
vwenv.AddString(tssFileName);
}
}
AddTssDirForWs(vwenv, defUserWs);
}
Expand Down Expand Up @@ -1105,22 +1129,24 @@ protected virtual void AddMedia(IVwEnv vwenv, int hvoSeg, int lineChoiceIndex)
// => 1 himetric = 720/25.4 millipoints = 7200/254 millipoints
int mediaPlayPicWidth = m_PlayArrowPic.Picture.Width * 7200 / 254;

// Build labels for begin/end offsets and speaker.
// Build labels for begin/end offsets, speaker, and file.
var tssBeginTimeLabel = MakeLabel(ITextStrings.ksBeginTimeOffset);
var tssEndTimeLabel = MakeLabel(ITextStrings.ksEndTimeOffset);
var tssSpeakerLabel = MakeLabel(ITextStrings.ksSpeaker);
var tssFileLabel = MakeLabel(ITextStrings.ksFile);

// If there is no media file, add Media line label and a "No Media" message and skip the rest of the media line display.
var mediaFile = segment.MediaURIRA?.MediaURI;
bool fileExists = CheckFileExistsFromUri(mediaFile);
string mediaFileName;
bool fileExists = CheckFileExistsFromUri(mediaFile, out mediaFileName);

// If there is no media file, add Media line label and a "No Media" message and skip the rest of the media line display.
if (!fileExists)
{
vwenv.OpenDiv();
SetParaDirectionAndAlignment(vwenv, wssOptions[0]);
// No Media Message uses the default user ws
SetParaDirectionAndAlignment(vwenv, defUserWs);
vwenv.OpenParagraph();
bool lineAndSegSameDir = IsWsRtl(wssOptions[0]) == IsWsRtl(wsForSeg);
bool lineAndUserSameDir = (IsWsRtl(wssOptions[0]) == IsWsRtl(defUserWs));
AddNoMediaMessage(vwenv, tssMediaLabel, lineAndSegSameDir, lineAndUserSameDir, mediaFile);
AddNoMediaMessage(vwenv, tssMediaLabel, tssFileLabel, wsForSeg, mediaFileName);
vwenv.CloseParagraph();
vwenv.CloseDiv();
return;
Expand Down Expand Up @@ -1181,14 +1207,29 @@ protected virtual void AddMedia(IVwEnv vwenv, int hvoSeg, int lineChoiceIndex)
// then content within each piece needs to be in reverse logical order.
//
// In the order in which they should appear, pieces for the media line are:
// [Label WS - media label], [Line content WS - playback button], [Label WS - optional WS label & Begin time label],
// [Line content WS - Begin time value], [Label WS - End time label], [Line content WS - End time value],
// [Label WS - Speaker label], [Line content WS - Speaker value].
// [Default user WS - media label], [Line content WS - playback button], [Default user WS - optional WS label & Begin time label],
// [Line content WS - Begin time value], [Default user WS - End time label], [Line content WS - End time value],
// [Default user WS - Speaker label], [Line content WS - Speaker value], [Default user WS - File label & filename].
if (!lineAndSegSameDir)
{
// Add the file name section.
// Piece 1: default user WS - Add file label and filename
if (lineAndUserSameDir)
{
// content within the piece is in reverse logical order, so add filename and then label
AddITsStringProperty(vwenv, defUserWs, MakeUiElementString(mediaFileName, defUserWs, null));
AddFormattedLabel(vwenv, tssFileLabel, lineAndSegSameDir, lineAndUserSameDir);
}
else
{
// content within the piece is in logical order, so add label and then filename
AddFormattedLabel(vwenv, tssFileLabel, lineAndSegSameDir, lineAndUserSameDir);
AddITsStringProperty(vwenv, defUserWs, MakeUiElementString(mediaFileName, defUserWs, null));
}

// Add the speaker section.
// Piece 1: Line content WS - Add speaker value.
AddITsStringProperty(vwenv, wssOptions[i], segment.SpeakerRA?.ChooserNameTS ?? m_tssEmptyString);
AddITsStringProperty(vwenv, wssOptions[i], GetSpeakerName(segment.SpeakerRA, wssOptions[i]));
// Piece 2: default user WS - Add speaker label.
AddFormattedLabel(vwenv, tssSpeakerLabel, lineAndSegSameDir, lineAndUserSameDir);

Expand Down Expand Up @@ -1375,7 +1416,22 @@ protected virtual void AddMedia(IVwEnv vwenv, int hvoSeg, int lineChoiceIndex)
// Speaker label Piece: default user WS.
AddFormattedLabel(vwenv, tssSpeakerLabel, lineAndSegSameDir, lineAndUserSameDir);
// Speaker value piece: Line content WS.
AddITsStringProperty(vwenv, wssOptions[i], segment.SpeakerRA?.ChooserNameTS ?? m_tssEmptyString);
AddITsStringProperty(vwenv, wssOptions[i], GetSpeakerName(segment.SpeakerRA, wssOptions[i]));

// Add the file name piece.
// Default user WS - Add file label and filename
if (lineAndUserSameDir)
{
// content within the piece should be in logical order, so add label and then filename
AddFormattedLabel(vwenv, tssFileLabel, lineAndSegSameDir, lineAndUserSameDir);
AddITsStringProperty(vwenv, defUserWs, MakeUiElementString(mediaFileName, defUserWs, null));
}
else
{
// content within the piece should be in reverse logical order, so add filename and then label
AddITsStringProperty(vwenv, defUserWs, MakeUiElementString(mediaFileName, defUserWs, null));
AddFormattedLabel(vwenv, tssFileLabel, lineAndSegSameDir, lineAndUserSameDir);
}
}
vwenv.CloseParagraph();
}
Expand Down Expand Up @@ -1991,9 +2047,11 @@ private void DisplayMorphBundle(IVwEnv vwenv, int hvo)
/// Checks if a file associated with a file URI string exists.
/// </summary>
/// <param name="uriString">The string containing the file URI.</param>
/// <param name="fileName">The name of the file extracted from the URI, if it exists.</param>
/// <returns>True if the file exists, false otherwise.</returns>
private static bool CheckFileExistsFromUri(string uriString)
private static bool CheckFileExistsFromUri(string uriString, out string fileName)
{
fileName = null;
if (string.IsNullOrEmpty(uriString))
{
return false;
Expand All @@ -2007,8 +2065,9 @@ private static bool CheckFileExistsFromUri(string uriString)
// 2. Check if it's a local file path (scheme "file").
if (uri.IsFile)
{
// 3. Get the local file path using uri.LocalPath or uri.OriginalString (for UNC paths).
// 3. Get the file path using uri.LocalPath.
string localPath = uri.LocalPath;
fileName = Path.GetFileName(uri.LocalPath);

// 4. Use File.Exists to verify if the file exists at that path.
return File.Exists(localPath);
Expand Down
Loading