izzy/UnrealEngineUWP
0
0
Fork 0
mirror of https://github.com/izzy2lost/UnrealEngineUWP.git synced 2026-03-26 18:15:20 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd76902991c4d64ca930bf424c9e6a3f27977fa6
UnrealEngineUWP/Engine/Source/Programs/CrashReportClient/Private/SCrashReportClient.cpp

439 lines
13 KiB
C++
Raw Normal View History

Added a command line option to CrashReportClient to disable the 'Submit and Restart' button in case the application doesn't want to be automaticaly restarted. #rb Chris.Gagnon, Johan.Berg #preflight 629f7017617cbe81d32add99 #ushell-cherrypick of 20541559 by Patrick.Laflamme #preflight 629fbb4b521254896f6c2c43 #ROBOMERGE-AUTHOR: patrick.laflamme #ROBOMERGE-SOURCE: CL 20546605 via CL 20546619 via CL 20546630 via CL 20546644 via CL 20546648 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v954-20466795) [CL 20552343 by patrick laflamme in ue5-main branch]
2022-06-08 02:02:29 -04:00
// Copyright Epic Games, Inc. All Rights Reserved.
#include "SCrashReportClient.h"
#if !CRASH_REPORT_UNATTENDED_ONLY
#include "CrashReportClientStyle.h"
#include "Styling/CoreStyle.h"
#include "Widgets/Images/SThrobber.h"
#include "CrashDescription.h"
#include "Framework/Text/SlateHyperlinkRun.h"
#include "Widgets/SBoxPanel.h"
#include "Widgets/SOverlay.h"
#include "Widgets/Text/STextBlock.h"
#include "Widgets/Text/SRichTextBlock.h"
#include "Widgets/Layout/SSplitter.h"
#include "Widgets/Colors/SColorBlock.h"
#include "Widgets/Input/SCheckBox.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/Layout/SSpacer.h"
#include "Framework/Application/SlateApplication.h"
#include "Misc/EngineBuildSettings.h"
#define LOCTEXT_NAMESPACE "CrashReportClient"
static void OnBrowserLinkClicked(const FSlateHyperlinkRun::FMetadata& Metadata)
{
const FString* UrlPtr = Metadata.Find(TEXT("href"));
if(UrlPtr)
{
FPlatformProcess::LaunchURL(**UrlPtr, nullptr, nullptr);
}
}
static void OnViewCrashDirectory( const FSlateHyperlinkRun::FMetadata& Metadata)
{
const FString* UrlPtr = Metadata.Find( TEXT( "href" ) );
if (UrlPtr)
{
FPlatformProcess::ExploreFolder( **UrlPtr );
}
}
void SCrashReportClient::Construct(const FArguments& InArgs, const TSharedRef<FCrashReportClient>& Client, bool bSimpleDialog)
{
CrashReportClient = Client;
bHasUserCommentErrors = false;
bHideSubmitAndRestart = InArgs._bHideSubmitAndRestart;
FText CrashDetailedMessage = LOCTEXT("CrashDetailed", "We are very sorry that this crash occurred. Our goal is to prevent crashes like this from occurring in the future. Please help us track down and fix this crash by providing detailed information about what you were doing so that we may reproduce the crash and fix it quickly. You can also log a Bug Report with us using the <a id=\"browser\" href=\"https://epicsupport.force.com/unrealengine/s/\" style=\"Hyperlink\">Bug Submission Form</> and work directly with support staff to report this issue.\n\nThanks for your help in improving the Unreal Engine.");
if (FPrimaryCrashProperties::Get()->IsValid())
{
FString CrashDetailedMessageString = FPrimaryCrashProperties::Get()->CrashReporterMessage.AsString();
if (!CrashDetailedMessageString.IsEmpty())
{
CrashDetailedMessage = FText::FromString(CrashDetailedMessageString);
}
}
if (bSimpleDialog)
{
ConstructSimpleDialog(Client, CrashDetailedMessage);
}
else
{
ConstructDetailedDialog(Client, CrashDetailedMessage);
}
FSlateApplication::Get().SetUnhandledKeyDownEventHandler(FOnKeyEvent::CreateSP(this, &SCrashReportClient::OnUnhandledKeyDown));
}
void SCrashReportClient::ConstructDetailedDialog(const TSharedRef<FCrashReportClient>& Client, const FText& CrashDetailedMessage)
{
auto CrashedAppName = FPrimaryCrashProperties::Get()->IsValid() ? FPrimaryCrashProperties::Get()->GameName : TEXT("");
// Set the text displaying the name of the crashed app, if available
const FText CrashedAppText = CrashedAppName.IsEmpty() ?
LOCTEXT( "CrashedAppNotFound", "An unknown process has crashed" ) :
LOCTEXT( "CrashedAppUnreal", "An Unreal process has crashed: " );
const FText CrashReportDataText = FText::Format(
LOCTEXT( "CrashReportData", "Crash reports comprise diagnostics files (<a id=\"browser\" href=\"{0}\" style=\"Richtext.Hyperlink\">click here to view directory</>) and the following summary information: " ),
FText::FromString( CrashReportClient->GetCrashDirectory()) );
ChildSlot
[
SNew(SBorder)
.BorderImage(FCrashReportClientStyle::Get().GetBrush("ToolPanel.GroupBorder"))
[
SNew(SVerticalBox)
// Stuff anchored to the top
+SVerticalBox::Slot()
.AutoHeight()
.Padding(4)
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(STextBlock)
.TextStyle(FCrashReportClientStyle::Get(), "Title")
.Text(CrashedAppText)
]
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(STextBlock)
.TextStyle(FCrashReportClientStyle::Get(), "Title")
.Text(FText::FromString(CrashedAppName))
]
]
+SVerticalBox::Slot()
.AutoHeight()
.Padding( FMargin( 4, 10 ) )
[
SNew( SRichTextBlock )
.Text(CrashDetailedMessage)
.AutoWrapText(true)
+ SRichTextBlock::HyperlinkDecorator( TEXT("browser"), FSlateHyperlinkRun::FOnClick::CreateStatic( &OnBrowserLinkClicked ) )
]
+SVerticalBox::Slot()
.Padding(FMargin(4, 10, 4, 4))
[
SNew(SSplitter)
.Orientation(Orient_Vertical)
+SSplitter::Slot()
.Value(0.3f)
[
SNew( SOverlay )
+ SOverlay::Slot()
[
SAssignNew( CrashDetailsInformation, SMultiLineEditableTextBox )
.Style( &FCrashReportClientStyle::Get().GetWidgetStyle<FEditableTextBoxStyle>( "NormalEditableTextBox" ) )
.OnTextCommitted( CrashReportClient.ToSharedRef(), &FCrashReportClient::UserCommentChanged )
.OnTextChanged( this, &SCrashReportClient::OnUserCommentTextChanged)
.Font( FCoreStyle::GetDefaultFontStyle("Regular", 9) )
.AutoWrapText( true )
.BackgroundColor( FSlateColor( FLinearColor::Black ) )
.ForegroundColor( FSlateColor( FLinearColor::White * 0.8f ) )
]
// HintText is not implemented in SMultiLineEditableTextBox, so this is a workaround.
+ SOverlay::Slot()
[
SNew(STextBlock)
.Margin( FMargin(4,2,0,0) )
.Font( FCoreStyle::GetDefaultFontStyle("Italic", 9) )
.ColorAndOpacity( FSlateColor( FLinearColor::White * 0.5f ) )
.Text( LOCTEXT( "CrashProvide", "Please provide detailed information about what you were doing when the crash occurred." ) )
.Visibility( this, &SCrashReportClient::IsHintTextVisible )
]
]
+SSplitter::Slot()
.Value(0.7f)
[
SNew(SVerticalBox)
+ SVerticalBox::Slot()
.AutoHeight()
[
SNew(SOverlay)
+ SOverlay::Slot()
[
SNew(SColorBlock)
.Color(FLinearColor::Black)
]
+ SOverlay::Slot()
[
SNew( SRichTextBlock )
.Margin( FMargin( 4, 2, 0, 8 ) )
.TextStyle( &FCrashReportClientStyle::Get().GetWidgetStyle<FTextBlockStyle>( "CrashReportDataStyle" ) )
.Text( CrashReportDataText )
.AutoWrapText( true )
.DecoratorStyleSet( &FCrashReportClientStyle::Get() )
+ SRichTextBlock::HyperlinkDecorator( TEXT( "browser" ), FSlateHyperlinkRun::FOnClick::CreateStatic( &OnViewCrashDirectory ) )
]
]
+ SVerticalBox::Slot()
.FillHeight(0.7f)
[
SNew(SOverlay)
+ SOverlay::Slot()
[
SNew( SMultiLineEditableTextBox )
.Style( &FCrashReportClientStyle::Get().GetWidgetStyle<FEditableTextBoxStyle>( "NormalEditableTextBox" ) )
.Font( FCoreStyle::GetDefaultFontStyle("Regular", 8) )
.AutoWrapText( false )
.IsReadOnly( true )
.ReadOnlyForegroundColor( FSlateColor( FLinearColor::White * 0.8f) )
.BackgroundColor( FSlateColor( FLinearColor::Black ) )
.ForegroundColor( FSlateColor( FLinearColor::White * 0.8f ) )
.Text( Client, &FCrashReportClient::GetDiagnosticText )
]
+ SOverlay::Slot()
.HAlign(HAlign_Center)
.VAlign(VAlign_Center)
[
SNew(SThrobber)
.Visibility(CrashReportClient.ToSharedRef(), &FCrashReportClient::IsThrobberVisible)
.NumPieces(5)
]
]
]
]
+SVerticalBox::Slot()
.AutoHeight()
.Padding( FMargin( 4, 12, 4, 4 ) )
[
SNew( SHorizontalBox )
.Visibility( FCrashReportCoreConfig::Get().GetHideLogFilesOption() ? EVisibility::Collapsed : EVisibility::Visible )
+ SHorizontalBox::Slot()
.AutoWidth()
.VAlign( VAlign_Center )
[
SNew( SCheckBox )
.IsChecked( FCrashReportCoreConfig::Get().GetSendLogFile() ? ECheckBoxState::Checked : ECheckBoxState::Unchecked )
.OnCheckStateChanged( CrashReportClient.ToSharedRef(), &FCrashReportClient::SendLogFile_OnCheckStateChanged )
]
+ SHorizontalBox::Slot()
.FillWidth( 1.0f )
.VAlign( VAlign_Center )
[
SNew( STextBlock )
.AutoWrapText( true )
.Text( LOCTEXT( "IncludeLogs", "Include log files with submission. I understand that logs contain some personal information such as my system and user name." ) )
]
]
+SVerticalBox::Slot()
.AutoHeight()
.Padding( FMargin( 4, 4 ) )
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.AutoWidth()
.VAlign(VAlign_Center)
[
SNew(SCheckBox)
.IsChecked( FCrashReportCoreConfig::Get().GetAllowToBeContacted() ? ECheckBoxState::Checked : ECheckBoxState::Unchecked )
.IsEnabled( !FEngineBuildSettings::IsInternalBuild() )
.OnCheckStateChanged(CrashReportClient.ToSharedRef(), &FCrashReportClient::AllowToBeContacted_OnCheckStateChanged)
]
+SHorizontalBox::Slot()
.FillWidth(1.0f)
.VAlign(VAlign_Center)
[
SNew(STextBlock)
.AutoWrapText(true)
.IsEnabled( !FEngineBuildSettings::IsInternalBuild() )
.Text(LOCTEXT("IAgree", "I agree to be contacted by Epic Games via email if additional information about this crash would help fix it."))
]
]
// Stuff anchored to the bottom
+SVerticalBox::Slot()
.AutoHeight()
.Padding( FMargin(4, 4+16, 4, 4) )
[
SNew(SHorizontalBox)
+ SHorizontalBox::Slot()
.HAlign( HAlign_Center )
.VAlign( VAlign_Center )
.AutoWidth()
.Padding( FMargin( 0 ) )
[
SNew( SButton )
.ContentPadding( FMargin( 8, 2 ) )
.Text( LOCTEXT( "CloseWithoutSending", "Close Without Sending" ) )
.OnClicked( Client, &FCrashReportClient::CloseWithoutSending )
.Visibility(FCrashReportCoreConfig::Get().IsAllowedToCloseWithoutSending() ? EVisibility::Visible : EVisibility::Hidden)
]
+SHorizontalBox::Slot()
.FillWidth(1.0f)
.HAlign(HAlign_Left)
.VAlign(VAlign_Center)
.Padding(0)
[
SNew(SSpacer)
]
+SHorizontalBox::Slot()
.HAlign(HAlign_Center)
.VAlign(VAlign_Center)
.AutoWidth()
.Padding( FMargin(6) )
[
SNew(SButton)
.ContentPadding( FMargin(8,2) )
.Text(LOCTEXT("Send", "Send and Close"))
.OnClicked(Client, &FCrashReportClient::Submit)
.IsEnabled(this, &SCrashReportClient::IsSendEnabled)
]
+SHorizontalBox::Slot()
.HAlign(HAlign_Center)
.VAlign(VAlign_Center)
.AutoWidth()
.Padding( FMargin(0) )
[
SNew(SButton)
.ContentPadding( FMargin(8,2) )
.Text(LOCTEXT("SendAndRestartEditor", "Send and Restart"))
.OnClicked(Client, &FCrashReportClient::SubmitAndRestart)
.IsEnabled(this, &SCrashReportClient::IsSendEnabled)
.Visibility( bHideSubmitAndRestart || FCrashReportCoreConfig::Get().GetHideRestartOption() ? EVisibility::Collapsed : EVisibility::Visible )
]
]
]
];
}
void SCrashReportClient::ConstructSimpleDialog(const TSharedRef<FCrashReportClient>& Client, const FText& CrashDetailedMessage)
{
FString CrashedAppName = FPrimaryCrashProperties::Get()->IsValid() ? FPrimaryCrashProperties::Get()->GameName : TEXT("");
// GameNames have taken on a number of prefixes over the years. Try to strip them all off.
if (!CrashedAppName.RemoveFromStart(TEXT("UE4-")))
{
if (!CrashedAppName.RemoveFromStart(TEXT("UE5-")))
{
CrashedAppName.RemoveFromStart(TEXT("UE-"));
}
}
CrashedAppName.RemoveFromEnd(TEXT("Game"));
ChildSlot
[
SNew(SBorder)
.BorderImage(FCrashReportClientStyle::Get().GetBrush("ToolPanel.GroupBorder"))
[
SNew(SVerticalBox)
// Stuff anchored to the top
+SVerticalBox::Slot()
.AutoHeight()
.Padding(4)
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(STextBlock)
.TextStyle(FCrashReportClientStyle::Get(), "Title")
.Text(FText::FromString(CrashedAppName))
]
]
+SVerticalBox::Slot()
.AutoHeight()
.Padding( FMargin( 4, 10 ) )
[
SNew( SRichTextBlock )
.Text(CrashDetailedMessage)
.AutoWrapText(true)
+ SRichTextBlock::HyperlinkDecorator( TEXT("browser"), FSlateHyperlinkRun::FOnClick::CreateStatic( &OnBrowserLinkClicked ) )
]
// Stuff anchored to the bottom
+SVerticalBox::Slot()
.Padding( FMargin(4, 4+16, 4, 4) )
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.HAlign(HAlign_Right)
.VAlign(VAlign_Bottom)
.Padding( FMargin(6) )
[
SNew(SButton)
.ContentPadding( FMargin(8,2) )
.Text(LOCTEXT("Close", "Close"))
.OnClicked(Client, &FCrashReportClient::Close)
]
]
]
];
}
FReply SCrashReportClient::OnUnhandledKeyDown(const FKeyEvent& InKeyEvent)
{
const FKey Key = InKeyEvent.GetKey();
if (Key == EKeys::Enter)
{
CrashReportClient->Submit();
return FReply::Handled();
}
return FReply::Unhandled();
}
void SCrashReportClient::OnUserCommentTextChanged(const FText& NewText)
{
FText ErrorMessage = FText::GetEmpty();
bHasUserCommentErrors = false;
int SizeLimit = FCrashReportCoreConfig::Get().GetUserCommentSizeLimit();
int Size = NewText.ToString().Len();
if (Size > SizeLimit)
{
bHasUserCommentErrors = true;
ErrorMessage = FText::Format(LOCTEXT("UserCommentTooLongError", "Description may only be a maximum of {0} characters (currently {1})"), SizeLimit, Size);
}
CrashDetailsInformation->SetError(ErrorMessage);
}
EVisibility SCrashReportClient::IsHintTextVisible() const
{
return CrashDetailsInformation->GetText().IsEmpty() ? EVisibility::HitTestInvisible : EVisibility::Hidden;
}
bool SCrashReportClient::IsSendEnabled() const
{
bool bValidAppName = FPrimaryCrashProperties::Get()->IsValid() && !FPrimaryCrashProperties::Get()->GameName.IsEmpty();
return bValidAppName && !bHasUserCommentErrors;
}
#undef LOCTEXT_NAMESPACE
#endif // !CRASH_REPORT_UNATTENDED_ONLY
Reference in New Issue Copy Permalink