You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
#lockdown Nick.Penwarden ========================== MAJOR FEATURES + CHANGES ========================== Change 3351920 on 2017/03/17 by Leigh.Swift #jira OPP-6870: [Crash] Assertion failed: ctx->ReadOffset + length <= (uint32)ctx->CompressedData.Num() [File:D:\Build\++Portal+Release-Live+Compile\Sync\Engine\Source\Runtime\ImageWrapper\Private\PngImageWrapper.cpp] [Line: 420] Instead of asserting for an incorrect data size for png image being loaded, set an error on the wrapper object. This will result in the slate brush rendering as white box, and errors going to the log which include the png resource path. Change 3350561 on 2017/03/16 by Justin.Sargent Updated the Slate standalone D3D renderer to be more fault tolerant. Added new HasLostDevice() function to SlateRenderer. If the launcher detects that it has lost the device context it will attempt to perform a full rebuild of the UI and Presentation layers, but also a full reboot of slate application and the renderer. The launcher will attempt to re-establish the device context for 5 minutes if not interrupted by the user. If the user interacts with the launcher while attempting to re-establish the device context it will instead pop up a system dialog explaining it is having issues with the video card and then will close the application. Change 3341299 on 2017/03/10 by Richard.Fawcett Validate JSON files as we're pushing to EMS Added a flexible validation framework to the system files (EMS) sync operation. Implemented a JSON validator which by default will validate .json files. Adds a "ValidationRules" property to the EMS sync config file to allow each product to define its own regex patterns for filenames which should be validated with each validator. Configured launcher's EMS to validate .product, .v?product, .layout, .sdmeta and .panel files as JSON. The great news is that this validation actually discovered a minor syntactical issue with Wex.v2product during testing, which is also fixed with this submission. \o/ #epicfriday Change 3336908 on 2017/03/08 by Leigh.Swift #jira OPP-5126: All disk size checks for BPS installations should be handled internally to BPS, the Portal code should not need to check this and can only do so less accurately. Removing disk space checks from portal code which block installers from running. NB: There is still a check in selective download code which provides tooltip information only. Moving BuildPatchInstaller disk size check to the file constructor, which is the class that most accurately knows the required amount of space. The disk check now occurs after resume and just before we start to write data. A secondary disk check is also made if a file fails to construct so that we can detect problems caused by change in available disk space. Disk space error message extended to include useful information for the user. Change 3323366 on 2017/02/27 by Richard.Fawcett Fix reference to Newtonsoft in Publishing.Automation. Change 3323205 on 2017/02/27 by Wes.Fudala Adding language support to the windows installer. Significantly expandes OneSky upload functionality. OPP-5438 Launcher installer should support the same language set supported by the launcher. Change 3316926 on 2017/02/22 by Richard.Fawcett Prevent Amazon S3 download glitches from issuing warnings until half of the maximum retries have been attempted. In practice, when we download thousands of files, we _do_ get failures which need to be retried. This means that pretty much all jobs result in warnings, which isn't appropriate. This should turn jobs green again, and only warn us when things look unusual. #jira OPP-6607 Change 3315996 on 2017/02/21 by Justin.Sargent Incrementing Portal version number I'm incrementing this earlier than normal due to a need to depend on a new version number for EMS layout change versioning. Change 3312760 on 2017/02/20 by Wes.Fudala Users can now select desired environment/region from the UI. New login screen. Adds slid out settings menu to login screen. Adds region and language selection to the settings menu. Adds support for PortalRegions ini. Adds DefaultPortalRegions ini. Adds RegionRepository, RegionPublisher, RegionSelectService, and RegionIdentificationService. Adds region select option in debugtools general section. Adds RegionSelectService unit test with associated mocks. Changes the way all backend connections are configured so that values are now pulled from config files. Renames product region selector files to avoid some confusion with portal region files. Updated EmsConfigUpdater and HotfixManager so they support optional overwrite and save of ini files. Region publisher now restricts regions that require permissions in shipping builds. Fixes a bug causing items to get stuck in the download queue UI after we failed to obtain a manifest when reaching out the the backend. #jira OPP-6121, OPP-5809 Change 3311664 on 2017/02/20 by Andrew.Brown Added GetTypeHash support for FDelegateHandle Change 3311505 on 2017/02/20 by Richard.Fawcett Rename/move file(s) Change 3309004 on 2017/02/17 by Chad.Garyet adding in additional platforms for the BuildPlugin commandline Change 3299188 on 2017/02/13 by Leigh.Swift #jira OPP-6711: [CRASH] Assertion failed: IsComplete() Race condition in portal hack allowed an installer to attempt to execute complete delegate before being complete. Change 3294197 on 2017/02/09 by Richard.Fawcett Adding ValidPrereqIds.json This is needed now because the script to enforce correct prereq ids reaches out to Perforce to access this file! #jira OPP-6583 Change 3294059 on 2017/02/09 by Richard.Fawcett Fix comment on PostBuild parameter to reference correct name of "Manifest" property. Change 3293377 on 2017/02/08 by Richard.Fawcett Remove need for a metadata file containing name of generated manifest when using randomized manifest filenames. Change 3282865 on 2017/02/02 by Richard.Fawcett Simplify params to BuildGraph's ChunkTask / PostBuildTask Also, downgrade warnings to simple log messages when falling back to legacy manifest filename construction to ease transition into randomized manifest filenames for game teams. #jira OPP-6435 Change 3282809 on 2017/02/02 by Leigh.Swift #jira OPP-6564: BPT will crash if the FileIgnoreList input instructs the build streamer to ignore every build file. A race condition for getting to the first scanner creation code, vs the build stream exiting with no data. If the former wins, a scanner will be created without enough data to scan. Scanners are now no longer created if the buildstream provided no data. Change 3280848 on 2017/02/01 by Leigh.Swift #jira OPP-3864: BuildPatchServices will log a FATAL error on shutdown even if it's fine to be shutting down. When BPS is shutdown, it will only set error states and cancellation logic if any installers are actually created. Change 3280839 on 2017/02/01 by Leigh.Swift Fixing whitespace damage incoming from Dev-Staging Change 3280820 on 2017/02/01 by Andrew.Brown Copying //Portal/Dev-Main-Staging to Main (//Portal/Main) Change 3280797 on 2017/02/01 by Leigh.Swift #jira OPP-6649: BPS sends undocumented analytics events. Adding documentation for the following events: Patcher.Error.Download Patcher.Warning.ChunkAborted Patcher.Error.Cache Patcher.Error.Construction Patcher.Error.Prerequisites Change 3278887 on 2017/01/31 by Richard.Fawcett Downgrade cleanup warnings to normal log output. The conditions which used to trigger these warnings are now considered to be normal behavior, in a world in which we carry out cross-app game promotions. This results in a perma-yellow state for cleanup, which is unhelpful. #nojira Change 3278738 on 2017/01/31 by Richard.Fawcett Tweak Conan launch parameters Change 3277066 on 2017/01/30 by Richard.Fawcett Remove temporary code which cleans up P:\Builds\UnrealEngineLauncher\BuildGraph, as the location no longer exists. Change 3274907 on 2017/01/27 by Leigh.Swift #jira OPP-6615: Receiving a whisper while in game may minimize game client. Refactoring SWindow ActivateOnFirstShown bool to be ActivationPolicy to give more accurate control. This also allows fixing of misuses of previous ActivateOnFirstShown variables in the implementations, which appear to mostly be interpreting it as 'AlwaysActivate'. The upgrade path is therefore ActivateOnFirstShown true/false becomes ActivationPolicy Always/Never. Moving initial minimize and maximise logic for FWindowsWindow into the Show() call on first show to gain control of activation and respect the provided policy. Refactoring existing uses to use the new variables/functions instead. The refactor of existing code is focused on preserving current always activate behaviour as opposed to changing behaviour to actually only activate on first show. Change 3273466 on 2017/01/26 by Alex.Fennell New build of OpenSSL libraries #JIRA OPP-6408 PriceEngine configuration and fixes for bugs it introduced. Change 3268045 on 2017/01/23 by Richard.Fawcett Re-adding Funcom folk to Conan chunk notification emails Change 3267709 on 2017/01/23 by Richard.Fawcett Fix launch arguments for Conan Exiles editor. Temporarily remove FunCom recipients from notification list to avoid spamming. Change 3265774 on 2017/01/20 by Chad.Garyet Merge of Engine/Build/Buildfarm over to //Portal from Dev-Build Change 3264674 on 2017/01/19 by Alex.Fennell On demand catalog requests Change 3263654 on 2017/01/19 by Leigh.Swift #jira OPP6562: Support looking up tagging and sdmeta info and using it in build diff output Adding tag use understanding to the manifest diff tool of BPT. Adding Selective Download feature support to PPT for it's diff tool, making use of portal's metadata for the feature. Change 3263623 on 2017/01/19 by Richard.Fawcett Fix issue where ManifestFilename is not always available at post build time. #jira OPP-6606 Change 3262013 on 2017/01/18 by Richard.Fawcett Remote potential for success email being sent on third party chunk failure Change 3261914 on 2017/01/18 by Richard.Fawcett Fix for user content generation job not specifying a manifest filename. Change 3261800 on 2017/01/18 by Richard.Fawcett Implement streaming S3 downloads to disk, rather than just to memory This is needed because C# has a 2 billion maximum array dimension, so files > 2GB can't be downloaded using the existing code. Change 3261675 on 2017/01/18 by Richard.Fawcett Support for overriding, or generating randomized unique manifest filenames to avoid automated harvesting from CDN BuildGraph's ChunkTask takes three new parameters ... * ManifestFilename (string) - The filename of the manifest to produce. If omitted, the value of RandomizeManifestFilename will determine how the manifest filename is determined. * RandomizeManifestFilename (bool) - If true, we'll generate a random, unique manifest filename. If false (default), we'll use legacy behavior of combining app name and build version. * LocalManifestDir (string) - Required if RandomizedManifestFilename is true. This directory will receive local copies of any manifest file produced, and a metadata file containing the name of the most recently produced manifest BuildGraph's PostBuildTask takes two new parameters ... * ManifestFilename (string) - The filename of the manifest to post. If omitted, we'll use the value from the metadat file in LocalManifestDir is this is set, otherwise use legacy behavior. * LocalManifestDir (string) - A directory containing local copies of manifest files, along with a metadata file containing the name of the manifest file produced by the most recent ChunkTask operation. Support added to the launcher build script's to use the new parameters to randomize its manifest filename, and post the randomized filename to MCP. Use of a contructor of BuildPatchToolStagingInfo which does not specify a manifest filename is now considered deprecated, and will output a warning. Remove requirement of having a BuildPatchToolStagingInfo when performing a chunking operation, instead just passing in the specific values we need from it as parameters in their own right. Remove support for non-chunk based manifests from C# wrapper, as these are no longer supported in BuildPatchTool itself. #jira OPP-6432 Change 3261647 on 2017/01/18 by Leigh.Swift Adding some cleanup to the end of some BPT functional tests so that they do not affect proceeding tests and cause red-herring warning output. Change 3261639 on 2017/01/18 by Richard.Fawcett Update app name of Conan to ConanExiles to match back-end catalog. Fix Conan launch exe and args so that launcher can detect when product is running. Was previously using a batch file which terminates after launching editor. Change 3258815 on 2017/01/16 by Wes.Fudala UTM and product info will be parsed from installer name and passed to the launcher. UTM info will be passed along as part of all analytics events. #jira OPP-6404: Add user funnel tracking Change 3258809 on 2017/01/16 by Wes.Fudala Back out changelist 3258800. Backing out changes that were intended to be made in a different stream. Change 3258800 on 2017/01/16 by Wes.Fudala App version is now also appended to user agent string. Change 3256999 on 2017/01/13 by Richard.Fawcett Fix issue where JSON file included in Publishing csproj is not reliably copied to output folder on build farm. Change 3256941 on 2017/01/13 by Richard.Fawcett Move configuration for Third Party build pipeline out of code and into its own configuration file. #epicfriday Change 3255072 on 2017/01/12 by Richard.Fawcett Add additional logging around multithreaded upload of files to S3. Fix bug ensuring that the failure of any single part of multi-part upload results in the whole file being failed. #jira OPP-6392 Change 3253672 on 2017/01/11 by Richard.Fawcett Add support for third-party Conan editor. Alter third party process so it doesn't crash if version.txt doesn't already exist in the third party S3 bucket, to allow us to setup in advance of third party publishing their first version. Change 3251901 on 2017/01/10 by Barnabas.McManners Compile fix on mac, fix for hidden method in AutomationTest define. Without this GoogleMock.spec.cpp wont compile on mac. #nojira #ReviewedBy Leigh.Swift Change 3250907 on 2017/01/09 by Justin.Sargent Changed the automation controller to uses a non-zero exit code when performing a 'quit' command if tests failed. Change 3245328 on 2017/01/03 by Justin.Sargent Enabling the logic to lowercase all C++ members exposed to javascript. Added additional to-lowering behavior to UObject binding. #jira OPP-6494 Change 3240667 on 2016/12/20 by Andrew.Brown Copying //Tasks/Portal/Dev-OPP-6109-DedicatedServer to Dev-Main (//Portal/Dev-Main) Change 3236972 on 2016/12/15 by Bob.Ferreira Updating compliation changes for AutomationDriver Change 3236567 on 2016/12/15 by Richard.Fawcett Ensure that third party product chunking uses latest CL across our P4 depot in its version number. Change 3236188 on 2016/12/15 by Richard.Fawcett Combine all launcher purchases into single workflow using the new quickPurchase API call as the initial request. #jira OPP-6257 Change 3231134 on 2016/12/12 by Alex.Fennell Improving fail case handling for the waiting room service #jira OPP-5648 Change 3228514 on 2016/12/09 by Richard.Fawcett Change filetype Change 3227080 on 2016/12/08 by Barnabas.McManners Merging CL 3226840 from Dev Editor Fixing a bug in FText formatting where it would ignore the rebuild and Rebuild as Source arguments for the format string itself #jira OPP-6485 Change 3219810 on 2016/12/02 by Ben.Marsh UAT: Fix unzip output being completely discarded. Switch it to just be verbose instead. Change 3219602 on 2016/12/02 by Ben.Marsh Add the -q (quiet) option to the Mac unzip command, since it's creating too much log output to be useful. [CL 3355309 by Justin Sargent in Main branch]
777 lines
23 KiB
C++
777 lines
23 KiB
C++
// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "LocalizationCommandletExecution.h"
|
|
#include "HAL/FileManager.h"
|
|
#include "Misc/FileHelper.h"
|
|
#include "Misc/Paths.h"
|
|
#include "HAL/Runnable.h"
|
|
#include "HAL/RunnableThread.h"
|
|
#include "Misc/ScopeLock.h"
|
|
#include "Layout/Visibility.h"
|
|
#include "Layout/Margin.h"
|
|
#include "Widgets/SNullWidget.h"
|
|
#include "Styling/SlateColor.h"
|
|
#include "Input/Reply.h"
|
|
#include "Widgets/DeclarativeSyntaxSupport.h"
|
|
#include "Widgets/SWidget.h"
|
|
#include "Widgets/SCompoundWidget.h"
|
|
#include "Widgets/SBoxPanel.h"
|
|
#include "Widgets/SOverlay.h"
|
|
#include "Widgets/SWindow.h"
|
|
#include "Framework/Application/SlateApplication.h"
|
|
#include "Widgets/Layout/SBorder.h"
|
|
#include "Widgets/Images/SImage.h"
|
|
#include "Widgets/Notifications/SProgressBar.h"
|
|
#include "Widgets/Text/STextBlock.h"
|
|
#include "Widgets/Layout/SScrollBar.h"
|
|
#include "Widgets/Text/SMultiLineEditableText.h"
|
|
#include "Widgets/Input/SButton.h"
|
|
#include "Widgets/Views/SHeaderRow.h"
|
|
#include "Widgets/Views/STableViewBase.h"
|
|
#include "Widgets/Views/STableRow.h"
|
|
#include "Widgets/Views/SListView.h"
|
|
#include "EditorStyleSet.h"
|
|
#include "UnrealEdMisc.h"
|
|
#include "LocalizationSettings.h"
|
|
#include "LocalizationConfigurationScript.h"
|
|
#include "DesktopPlatformModule.h"
|
|
#include "Widgets/Images/SThrobber.h"
|
|
#include "Commandlets/CommandletHelpers.h"
|
|
#include "SourceControlHelpers.h"
|
|
|
|
#define LOCTEXT_NAMESPACE "LocalizationCommandletExecutor"
|
|
|
|
namespace
|
|
{
|
|
class SLocalizationCommandletExecutor : public SCompoundWidget
|
|
{
|
|
SLATE_BEGIN_ARGS(SLocalizationCommandletExecutor) {}
|
|
SLATE_END_ARGS()
|
|
|
|
private:
|
|
struct FTaskListModel
|
|
{
|
|
enum class EState
|
|
{
|
|
Queued,
|
|
InProgress,
|
|
Failed,
|
|
Succeeded
|
|
};
|
|
|
|
FTaskListModel()
|
|
: State(EState::Queued)
|
|
{
|
|
}
|
|
|
|
LocalizationCommandletExecution::FTask Task;
|
|
EState State;
|
|
FString LogOutput;
|
|
FString ProcessArguments;
|
|
};
|
|
|
|
friend class STaskRow;
|
|
|
|
public:
|
|
SLocalizationCommandletExecutor();
|
|
~SLocalizationCommandletExecutor();
|
|
|
|
void Construct(const FArguments& Arguments, const TSharedRef<SWindow>& ParentWindow, const TArray<LocalizationCommandletExecution::FTask>& Tasks);
|
|
void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
|
|
bool WasSuccessful() const;
|
|
void Log(const FString& String);
|
|
|
|
private:
|
|
void ExecuteCommandlet(const TSharedRef<FTaskListModel>& TaskListModel);
|
|
void OnCommandletProcessCompletion(const int32 ReturnCode);
|
|
void CancelCommandlet();
|
|
void CleanUpProcessAndPump();
|
|
|
|
bool HasCompleted() const;
|
|
|
|
FText GetProgressMessageText() const;
|
|
TOptional<float> GetProgressPercentage() const;
|
|
|
|
TSharedRef<ITableRow> OnGenerateTaskListRow(TSharedPtr<FTaskListModel> TaskListModel, const TSharedRef<STableViewBase>& Table);
|
|
TSharedPtr<FTaskListModel> GetCurrentTaskToView() const;
|
|
|
|
FText GetCurrentTaskProcessArguments() const;
|
|
FText GetLogString() const;
|
|
|
|
FReply OnCopyLogClicked();
|
|
void CopyLogToClipboard();
|
|
|
|
FReply OnSaveLogClicked();
|
|
|
|
FText GetCloseButtonText() const;
|
|
FReply OnCloseButtonClicked();
|
|
|
|
private:
|
|
int32 CurrentTaskIndex;
|
|
TArray< TSharedPtr<FTaskListModel> > TaskListModels;
|
|
TSharedPtr<SProgressBar> ProgressBar;
|
|
TSharedPtr< SListView< TSharedPtr<FTaskListModel> > > TaskListView;
|
|
|
|
struct
|
|
{
|
|
FCriticalSection CriticalSection;
|
|
FString String;
|
|
} PendingLogData;
|
|
|
|
|
|
TSharedPtr<SWindow> ParentWindow;
|
|
TSharedPtr<FLocalizationCommandletProcess> CommandletProcess;
|
|
FRunnable* Runnable;
|
|
FRunnableThread* RunnableThread;
|
|
};
|
|
|
|
SLocalizationCommandletExecutor::SLocalizationCommandletExecutor()
|
|
: CurrentTaskIndex(INDEX_NONE)
|
|
, Runnable(nullptr)
|
|
, RunnableThread(nullptr)
|
|
{
|
|
}
|
|
|
|
SLocalizationCommandletExecutor::~SLocalizationCommandletExecutor()
|
|
{
|
|
CancelCommandlet();
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::Construct(const FArguments& Arguments, const TSharedRef<SWindow>& InParentWindow, const TArray<LocalizationCommandletExecution::FTask>& Tasks)
|
|
{
|
|
ParentWindow = InParentWindow;
|
|
|
|
for (const LocalizationCommandletExecution::FTask& Task : Tasks)
|
|
{
|
|
const TSharedRef<FTaskListModel> Model = MakeShareable(new FTaskListModel());
|
|
Model->Task = Task;
|
|
TaskListModels.Add(Model);
|
|
}
|
|
|
|
TSharedPtr<SScrollBar> VerticalScrollBar;
|
|
TSharedPtr<SScrollBar> HorizontalScrollBar;
|
|
|
|
ChildSlot
|
|
[
|
|
SNew(SVerticalBox)
|
|
+ SVerticalBox::Slot()
|
|
.AutoHeight()
|
|
.Padding(8.0, 16.0, 16.0, 0.0)
|
|
[
|
|
SNew(SVerticalBox)
|
|
+ SVerticalBox::Slot()
|
|
.AutoHeight()
|
|
[
|
|
SNew(STextBlock)
|
|
.Text(this, &SLocalizationCommandletExecutor::GetProgressMessageText)
|
|
]
|
|
|
|
+ SVerticalBox::Slot()
|
|
.AutoHeight()
|
|
.Padding(0.0, 4.0, 0.0, 0.0)
|
|
[
|
|
SAssignNew(ProgressBar, SProgressBar)
|
|
.Percent(this, &SLocalizationCommandletExecutor::GetProgressPercentage)
|
|
]
|
|
]
|
|
+ SVerticalBox::Slot()
|
|
.FillHeight(0.5)
|
|
.Padding(0.0, 32.0, 8.0, 0.0)
|
|
[
|
|
SNew(SBorder)
|
|
.BorderImage(FEditorStyle::GetBrush("ToolPanel.GroupBorder"))
|
|
.Padding(0.0f)
|
|
[
|
|
SAssignNew(TaskListView, SListView< TSharedPtr<FTaskListModel> >)
|
|
.HeaderRow
|
|
(
|
|
SNew(SHeaderRow)
|
|
+ SHeaderRow::Column("StatusIcon")
|
|
.DefaultLabel(FText::GetEmpty())
|
|
.FixedWidth(20.0)
|
|
+ SHeaderRow::Column("TaskName")
|
|
.DefaultLabel(LOCTEXT("TaskListNameColumnLabel", "Task"))
|
|
.FillWidth(1.0)
|
|
)
|
|
.ListItemsSource(&TaskListModels)
|
|
.OnGenerateRow(this, &SLocalizationCommandletExecutor::OnGenerateTaskListRow)
|
|
.ItemHeight(24.0)
|
|
.SelectionMode(ESelectionMode::Single)
|
|
]
|
|
]
|
|
+ SVerticalBox::Slot()
|
|
.FillHeight(0.5)
|
|
.Padding(0.0, 32.0, 8.0, 0.0)
|
|
[
|
|
SNew(SBorder)
|
|
.BorderImage(FEditorStyle::GetBrush("ToolPanel.GroupBorder"))
|
|
.Padding(0.0f)
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+SHorizontalBox::Slot()
|
|
.FillWidth(1.0f)
|
|
[
|
|
SNew(SVerticalBox)
|
|
+SVerticalBox::Slot()
|
|
.FillHeight(1.0f)
|
|
[
|
|
SNew(SMultiLineEditableText)
|
|
.TextStyle(FEditorStyle::Get(), "LocalizationDashboard.CommandletLog.Text")
|
|
.Text(this, &SLocalizationCommandletExecutor::GetLogString)
|
|
.IsReadOnly(true)
|
|
.HScrollBar(HorizontalScrollBar)
|
|
.VScrollBar(VerticalScrollBar)
|
|
]
|
|
+SVerticalBox::Slot()
|
|
.AutoHeight()
|
|
[
|
|
SAssignNew(HorizontalScrollBar, SScrollBar)
|
|
.Orientation(EOrientation::Orient_Horizontal)
|
|
]
|
|
]
|
|
+SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
SAssignNew(VerticalScrollBar, SScrollBar)
|
|
.Orientation(EOrientation::Orient_Vertical)
|
|
]
|
|
]
|
|
]
|
|
+ SVerticalBox::Slot()
|
|
.AutoHeight()
|
|
.Padding(0.0f, 5.0f, 0.0f, 0.0f)
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
SNew(SButton)
|
|
.ContentPadding(FMargin(6.0f, 2.0f))
|
|
.Text(LOCTEXT("CopyLogButtonText", "Copy Log"))
|
|
.ToolTipText(LOCTEXT("CopyLogButtonTooltip", "Copy the logged text to the clipboard."))
|
|
.OnClicked(this, &SLocalizationCommandletExecutor::OnCopyLogClicked)
|
|
]
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
SNew(SButton)
|
|
.ContentPadding(FMargin(6.0f, 2.0f))
|
|
.IsEnabled(false)
|
|
.Text(LOCTEXT("SaveLogButtonText", "Save Log..."))
|
|
.ToolTipText(LOCTEXT("SaveLogButtonToolTip", "Save the logged text to a file."))
|
|
.OnClicked(this, &SLocalizationCommandletExecutor::OnSaveLogClicked)
|
|
]
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
SNew(SButton)
|
|
.ContentPadding(FMargin(6.0f, 2.0f))
|
|
.OnClicked(this, &SLocalizationCommandletExecutor::OnCloseButtonClicked)
|
|
[
|
|
SNew(STextBlock)
|
|
.Text(this, &SLocalizationCommandletExecutor::GetCloseButtonText)
|
|
]
|
|
]
|
|
]
|
|
];
|
|
|
|
if(TaskListModels.Num() > 0)
|
|
{
|
|
CurrentTaskIndex = 0;
|
|
ExecuteCommandlet(TaskListModels[CurrentTaskIndex].ToSharedRef());
|
|
}
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )
|
|
{
|
|
SCompoundWidget::Tick(AllottedGeometry, InCurrentTime, InDeltaTime);
|
|
|
|
// Poll for log output data.
|
|
if (!PendingLogData.String.IsEmpty())
|
|
{
|
|
FString String;
|
|
|
|
// Copy the pending data string to the local string
|
|
{
|
|
FScopeLock ScopeLock(&PendingLogData.CriticalSection);
|
|
String = PendingLogData.String;
|
|
PendingLogData.String.Empty();
|
|
}
|
|
|
|
// Forward string to proper log.
|
|
const TSharedPtr<FTaskListModel> CurrentTaskModel = TaskListModels[CurrentTaskIndex];
|
|
CurrentTaskModel->LogOutput.Append(String);
|
|
}
|
|
|
|
// On Task Completed.
|
|
if (CommandletProcess.IsValid())
|
|
{
|
|
FProcHandle CurrentProcessHandle = CommandletProcess->GetHandle();
|
|
int32 ReturnCode;
|
|
if (CurrentProcessHandle.IsValid() && FPlatformProcess::GetProcReturnCode(CurrentProcessHandle, &ReturnCode))
|
|
{
|
|
OnCommandletProcessCompletion(ReturnCode);
|
|
}
|
|
}
|
|
}
|
|
|
|
bool SLocalizationCommandletExecutor::WasSuccessful() const
|
|
{
|
|
return HasCompleted() && !TaskListModels.ContainsByPredicate([](const TSharedPtr<FTaskListModel>& TaskListModel){return TaskListModel->State != FTaskListModel::EState::Succeeded;});
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::Log(const FString& String)
|
|
{
|
|
FScopeLock ScopeLock(&PendingLogData.CriticalSection);
|
|
PendingLogData.String += String;
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::OnCommandletProcessCompletion(const int32 ReturnCode)
|
|
{
|
|
CleanUpProcessAndPump();
|
|
|
|
// Handle return code.
|
|
TSharedPtr<FTaskListModel> CurrentTaskModel = TaskListModels[CurrentTaskIndex];
|
|
|
|
// Restore engine's source control settings if necessary.
|
|
if (!CurrentTaskModel->Task.ShouldUseProjectFile)
|
|
{
|
|
const FString& EngineIniFile = SourceControlHelpers::GetGlobalSettingsIni();
|
|
const FString BackupEngineIniFile = FPaths::EngineSavedDir() / FPaths::GetCleanFilename(EngineIniFile) + TEXT(".bak");
|
|
if(!IFileManager::Get().Move(*EngineIniFile, *BackupEngineIniFile))
|
|
{
|
|
// TODO: Error failed to restore engine source control settings INI.
|
|
}
|
|
}
|
|
|
|
// Zero code is successful.
|
|
if (ReturnCode == 0)
|
|
{
|
|
CurrentTaskModel->State = FTaskListModel::EState::Succeeded;
|
|
|
|
++CurrentTaskIndex;
|
|
|
|
// Begin new task if possible.
|
|
if (TaskListModels.IsValidIndex(CurrentTaskIndex))
|
|
{
|
|
CurrentTaskModel = TaskListModels[CurrentTaskIndex];
|
|
ExecuteCommandlet(CurrentTaskModel.ToSharedRef());
|
|
}
|
|
}
|
|
// Non-zero is a failure.
|
|
else
|
|
{
|
|
CurrentTaskModel->State = FTaskListModel::EState::Failed;
|
|
}
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::ExecuteCommandlet(const TSharedRef<FTaskListModel>& TaskListModel)
|
|
{
|
|
// Handle source control settings if not using project file for commandlet executable process.
|
|
if (!TaskListModel->Task.ShouldUseProjectFile)
|
|
{
|
|
const FString& EngineIniFile = SourceControlHelpers::GetGlobalSettingsIni();
|
|
|
|
// Backup engine's source control settings.
|
|
const FString BackupEngineIniFile = FPaths::EngineSavedDir() / FPaths::GetCleanFilename(EngineIniFile) + TEXT(".bak");
|
|
if (COPY_OK == IFileManager::Get().Copy(*BackupEngineIniFile, *EngineIniFile))
|
|
{
|
|
// Replace engine's source control settings with project's.
|
|
const FString& ProjectIniFile = SourceControlHelpers::GetSettingsIni();
|
|
if (COPY_OK == IFileManager::Get().Copy(*EngineIniFile, *ProjectIniFile))
|
|
{
|
|
// TODO: Error failed to overwrite engine source control settings INI.
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// TODO: Error failed to backup engine source control settings INI.
|
|
}
|
|
}
|
|
|
|
CommandletProcess = FLocalizationCommandletProcess::Execute(TaskListModel->Task.ScriptPath, TaskListModel->Task.ShouldUseProjectFile);
|
|
if (CommandletProcess.IsValid())
|
|
{
|
|
TaskListModel->State = FTaskListModel::EState::InProgress;
|
|
TaskListModel->ProcessArguments = CommandletProcess->GetProcessArguments();
|
|
}
|
|
else
|
|
{
|
|
TaskListModel->State = FTaskListModel::EState::Failed;
|
|
return;
|
|
}
|
|
|
|
class FCommandletLogPump : public FRunnable
|
|
{
|
|
public:
|
|
FCommandletLogPump(void* const InReadPipe, const FProcHandle& InCommandletProcessHandle, SLocalizationCommandletExecutor& InCommandletWidget)
|
|
: ReadPipe(InReadPipe)
|
|
, CommandletProcessHandle(InCommandletProcessHandle)
|
|
, CommandletWidget(&InCommandletWidget)
|
|
{
|
|
}
|
|
|
|
uint32 Run() override
|
|
{
|
|
for(;;)
|
|
{
|
|
// Read from pipe.
|
|
const FString PipeString = FPlatformProcess::ReadPipe(ReadPipe);
|
|
|
|
// Process buffer.
|
|
if (!PipeString.IsEmpty())
|
|
{
|
|
// Add strings to log.
|
|
if (CommandletWidget)
|
|
{
|
|
CommandletWidget->Log(PipeString);
|
|
}
|
|
}
|
|
|
|
// If the process isn't running and there's no data in the pipe, we're done.
|
|
if (!FPlatformProcess::IsProcRunning(CommandletProcessHandle) && PipeString.IsEmpty())
|
|
{
|
|
break;
|
|
}
|
|
|
|
// Sleep.
|
|
FPlatformProcess::Sleep(0.0f);
|
|
}
|
|
|
|
int32 ReturnCode = 0;
|
|
return FPlatformProcess::GetProcReturnCode(CommandletProcessHandle, &ReturnCode) ? ReturnCode : -1;
|
|
}
|
|
|
|
private:
|
|
void* const ReadPipe;
|
|
FProcHandle CommandletProcessHandle;
|
|
SLocalizationCommandletExecutor* const CommandletWidget;
|
|
};
|
|
|
|
// Launch runnable thread.
|
|
Runnable = new FCommandletLogPump(CommandletProcess->GetReadPipe(), CommandletProcess->GetHandle(), *this);
|
|
RunnableThread = FRunnableThread::Create(Runnable, TEXT("Localization Commandlet Log Pump Thread"));
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::CancelCommandlet()
|
|
{
|
|
CleanUpProcessAndPump();
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::CleanUpProcessAndPump()
|
|
{
|
|
if (CommandletProcess.IsValid())
|
|
{
|
|
FProcHandle CommandletProcessHandle = CommandletProcess->GetHandle();
|
|
if (CommandletProcessHandle.IsValid() && FPlatformProcess::IsProcRunning(CommandletProcessHandle))
|
|
{
|
|
FPlatformProcess::TerminateProc(CommandletProcessHandle, true);
|
|
}
|
|
CommandletProcess.Reset();
|
|
}
|
|
|
|
if (RunnableThread)
|
|
{
|
|
RunnableThread->WaitForCompletion();
|
|
delete RunnableThread;
|
|
RunnableThread = nullptr;
|
|
}
|
|
|
|
if (Runnable)
|
|
{
|
|
delete Runnable;
|
|
Runnable = nullptr;
|
|
}
|
|
|
|
}
|
|
|
|
bool SLocalizationCommandletExecutor::HasCompleted() const
|
|
{
|
|
return CurrentTaskIndex == TaskListModels.Num();
|
|
}
|
|
|
|
FText SLocalizationCommandletExecutor::GetProgressMessageText() const
|
|
{
|
|
return TaskListModels.IsValidIndex(CurrentTaskIndex) ? TaskListModels[CurrentTaskIndex]->Task.Name : FText::GetEmpty();
|
|
}
|
|
|
|
TOptional<float> SLocalizationCommandletExecutor::GetProgressPercentage() const
|
|
{
|
|
return TOptional<float>(float(CurrentTaskIndex) / float(TaskListModels.Num()));
|
|
}
|
|
|
|
class STaskRow : public SMultiColumnTableRow< TSharedPtr<SLocalizationCommandletExecutor::FTaskListModel> >
|
|
{
|
|
public:
|
|
void Construct(const FTableRowArgs& InArgs, const TSharedRef<STableViewBase>& OwnerTableView, const TSharedRef<SLocalizationCommandletExecutor::FTaskListModel>& InTaskListModel);
|
|
TSharedRef<SWidget> GenerateWidgetForColumn(const FName& ColumnName);
|
|
|
|
private:
|
|
FSlateColor HandleIconColorAndOpacity() const;
|
|
const FSlateBrush* HandleIconImage() const;
|
|
EVisibility HandleThrobberVisibility() const;
|
|
|
|
private:
|
|
TSharedPtr<SLocalizationCommandletExecutor::FTaskListModel> TaskListModel;
|
|
};
|
|
|
|
void STaskRow::Construct(const FTableRowArgs& InArgs, const TSharedRef<STableViewBase>& OwnerTableView, const TSharedRef<SLocalizationCommandletExecutor::FTaskListModel>& InTaskListModel)
|
|
{
|
|
TaskListModel = InTaskListModel;
|
|
|
|
FSuperRowType::Construct(InArgs, OwnerTableView);
|
|
}
|
|
|
|
TSharedRef<SWidget> STaskRow::GenerateWidgetForColumn(const FName& ColumnName)
|
|
{
|
|
if (ColumnName == "StatusIcon")
|
|
{
|
|
return SNew(SOverlay)
|
|
|
|
+ SOverlay::Slot()
|
|
.HAlign(HAlign_Center)
|
|
.VAlign(VAlign_Center)
|
|
[
|
|
SNew(SThrobber)
|
|
.Animate(SThrobber::VerticalAndOpacity)
|
|
.NumPieces(1)
|
|
.Visibility(this, &STaskRow::HandleThrobberVisibility)
|
|
]
|
|
+ SOverlay::Slot()
|
|
.HAlign(HAlign_Center)
|
|
.VAlign(VAlign_Center)
|
|
[
|
|
SNew(SImage)
|
|
.ColorAndOpacity(this, &STaskRow::HandleIconColorAndOpacity)
|
|
.Image(this, &STaskRow::HandleIconImage)
|
|
];
|
|
}
|
|
else if (ColumnName == "TaskName")
|
|
{
|
|
return SNew(STextBlock)
|
|
.Text(TaskListModel->Task.Name)
|
|
.ToolTipText_Lambda( [this]{ return FText::FromString(TaskListModel->ProcessArguments); } );
|
|
}
|
|
else
|
|
{
|
|
return SNullWidget::NullWidget;
|
|
}
|
|
}
|
|
|
|
FSlateColor STaskRow::HandleIconColorAndOpacity( ) const
|
|
{
|
|
if (TaskListModel.IsValid())
|
|
{
|
|
switch(TaskListModel->State)
|
|
{
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::InProgress:
|
|
return FLinearColor::Yellow;
|
|
break;
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::Succeeded:
|
|
return FLinearColor::Green;
|
|
break;
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::Failed:
|
|
return FLinearColor::Red;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return FSlateColor::UseForeground();
|
|
}
|
|
|
|
const FSlateBrush* STaskRow::HandleIconImage( ) const
|
|
{
|
|
if (TaskListModel.IsValid())
|
|
{
|
|
switch(TaskListModel->State)
|
|
{
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::Succeeded:
|
|
return FEditorStyle::GetBrush("Symbols.Check");
|
|
break;
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::Failed:
|
|
return FEditorStyle::GetBrush("Icons.Cross");
|
|
break;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
EVisibility STaskRow::HandleThrobberVisibility( ) const
|
|
{
|
|
if (TaskListModel.IsValid())
|
|
{
|
|
switch(TaskListModel->State)
|
|
{
|
|
case SLocalizationCommandletExecutor::FTaskListModel::EState::InProgress:
|
|
return EVisibility::Visible;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return EVisibility::Hidden;
|
|
}
|
|
|
|
TSharedRef<ITableRow> SLocalizationCommandletExecutor::OnGenerateTaskListRow(TSharedPtr<FTaskListModel> TaskListModel, const TSharedRef<STableViewBase>& Table)
|
|
{
|
|
return SNew(STaskRow, Table, TaskListModel.ToSharedRef());
|
|
}
|
|
|
|
TSharedPtr<SLocalizationCommandletExecutor::FTaskListModel> SLocalizationCommandletExecutor::GetCurrentTaskToView() const
|
|
{
|
|
if (TaskListView.IsValid())
|
|
{
|
|
const TArray< TSharedPtr<FTaskListModel> > Selection = TaskListView->GetSelectedItems();
|
|
return Selection.Num() > 0 ? Selection.Top() : nullptr;
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
FText SLocalizationCommandletExecutor::GetCurrentTaskProcessArguments() const
|
|
{
|
|
const TSharedPtr<SLocalizationCommandletExecutor::FTaskListModel> TaskToView = GetCurrentTaskToView();
|
|
return TaskToView.IsValid() ? FText::FromString(TaskToView->ProcessArguments) : FText::GetEmpty();
|
|
}
|
|
|
|
FText SLocalizationCommandletExecutor::GetLogString() const
|
|
{
|
|
const TSharedPtr<SLocalizationCommandletExecutor::FTaskListModel> TaskToView = GetCurrentTaskToView();
|
|
return TaskToView.IsValid() ? FText::FromString(TaskToView->LogOutput) : FText::GetEmpty();
|
|
}
|
|
|
|
FReply SLocalizationCommandletExecutor::OnCopyLogClicked()
|
|
{
|
|
CopyLogToClipboard();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
void SLocalizationCommandletExecutor::CopyLogToClipboard()
|
|
{
|
|
FPlatformMisc::ClipboardCopy(*(GetLogString().ToString()));
|
|
}
|
|
|
|
FReply SLocalizationCommandletExecutor::OnSaveLogClicked()
|
|
{
|
|
const FString TextFileDescription = LOCTEXT("TextFileDescription", "Text File").ToString();
|
|
const FString TextFileExtension = TEXT("txt");
|
|
const FString TextFileExtensionWildcard = FString::Printf(TEXT("*.%s"), *TextFileExtension);
|
|
const FString FileTypes = FString::Printf(TEXT("%s (%s)|%s"), *TextFileDescription, *TextFileExtensionWildcard, *TextFileExtensionWildcard);
|
|
const FString DefaultFilename = FString::Printf(TEXT("%s.%s"), TEXT("Log"), *TextFileExtension);
|
|
const FString DefaultPath = FPaths::GameSavedDir();
|
|
|
|
TArray<FString> SaveFilenames;
|
|
IDesktopPlatform* DesktopPlatform = FDesktopPlatformModule::Get();
|
|
|
|
// Prompt the user for the filename
|
|
if (DesktopPlatform)
|
|
{
|
|
void* ParentWindowWindowHandle = NULL;
|
|
|
|
const TSharedPtr<SWindow>& ParentWindowPtr = FSlateApplication::Get().FindWidgetWindow(AsShared());
|
|
if (ParentWindowPtr.IsValid() && ParentWindowPtr->GetNativeWindow().IsValid())
|
|
{
|
|
ParentWindowWindowHandle = ParentWindowPtr->GetNativeWindow()->GetOSWindowHandle();
|
|
}
|
|
|
|
if (DesktopPlatform->SaveFileDialog(
|
|
ParentWindowWindowHandle,
|
|
LOCTEXT("SaveLogDialogTitle", "Save Log to File").ToString(),
|
|
DefaultPath,
|
|
DefaultFilename,
|
|
FileTypes,
|
|
EFileDialogFlags::None,
|
|
SaveFilenames
|
|
))
|
|
{
|
|
// Save to file.
|
|
FFileHelper::SaveStringToFile( GetLogString().ToString(), *(SaveFilenames.Last()) );
|
|
}
|
|
}
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
FText SLocalizationCommandletExecutor::GetCloseButtonText() const
|
|
{
|
|
return HasCompleted() ? LOCTEXT("OkayButtonText", "Okay") : LOCTEXT("CancelButtonText", "Cancel");
|
|
}
|
|
|
|
FReply SLocalizationCommandletExecutor::OnCloseButtonClicked()
|
|
{
|
|
if (!HasCompleted())
|
|
{
|
|
CancelCommandlet();
|
|
}
|
|
ParentWindow->RequestDestroyWindow();
|
|
return FReply::Handled();
|
|
}
|
|
}
|
|
|
|
bool LocalizationCommandletExecution::Execute(const TSharedRef<SWindow>& ParentWindow, const FText& Title, const TArray<FTask>& Tasks)
|
|
{
|
|
const TSharedRef<SWindow> CommandletWindow = SNew(SWindow)
|
|
.Title(Title)
|
|
.SupportsMinimize(false)
|
|
.AutoCenter(EAutoCenter::PreferredWorkArea)
|
|
.ClientSize(FVector2D(600,400))
|
|
.ActivationPolicy(EWindowActivationPolicy::Always)
|
|
.FocusWhenFirstShown(true);
|
|
const TSharedRef<SLocalizationCommandletExecutor> CommandletExecutor = SNew(SLocalizationCommandletExecutor, CommandletWindow, Tasks);
|
|
CommandletWindow->SetContent(CommandletExecutor);
|
|
|
|
FSlateApplication::Get().AddModalWindow(CommandletWindow, ParentWindow, false);
|
|
return CommandletExecutor->WasSuccessful();
|
|
}
|
|
|
|
TSharedPtr<FLocalizationCommandletProcess> FLocalizationCommandletProcess::Execute(const FString& ConfigFilePath, const bool UseProjectFile)
|
|
{
|
|
// Create pipes.
|
|
void* ReadPipe;
|
|
void* WritePipe;
|
|
if (!FPlatformProcess::CreatePipe(ReadPipe, WritePipe))
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
// Create process.
|
|
FString CommandletArguments;
|
|
|
|
const FString ConfigFileRelativeToGameDir = LocalizationConfigurationScript::MakePathRelativeForCommandletProcess(ConfigFilePath, UseProjectFile);
|
|
CommandletArguments = FString::Printf( TEXT("-config=\"%s\""), *ConfigFileRelativeToGameDir );
|
|
|
|
if (FLocalizationSourceControlSettings::IsSourceControlEnabled())
|
|
{
|
|
CommandletArguments += TEXT(" -EnableSCC");
|
|
|
|
if (!FLocalizationSourceControlSettings::IsSourceControlAutoSubmitEnabled())
|
|
{
|
|
CommandletArguments += TEXT(" -DisableSCCSubmit");
|
|
}
|
|
}
|
|
|
|
const FString ProjectFilePath = FString::Printf(TEXT("\"%s\""), *FPaths::ConvertRelativePathToFull(FPaths::GetProjectFilePath()));
|
|
const FString ProcessArguments = CommandletHelpers::BuildCommandletProcessArguments(TEXT("GatherText"), UseProjectFile ? *ProjectFilePath : nullptr, *CommandletArguments);
|
|
FProcHandle CommandletProcessHandle = FPlatformProcess::CreateProc(*FUnrealEdMisc::Get().GetExecutableForCommandlets(), *ProcessArguments, true, true, true, nullptr, 0, nullptr, WritePipe);
|
|
|
|
// Close pipes if process failed.
|
|
if (!CommandletProcessHandle.IsValid())
|
|
{
|
|
FPlatformProcess::ClosePipe(ReadPipe, WritePipe);
|
|
return nullptr;
|
|
}
|
|
|
|
return MakeShareable(new FLocalizationCommandletProcess(ReadPipe, WritePipe, CommandletProcessHandle, ProcessArguments));
|
|
}
|
|
|
|
FLocalizationCommandletProcess::~FLocalizationCommandletProcess()
|
|
{
|
|
if (ProcessHandle.IsValid() && FPlatformProcess::IsProcRunning(ProcessHandle))
|
|
{
|
|
FPlatformProcess::TerminateProc(ProcessHandle);
|
|
}
|
|
FPlatformProcess::ClosePipe(ReadPipe, WritePipe);
|
|
}
|
|
|
|
#undef LOCTEXT_NAMESPACE
|