1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*!********************************************************************
Audacity: A Digital Audio Editor
CloudSyncStatusField.cpp
Dmitry Vedenko
**********************************************************************/
#include "CloudSyncStatusField.h"
#include <algorithm>
#include <wx/bitmap.h>
#include <wx/dcbuffer.h>
#include <wx/graphics.h>
#include <wx/statusbr.h>
#include "Project.h"
#include "ProjectStatus.h"
#include "ProjectWindow.h"
#include "sync/ProjectCloudExtension.h"
#include "AllThemeResources.h"
#include "Theme.h"
#include "wxPanelWrapper.h"
#include "Prefs.h"
#if wxUSE_ACCESSIBILITY
# include "WindowAccessible.h"
#endif
namespace audacity::cloud::audiocom::sync
{
namespace
{
const StatusBarField FieldId { L"CloudSyncStatus" };
const AttachedProjectObjects::RegisteredFactory key {
[](AudacityProject& project)
{ return std::make_shared<CloudSyncStatusField>(project); }
};
class CloudSyncStatusBarFieldItem final : public StatusBarFieldItem
{
public:
CloudSyncStatusBarFieldItem()
: StatusBarFieldItem { FieldId }
{
}
int GetDefaultWidth(const AudacityProject& project) const override
{
return CloudSyncStatusField::Get(project).GetWidth();
}
void OnSize(AudacityProject& project) override
{
const auto index =
ProjectStatusFieldsRegistry::GetFieldIndex(project, name);
if (index < 0)
return;
wxRect rect;
if (ProjectWindow::Get(project).GetStatusBar()->GetFieldRect(index, rect))
CloudSyncStatusField::Get(project).OnSize(rect);
}
void
SetText(AudacityProject& project, const TranslatableString& msg) override
{
}
TranslatableString GetText(const AudacityProject& project) const override
{
return CloudSyncStatusField::Get(project).GetText();
}
bool IsVisible(const AudacityProject& project) const override
{
return CloudSyncStatusField::Get(project).IsVisible();
}
void MarkDirty(const AudacityProject& project)
{
DispatchFieldChanged(project);
}
}; // class CloudSyncStatusBarFieldItem
StatusBarFieldItemRegistrator rateStatusBarField {
std::make_unique<CloudSyncStatusBarFieldItem>(),
{ {}, { Registry::OrderingHint::After, RateStatusBarField().GET() } }
};
const auto CloudSyncFailedMessage = XO("Failed.");
const auto CloudSyncProgressMessage = XO("Syncing to audio.com... (%d%%)");
const auto Padding = 2;
const auto ProgressBarWidth = 240;
const auto ProgressBarHeight = 10;
const auto ProgressBarBorderSize = 1;
#if __WXMAC__
const auto StatusFieldPadding = 20;
#else
const auto StatusFieldPadding = 0;
#endif
} // namespace
class CloudSyncStatusField::StatusWidget final :
public wxPanelWrapper,
public PrefsListener
{
public:
StatusWidget(CloudSyncStatusField& owner, wxWindow* parent)
: wxPanelWrapper { parent }
, mOwner { owner }
{
SetBackgroundStyle(wxBG_STYLE_PAINT);
UpdatePrefs();
Bind(wxEVT_PAINT, [this](auto&) { OnPaint(); });
#if wxUSE_ACCESSIBILITY
SetAccessible(safenew WindowAccessible(this));
#endif
}
~StatusWidget() override
{
}
void SetRect(const wxRect& rect)
{
SetSize(rect);
}
int GetPreferredWidth(State state) const
{
switch (state)
{
case State::Failed:
return mSyncedBitmap->GetWidth() + mCloudSyncFailedMessageWidth +
Padding * 4;
case State::Uploading:
return mProgressBitmap->GetWidth() + mCloudSyncProgressMessageWidth +
ProgressBarWidth + Padding * 4;
}
return mSyncedBitmap->GetWidth() + Padding * 2;
}
const wxBitmap* GetBitmap() const
{
return mOwner.mState == State::Uploading ? mProgressBitmap :
mSyncedBitmap;
}
TranslatableString GetTranslatableText() const
{
if (mOwner.mState == State::Uploading)
return TranslatableString { CloudSyncProgressMessage }.Format(
mOwner.mProgress);
else if (mOwner.mState == State::Failed)
return CloudSyncFailedMessage;
return {};
}
wxString GetText() const
{
return GetTranslatableText().Translation();
}
void OnPaint()
{
wxAutoBufferedPaintDC dc(this);
std::unique_ptr<wxGraphicsContext> gc(wxGraphicsContext::Create(dc));
auto bitmap = GetBitmap();
const wxSize widgetSize = GetSize();
const wxSize bitmapSize = bitmap->GetSize();
gc->SetBrush(wxBrush(GetBackgroundColour()));
gc->DrawRectangle(0, 0, widgetSize.x, widgetSize.y);
gc->DrawBitmap(
*bitmap, Padding, (widgetSize.y - bitmapSize.y) / 2.0, bitmapSize.x,
bitmapSize.y);
const auto text = GetText();
if (text.empty())
return;
gc->SetFont(GetFont(), GetForegroundColour());
gc->DrawText(text, Padding + bitmapSize.x + 2 * Padding, 0);
if (mOwner.mState != State::Uploading)
return;
gc->SetAntialiasMode(wxANTIALIAS_NONE);
const auto progress = std::clamp(mOwner.mProgress, 0, 100);
const auto progressFilledPen =
gc->CreatePen(wxGraphicsPenInfo {}
.Colour(wxColour(0xc3c3c3))
.Width(ProgressBarBorderSize));
const auto progressEmptyPen =
gc->CreatePen(wxGraphicsPenInfo {}
.Colour(wxColour(0xc3c3c3))
.Width(ProgressBarBorderSize));
const auto zeroPen = gc->CreatePen(
wxGraphicsPenInfo {}.Width(0).Style(wxPENSTYLE_TRANSPARENT));
const auto progressFilledBrush = gc->CreateBrush(wxColour(0x3cf03c));
const auto progressEmptyBrush = gc->CreateBrush(wxColour(0xffffff));
const auto progressBarBorderLeft =
Padding + bitmapSize.x + 2 * Padding + mCloudSyncProgressMessageWidth;
const auto progressBarBorderRight =
progressBarBorderLeft + ProgressBarWidth;
const auto progressBarBorderTop =
(widgetSize.y - ProgressBarHeight) / 2.0;
const auto progressBarBorderBottom =
progressBarBorderTop + ProgressBarHeight;
const auto filledWidth =
(ProgressBarWidth - ProgressBarBorderSize * 2) * progress / 100;
const auto progressBarFillLeft =
progressBarBorderLeft + ProgressBarBorderSize;
const auto progressBarFillRight = progressBarFillLeft + filledWidth;
const auto progressBarEmptyLeft =
progressBarFillRight + (progress > 0 ? 1 : 0);
const auto progressBarEmptyRight =
progressBarBorderRight - ProgressBarBorderSize;
const auto filledHeight = ProgressBarHeight - ProgressBarBorderSize;
// Draw border
if (progress == 0)
gc->SetPen(progressEmptyPen);
else
gc->SetPen(progressFilledPen);
gc->StrokeLine(
progressBarBorderLeft, progressBarBorderTop, progressBarBorderLeft,
progressBarBorderBottom);
if (progress > 0)
{
gc->StrokeLine(
progressBarFillLeft, progressBarBorderTop, progressBarFillRight,
progressBarBorderTop);
gc->StrokeLine(
progressBarFillLeft, progressBarBorderBottom, progressBarFillRight,
progressBarBorderBottom);
gc->SetPen(zeroPen);
gc->SetBrush(progressFilledBrush);
gc->DrawRectangle(
progressBarFillLeft, progressBarBorderTop + ProgressBarBorderSize,
progressBarFillRight - progressBarFillLeft + 1, filledHeight);
}
if (progress < 100)
{
gc->SetPen(progressEmptyPen);
gc->StrokeLine(
progressBarEmptyLeft, progressBarBorderTop, progressBarEmptyRight,
progressBarBorderTop);
gc->StrokeLine(
progressBarEmptyLeft, progressBarBorderBottom,
progressBarEmptyRight, progressBarBorderBottom);
gc->SetPen(zeroPen);
gc->SetBrush(progressEmptyBrush);
gc->DrawRectangle(
progressBarEmptyLeft, progressBarBorderTop + ProgressBarBorderSize,
progressBarEmptyRight - progressBarEmptyLeft + 1, filledHeight);
}
if (progress == 100)
gc->SetPen(progressFilledPen);
else
gc->SetPen(progressEmptyPen);
gc->StrokeLine(
progressBarBorderRight, progressBarBorderTop, progressBarBorderRight,
progressBarBorderBottom);
}
void UpdatePrefs() override
{
mSyncedBitmap = &theTheme.Bitmap(bmpCloud);
mProgressBitmap = &theTheme.Bitmap(bmpCloudProgress);
mCloudSyncFailedMessageWidth =
GetTextExtent(CloudSyncFailedMessage.Translation()).x;
mCloudSyncProgressMessageWidth =
GetTextExtent(TranslatableString { CloudSyncProgressMessage }
.Format(100)
.Translation())
.x;
}
void UpdateName()
{
SetName(GetTranslatableText());
}
private:
CloudSyncStatusField& mOwner;
const wxBitmap* mSyncedBitmap {};
const wxBitmap* mProgressBitmap {};
int mCloudSyncFailedMessageWidth {};
int mCloudSyncProgressMessageWidth {};
}; // class CloudSyncStatusField::StatusWidget
CloudSyncStatusField::CloudSyncStatusField(AudacityProject& project)
: mProject { project }
, mCloudExtension { ProjectCloudExtension::Get(project) }
, mCloudStatusChangedSubscription { mCloudExtension.SubscribeStatusChanged(
[this](const auto& extension) { OnCloudStatusChanged(extension); },
true) }
{
}
CloudSyncStatusField::~CloudSyncStatusField() = default;
CloudSyncStatusField& CloudSyncStatusField::Get(AudacityProject& project)
{
return project.AttachedObjects::Get<CloudSyncStatusField&>(key);
}
const CloudSyncStatusField&
CloudSyncStatusField::Get(const AudacityProject& project)
{
return Get(const_cast<AudacityProject&>(project));
}
int CloudSyncStatusField::GetWidth() const
{
return mCloudExtension.IsCloudProject() ?
(GetStatusWidget().GetPreferredWidth(mState) +
StatusFieldPadding) :
0;
}
void CloudSyncStatusField::OnSize(const wxRect& rect)
{
GetStatusWidget().SetRect(rect);
}
bool CloudSyncStatusField::IsVisible() const
{
return mState != State::Hidden;
}
TranslatableString CloudSyncStatusField::GetText() const
{
return {};
}
void CloudSyncStatusField::MarkDirty()
{
auto field = dynamic_cast<CloudSyncStatusBarFieldItem*>(
ProjectStatusFieldsRegistry::Get(FieldId));
if (field)
field->MarkDirty(mProject);
auto& statusWidget = GetStatusWidget();
statusWidget.Show(mState != State::Hidden);
statusWidget.UpdateName();
if (statusWidget.GetParent())
statusWidget.GetParent()->Refresh();
else
statusWidget.Refresh();
}
void CloudSyncStatusField::OnCloudStatusChanged(
const CloudStatusChangedMessage& message)
{
mState = [](ProjectSyncStatus status)
{
switch (status)
{
case ProjectSyncStatus::Local:
return State::Hidden;
case ProjectSyncStatus::Unsynced:
return State::Dirty;
case ProjectSyncStatus::Synced:
return State::Synced;
case ProjectSyncStatus::Failed:
return State::Failed;
case ProjectSyncStatus::Syncing:
return State::Uploading;
default:
return State::Hidden;
}
}(message.Status);
if (mState == State::Uploading)
mProgress = static_cast<int>(message.Progress * 100.0);
MarkDirty();
}
CloudSyncStatusField::StatusWidget& CloudSyncStatusField::GetStatusWidget()
{
if (!mStatusWidget)
{
mStatusWidget = safenew StatusWidget(
*this, ProjectWindow::Get(mProject).GetStatusBar());
mStatusWidget->Show(mCloudExtension.IsCloudProject());
}
return *mStatusWidget;
}
const CloudSyncStatusField::StatusWidget&
CloudSyncStatusField::GetStatusWidget() const
{
return const_cast<CloudSyncStatusField*>(this)->GetStatusWidget();
}
} // namespace audacity::cloud::audiocom::sync
|