forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wallpaper_controller_impl.cc
2703 lines (2382 loc) · 101 KB
/
wallpaper_controller_impl.cc
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ash/wallpaper/wallpaper_controller_impl.h"
#include <memory>
#include <numeric>
#include <string>
#include <utility>
#include "ash/constants/ash_features.h"
#include "ash/constants/ash_pref_names.h"
#include "ash/constants/ash_switches.h"
#include "ash/display/window_tree_host_manager.h"
#include "ash/login/ui/login_constants.h"
#include "ash/public/cpp/image_downloader.h"
#include "ash/public/cpp/shell_window_ids.h"
#include "ash/public/cpp/wallpaper/online_wallpaper_params.h"
#include "ash/public/cpp/wallpaper/wallpaper_controller.h"
#include "ash/public/cpp/wallpaper/wallpaper_controller_client.h"
#include "ash/public/cpp/wallpaper/wallpaper_controller_observer.h"
#include "ash/public/cpp/wallpaper/wallpaper_info.h"
#include "ash/public/cpp/wallpaper/wallpaper_types.h"
#include "ash/root_window_controller.h"
#include "ash/session/session_controller_impl.h"
#include "ash/shell.h"
#include "ash/shell_delegate.h"
#include "ash/wallpaper/wallpaper_utils/wallpaper_color_calculator.h"
#include "ash/wallpaper/wallpaper_utils/wallpaper_decoder.h"
#include "ash/wallpaper/wallpaper_utils/wallpaper_resizer.h"
#include "ash/wallpaper/wallpaper_view.h"
#include "ash/wallpaper/wallpaper_widget_controller.h"
#include "ash/wallpaper/wallpaper_window_state_manager.h"
#include "ash/wm/overview/overview_constants.h"
#include "ash/wm/overview/overview_controller.h"
#include "ash/wm/tablet_mode/tablet_mode_controller.h"
#include "base/bind.h"
#include "base/callback_helpers.h"
#include "base/command_line.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/memory/ref_counted_memory.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/metrics_hashes.h"
#include "base/no_destructor.h"
#include "base/numerics/safe_conversions.h"
#include "base/path_service.h"
#include "base/rand_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/task/post_task.h"
#include "base/task/sequenced_task_runner_forward.h"
#include "base/task/task_runner_util_forward.h"
#include "base/task/thread_pool.h"
#include "base/values.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"
#include "components/prefs/scoped_user_pref_update.h"
#include "components/user_manager/user_manager.h"
#include "components/user_manager/user_type.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/data_decoder/public/cpp/decode_image.h"
#include "third_party/icu/source/i18n/unicode/gregocal.h"
#include "ui/compositor/layer.h"
#include "ui/display/manager/display_manager.h"
#include "ui/display/manager/managed_display_info.h"
#include "ui/display/screen.h"
#include "ui/gfx/codec/jpeg_codec.h"
#include "ui/gfx/color_analysis.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_operations.h"
#include "ui/views/widget/widget.h"
#include "url/gurl.h"
using color_utils::ColorProfile;
using color_utils::LumaRange;
using color_utils::SaturationRange;
using FilePathCallback = base::OnceCallback<void(const base::FilePath&)>;
namespace ash {
namespace {
// The file name of the policy wallpaper.
constexpr char kPolicyWallpaperFile[] = "policy-controlled.jpeg";
// File path suffix of resized small wallpapers.
constexpr char kSmallWallpaperSuffix[] = "_small";
// How long to wait reloading the wallpaper after the display size has changed.
constexpr base::TimeDelta kWallpaperReloadDelay = base::Milliseconds(100);
// How long to wait for resizing of the the wallpaper.
constexpr base::TimeDelta kCompositorLockTimeout = base::Milliseconds(750);
// Duration of the lock animation performed when pressing a lock button.
constexpr base::TimeDelta kLockAnimationBlurAnimationDuration =
base::Milliseconds(100);
// Duration of the cross fade animation when loading wallpaper.
constexpr base::TimeDelta kWallpaperLoadAnimationDuration =
base::Milliseconds(250);
// Default quality for encoding wallpaper.
constexpr int kDefaultEncodingQuality = 90;
// The color of the wallpaper if no other wallpaper images are available.
constexpr SkColor kDefaultWallpaperColor = SK_ColorGRAY;
// The paths of wallpaper directories.
base::FilePath& GlobalUserDataDir() {
static base::NoDestructor<base::FilePath> dir_user_data;
return *dir_user_data;
}
base::FilePath& GlobalChromeOSWallpapersDir() {
static base::NoDestructor<base::FilePath> dir_chrome_os_wallpapers;
return *dir_chrome_os_wallpapers;
}
base::FilePath& GlobalChromeOSCustomWallpapersDir() {
static base::NoDestructor<base::FilePath> dir_chrome_os_custom_wallpapers;
return *dir_chrome_os_custom_wallpapers;
}
void SetGlobalUserDataDir(const base::FilePath& path) {
base::FilePath& global_path = GlobalUserDataDir();
global_path = path;
}
void SetGlobalChromeOSWallpapersDir(const base::FilePath& path) {
base::FilePath& global_path = GlobalChromeOSWallpapersDir();
global_path = path;
}
void SetGlobalChromeOSCustomWallpapersDir(const base::FilePath& path) {
base::FilePath& global_path = GlobalChromeOSCustomWallpapersDir();
global_path = path;
}
// Returns the appropriate wallpaper resolution for all root windows.
WallpaperControllerImpl::WallpaperResolution GetAppropriateResolution() {
gfx::Size size = WallpaperControllerImpl::GetMaxDisplaySizeInNative();
return (size.width() > kSmallWallpaperMaxWidth ||
size.height() > kSmallWallpaperMaxHeight)
? WallpaperControllerImpl::WALLPAPER_RESOLUTION_LARGE
: WallpaperControllerImpl::WALLPAPER_RESOLUTION_SMALL;
}
// Returns the path of the online wallpaper corresponding to |url| and
// |resolution|.
base::FilePath GetOnlineWallpaperPath(
const std::string& url,
WallpaperControllerImpl::WallpaperResolution resolution) {
std::string file_name = GURL(url).ExtractFileName();
if (resolution == WallpaperControllerImpl::WALLPAPER_RESOLUTION_SMALL) {
file_name = base::FilePath(file_name)
.InsertBeforeExtension(kSmallWallpaperSuffix)
.value();
}
DCHECK(!GlobalChromeOSWallpapersDir().empty());
return GlobalChromeOSWallpapersDir().Append(file_name);
}
// Returns wallpaper subdirectory name for current resolution.
std::string GetCustomWallpaperSubdirForCurrentResolution() {
WallpaperControllerImpl::WallpaperResolution resolution =
GetAppropriateResolution();
return resolution == WallpaperControllerImpl::WALLPAPER_RESOLUTION_SMALL
? WallpaperControllerImpl::kSmallWallpaperSubDir
: WallpaperControllerImpl::kLargeWallpaperSubDir;
}
// Resizes |image| to a resolution which is nearest to |preferred_width| and
// |preferred_height| while respecting the |layout| choice. Encodes the image to
// JPEG and saves to |output|. Returns true on success.
bool ResizeAndEncodeImage(const gfx::ImageSkia& image,
WallpaperLayout layout,
int preferred_width,
int preferred_height,
scoped_refptr<base::RefCountedBytes>* output) {
int width = image.width();
int height = image.height();
int resized_width;
int resized_height;
*output = base::MakeRefCounted<base::RefCountedBytes>();
if (layout == WALLPAPER_LAYOUT_CENTER_CROPPED) {
// Do not resize wallpaper if it is smaller than preferred size.
if (width < preferred_width || height < preferred_height)
return false;
double horizontal_ratio = static_cast<double>(preferred_width) / width;
double vertical_ratio = static_cast<double>(preferred_height) / height;
if (vertical_ratio > horizontal_ratio) {
resized_width =
base::ClampRound(static_cast<double>(width) * vertical_ratio);
resized_height = preferred_height;
} else {
resized_width = preferred_width;
resized_height =
base::ClampRound(static_cast<double>(height) * horizontal_ratio);
}
} else if (layout == WALLPAPER_LAYOUT_STRETCH) {
resized_width = preferred_width;
resized_height = preferred_height;
} else {
resized_width = width;
resized_height = height;
}
gfx::ImageSkia resized_image = gfx::ImageSkiaOperations::CreateResizedImage(
image, skia::ImageOperations::RESIZE_LANCZOS3,
gfx::Size(resized_width, resized_height));
SkBitmap bitmap = *(resized_image.bitmap());
gfx::JPEGCodec::Encode(bitmap, kDefaultEncodingQuality, &(*output)->data());
return true;
}
// Resizes |image| to a resolution which is nearest to |preferred_width| and
// |preferred_height| while respecting the |layout| choice and saves the
// resized wallpaper to |path|. Returns true on success.
bool ResizeAndSaveWallpaper(const gfx::ImageSkia& image,
const base::FilePath& path,
WallpaperLayout layout,
int preferred_width,
int preferred_height) {
if (layout == WALLPAPER_LAYOUT_CENTER) {
if (base::PathExists(path))
base::DeleteFile(path);
return false;
}
scoped_refptr<base::RefCountedBytes> data;
if (!ResizeAndEncodeImage(image, layout, preferred_width, preferred_height,
&data)) {
return false;
}
// Saves |data| to |path| in local file system.
size_t written_bytes =
base::WriteFile(path, data->front_as<const char>(), data->size());
return written_bytes == data->size();
}
// Creates a 1x1 solid color image.
gfx::ImageSkia CreateSolidColorWallpaper(SkColor color) {
SkBitmap bitmap;
bitmap.allocN32Pixels(1, 1);
bitmap.eraseColor(color);
return gfx::ImageSkia::CreateFrom1xBitmap(bitmap);
}
// Gets the color profiles for extracting wallpaper prominent colors.
std::vector<ColorProfile> GetProminentColorProfiles() {
return {ColorProfile(LumaRange::DARK, SaturationRange::VIBRANT),
ColorProfile(LumaRange::NORMAL, SaturationRange::VIBRANT),
ColorProfile(LumaRange::LIGHT, SaturationRange::VIBRANT),
ColorProfile(LumaRange::DARK, SaturationRange::MUTED),
ColorProfile(LumaRange::NORMAL, SaturationRange::MUTED),
ColorProfile(LumaRange::LIGHT, SaturationRange::MUTED)};
}
// Gets the corresponding color profile type based on the given
// |color_profile|.
ColorProfileType GetColorProfileType(ColorProfile color_profile) {
bool vibrant = color_profile.saturation == SaturationRange::VIBRANT;
switch (color_profile.luma) {
case LumaRange::ANY:
// There should be no color profiles with the ANY luma range.
NOTREACHED();
break;
case LumaRange::DARK:
return vibrant ? ColorProfileType::DARK_VIBRANT
: ColorProfileType::DARK_MUTED;
case LumaRange::NORMAL:
return vibrant ? ColorProfileType::NORMAL_VIBRANT
: ColorProfileType::NORMAL_MUTED;
case LumaRange::LIGHT:
return vibrant ? ColorProfileType::LIGHT_VIBRANT
: ColorProfileType::LIGHT_MUTED;
}
NOTREACHED();
return ColorProfileType::DARK_MUTED;
}
// Deletes a list of wallpaper files in |file_list|.
void DeleteWallpaperInList(std::vector<base::FilePath> file_list) {
for (const base::FilePath& path : file_list) {
if (!base::DeletePathRecursively(path))
LOG(ERROR) << "Failed to remove user wallpaper at " << path.value();
}
}
// Creates all new custom wallpaper directories for |wallpaper_files_id| if they
// don't exist.
void EnsureCustomWallpaperDirectories(const std::string& wallpaper_files_id) {
base::FilePath dir = WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kSmallWallpaperSubDir)
.Append(wallpaper_files_id);
if (!base::PathExists(dir))
base::CreateDirectory(dir);
dir = WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kLargeWallpaperSubDir)
.Append(wallpaper_files_id);
if (!base::PathExists(dir))
base::CreateDirectory(dir);
dir = WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kOriginalWallpaperSubDir)
.Append(wallpaper_files_id);
if (!base::PathExists(dir))
base::CreateDirectory(dir);
}
// Saves original custom wallpaper to |path| (absolute path) on filesystem
// and starts resizing operation of the custom wallpaper if necessary.
base::FilePath SaveCustomWallpaper(const std::string& wallpaper_files_id,
const base::FilePath& original_path,
WallpaperLayout layout,
gfx::ImageSkia image) {
base::DeletePathRecursively(
WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kOriginalWallpaperSubDir)
.Append(wallpaper_files_id));
base::DeletePathRecursively(
WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kSmallWallpaperSubDir)
.Append(wallpaper_files_id));
base::DeletePathRecursively(
WallpaperControllerImpl::GetCustomWallpaperDir(
WallpaperControllerImpl::kLargeWallpaperSubDir)
.Append(wallpaper_files_id));
EnsureCustomWallpaperDirectories(wallpaper_files_id);
const std::string file_name = original_path.BaseName().value();
const base::FilePath small_wallpaper_path =
WallpaperControllerImpl::GetCustomWallpaperPath(
WallpaperControllerImpl::kSmallWallpaperSubDir, wallpaper_files_id,
file_name);
const base::FilePath large_wallpaper_path =
WallpaperControllerImpl::GetCustomWallpaperPath(
WallpaperControllerImpl::kLargeWallpaperSubDir, wallpaper_files_id,
file_name);
// Re-encode orginal file to jpeg format and saves the result in case that
// resized wallpaper is not generated (i.e. chrome shutdown before resized
// wallpaper is saved).
bool original_size_saved =
ResizeAndSaveWallpaper(image, original_path, WALLPAPER_LAYOUT_STRETCH,
image.width(), image.height());
ResizeAndSaveWallpaper(image, small_wallpaper_path, layout,
kSmallWallpaperMaxWidth, kSmallWallpaperMaxHeight);
ResizeAndSaveWallpaper(image, large_wallpaper_path, layout,
kLargeWallpaperMaxWidth, kLargeWallpaperMaxHeight);
return original_size_saved ? original_path : base::FilePath();
}
// Checks if kiosk app is running. Note: it returns false either when there's
// no active user (e.g. at login screen), or the active user is not kiosk.
bool IsInKioskMode() {
absl::optional<user_manager::UserType> active_user_type =
Shell::Get()->session_controller()->GetUserType();
// |active_user_type| is empty when there's no active user.
return active_user_type &&
*active_user_type == user_manager::USER_TYPE_KIOSK_APP;
}
// Returns the currently active user session (at index 0).
const UserSession* GetActiveUserSession() {
return Shell::Get()->session_controller()->GetUserSession(/*user index=*/0);
}
AccountId GetActiveAccountId() {
const UserSession* const session = GetActiveUserSession();
DCHECK(session);
return session->user_info.account_id;
}
// Checks if |account_id| is the current active user.
bool IsActiveUser(const AccountId& account_id) {
const UserSession* const session = GetActiveUserSession();
return session && session->user_info.account_id == account_id;
}
// Returns the file path of the wallpaper corresponding to |url| if it exists in
// local file system, otherwise returns an empty file path.
base::FilePath GetExistingOnlineWallpaperPath(const std::string& url) {
WallpaperControllerImpl::WallpaperResolution resolution =
GetAppropriateResolution();
base::FilePath wallpaper_path = GetOnlineWallpaperPath(url, resolution);
if (base::PathExists(wallpaper_path))
return wallpaper_path;
// Falls back to the large wallpaper if the small one doesn't exist.
if (resolution == WallpaperControllerImpl::WALLPAPER_RESOLUTION_SMALL) {
wallpaper_path = GetOnlineWallpaperPath(
url, WallpaperControllerImpl::WALLPAPER_RESOLUTION_LARGE);
if (base::PathExists(wallpaper_path))
return wallpaper_path;
}
return base::FilePath();
}
// Saves the online wallpaper with both large and small sizes to local file
// system.
void SaveOnlineWallpaper(const std::string& url,
WallpaperLayout layout,
gfx::ImageSkia image) {
DCHECK(!GlobalChromeOSWallpapersDir().empty());
if (!base::DirectoryExists(GlobalChromeOSWallpapersDir()) &&
!base::CreateDirectory(GlobalChromeOSWallpapersDir())) {
return;
}
ResizeAndSaveWallpaper(
image,
GetOnlineWallpaperPath(
url, WallpaperControllerImpl::WALLPAPER_RESOLUTION_LARGE),
layout, image.width(), image.height());
ResizeAndSaveWallpaper(
image,
GetOnlineWallpaperPath(
url, WallpaperControllerImpl::WALLPAPER_RESOLUTION_SMALL),
WALLPAPER_LAYOUT_CENTER_CROPPED, kSmallWallpaperMaxWidth,
kSmallWallpaperMaxHeight);
}
// Implementation of |WallpaperControllerImpl::GetOfflineWallpaper|.
std::vector<std::string> GetOfflineWallpaperListImpl() {
DCHECK(!GlobalChromeOSWallpapersDir().empty());
std::vector<std::string> url_list;
if (base::DirectoryExists(GlobalChromeOSWallpapersDir())) {
base::FileEnumerator files(GlobalChromeOSWallpapersDir(),
/*recursive=*/false,
base::FileEnumerator::FILES);
for (base::FilePath current = files.Next(); !current.empty();
current = files.Next()) {
// Do not add file name of small resolution wallpaper to the list.
if (!base::EndsWith(current.BaseName().RemoveExtension().value(),
kSmallWallpaperSuffix,
base::CompareCase::SENSITIVE)) {
url_list.push_back(current.BaseName().value());
}
}
}
return url_list;
}
// Returns true if the user's wallpaper is to be treated as ephemeral.
bool IsEphemeralUser(const AccountId& id) {
if (user_manager::UserManager::IsInitialized()) {
return user_manager::UserManager::Get()->IsUserNonCryptohomeDataEphemeral(
id);
}
NOTIMPLEMENTED();
return false;
}
// Returns the type of the user with the specified |id| or USER_TYPE_REGULAR.
user_manager::UserType GetUserType(const AccountId& id) {
if (user_manager::UserManager::IsInitialized()) {
if (auto* user = user_manager::UserManager::Get()->FindUser(id))
return user->GetType();
}
NOTIMPLEMENTED();
return user_manager::USER_TYPE_REGULAR;
}
bool GetWallpaperInfo(const AccountId& account_id,
const PrefService* const pref_service,
const std::string& pref_name,
WallpaperInfo* info) {
if (!pref_service)
return false;
const base::Value* info_dict =
pref_service->GetDictionary(pref_name)->FindDictKey(
account_id.GetUserEmail());
if (!info_dict)
return false;
// Use temporary variables to keep |info| untouched in the error case.
const std::string* asset_id_str = info_dict->FindStringPath(
WallpaperControllerImpl::kNewWallpaperAssetIdNodeName);
const std::string* collection_id = info_dict->FindStringPath(
WallpaperControllerImpl::kNewWallpaperCollectionIdNodeName);
const std::string* location = info_dict->FindStringPath(
WallpaperControllerImpl::kNewWallpaperLocationNodeName);
absl::optional<int> layout = info_dict->FindIntPath(
WallpaperControllerImpl::kNewWallpaperLayoutNodeName);
absl::optional<int> type = info_dict->FindIntPath(
WallpaperControllerImpl::kNewWallpaperTypeNodeName);
const std::string* date_string = info_dict->FindStringPath(
WallpaperControllerImpl::kNewWallpaperDateNodeName);
if (!location || !layout || !type || !date_string)
return false;
int64_t date_val;
if (!base::StringToInt64(*date_string, &date_val))
return false;
info->location = *location;
info->layout = static_cast<WallpaperLayout>(layout.value());
info->type = static_cast<WallpaperType>(type.value());
info->date = base::Time::FromInternalValue(date_val);
info->collection_id = collection_id ? *collection_id : std::string();
if (asset_id_str) {
uint64_t asset_id;
if (base::StringToUint64(*asset_id_str, &asset_id))
info->asset_id = absl::make_optional(asset_id);
}
return true;
}
bool SetWallpaperInfo(const AccountId& account_id,
const WallpaperInfo& info,
PrefService* const pref_service,
const std::string& pref_name) {
if (!pref_service)
return false;
DictionaryPrefUpdate wallpaper_update(pref_service, pref_name);
base::Value wallpaper_info_dict(base::Value::Type::DICTIONARY);
if (info.asset_id.has_value()) {
wallpaper_info_dict.SetStringPath(
WallpaperControllerImpl::kNewWallpaperAssetIdNodeName,
base::NumberToString(info.asset_id.value()));
}
wallpaper_info_dict.SetStringPath(
WallpaperControllerImpl::kNewWallpaperCollectionIdNodeName,
info.collection_id);
wallpaper_info_dict.SetStringPath(
WallpaperControllerImpl::kNewWallpaperDateNodeName,
base::NumberToString(info.date.ToInternalValue()));
wallpaper_info_dict.SetStringPath(
WallpaperControllerImpl::kNewWallpaperLocationNodeName, info.location);
wallpaper_info_dict.SetIntPath(
WallpaperControllerImpl::kNewWallpaperLayoutNodeName, info.layout);
wallpaper_info_dict.SetIntPath(
WallpaperControllerImpl::kNewWallpaperTypeNodeName,
static_cast<int>(info.type));
wallpaper_update->SetKey(account_id.GetUserEmail(),
std::move(wallpaper_info_dict));
return true;
}
void RemoveWallpaperInfo(const AccountId& account_id,
PrefService* const pref_service,
const std::string& pref_name) {
if (!pref_service)
return;
DictionaryPrefUpdate prefs_wallpapers_info_update(pref_service, pref_name);
prefs_wallpapers_info_update->RemoveKey(account_id.GetUserEmail());
}
} // namespace
const char WallpaperControllerImpl::kSmallWallpaperSubDir[] = "small";
const char WallpaperControllerImpl::kLargeWallpaperSubDir[] = "large";
const char WallpaperControllerImpl::kOriginalWallpaperSubDir[] = "original";
const char WallpaperControllerImpl::kNewWallpaperAssetIdNodeName[] = "asset_id";
const char WallpaperControllerImpl::kNewWallpaperCollectionIdNodeName[] =
"collection_id";
const char WallpaperControllerImpl::kNewWallpaperDateNodeName[] = "date";
const char WallpaperControllerImpl::kNewWallpaperLayoutNodeName[] = "layout";
const char WallpaperControllerImpl::kNewWallpaperLocationNodeName[] = "file";
const char WallpaperControllerImpl::kNewWallpaperTypeNodeName[] = "type";
WallpaperControllerImpl::WallpaperControllerImpl(PrefService* local_state)
: color_profiles_(GetProminentColorProfiles()),
wallpaper_reload_delay_(kWallpaperReloadDelay),
sequenced_task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::USER_VISIBLE,
base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN})),
local_state_(local_state) {
DCHECK(!color_profiles_.empty());
prominent_colors_ =
std::vector<SkColor>(color_profiles_.size(), kInvalidWallpaperColor);
Shell::Get()->window_tree_host_manager()->AddObserver(this);
Shell::Get()->AddShellObserver(this);
theme_observation_.Observe(ui::NativeTheme::GetInstanceForNativeUi());
}
WallpaperControllerImpl::~WallpaperControllerImpl() {
if (current_wallpaper_)
current_wallpaper_->RemoveObserver(this);
if (color_calculator_)
color_calculator_->RemoveObserver(this);
Shell::Get()->window_tree_host_manager()->RemoveObserver(this);
Shell::Get()->RemoveShellObserver(this);
}
// static
void WallpaperControllerImpl::RegisterLocalStatePrefs(
PrefRegistrySimple* registry) {
registry->RegisterDictionaryPref(prefs::kUserWallpaperInfo);
registry->RegisterDictionaryPref(prefs::kWallpaperColors);
}
// static
void WallpaperControllerImpl::RegisterProfilePrefs(
PrefRegistrySimple* registry) {
using user_prefs::PrefRegistrySyncable;
registry->RegisterDictionaryPref(prefs::kSyncableWallpaperInfo,
PrefRegistrySyncable::SYNCABLE_OS_PREF);
}
// static
gfx::Size WallpaperControllerImpl::GetMaxDisplaySizeInNative() {
// Return an empty size for test environments where the screen is null.
if (!display::Screen::GetScreen())
return gfx::Size();
gfx::Size max;
for (const auto& display : display::Screen::GetScreen()->GetAllDisplays())
max.SetToMax(display.GetSizeInPixel());
return max;
}
// static
base::FilePath WallpaperControllerImpl::GetCustomWallpaperPath(
const std::string& sub_dir,
const std::string& wallpaper_files_id,
const std::string& file_name) {
base::FilePath custom_wallpaper_path = GetCustomWallpaperDir(sub_dir);
return custom_wallpaper_path.Append(wallpaper_files_id).Append(file_name);
}
// static
base::FilePath WallpaperControllerImpl::GetCustomWallpaperDir(
const std::string& sub_dir) {
DCHECK(!GlobalChromeOSCustomWallpapersDir().empty());
return GlobalChromeOSCustomWallpapersDir().Append(sub_dir);
}
// static
void WallpaperControllerImpl::SetWallpaperFromPath(
const AccountId& account_id,
const WallpaperInfo& info,
const base::FilePath& wallpaper_path,
bool show_wallpaper,
const scoped_refptr<base::SingleThreadTaskRunner>& reply_task_runner,
base::WeakPtr<WallpaperControllerImpl> weak_ptr) {
base::FilePath valid_path = wallpaper_path;
if (!base::PathExists(valid_path)) {
// Falls back to the original file if the file with correct resolution does
// not exist. This may happen when the original custom wallpaper is small or
// browser shutdown before resized wallpaper saved.
valid_path =
GetCustomWallpaperDir(kOriginalWallpaperSubDir).Append(info.location);
}
if (!base::PathExists(valid_path)) {
LOG(ERROR) << "The path " << valid_path.value()
<< " doesn't exist. Falls back to default wallpaper.";
reply_task_runner->PostTask(
FROM_HERE,
base::BindOnce(&WallpaperControllerImpl::SetDefaultWallpaperImpl,
weak_ptr, account_id, show_wallpaper));
} else {
reply_task_runner->PostTask(
FROM_HERE,
base::BindOnce(&WallpaperControllerImpl::StartDecodeFromPath, weak_ptr,
account_id, valid_path, info, show_wallpaper));
}
}
SkColor WallpaperControllerImpl::GetProminentColor(
ColorProfile color_profile) const {
ColorProfileType type = GetColorProfileType(color_profile);
return prominent_colors_[static_cast<int>(type)];
}
gfx::ImageSkia WallpaperControllerImpl::GetWallpaper() const {
return current_wallpaper_ ? current_wallpaper_->image() : gfx::ImageSkia();
}
WallpaperLayout WallpaperControllerImpl::GetWallpaperLayout() const {
return current_wallpaper_ ? current_wallpaper_->wallpaper_info().layout
: NUM_WALLPAPER_LAYOUT;
}
WallpaperType WallpaperControllerImpl::GetWallpaperType() const {
return current_wallpaper_ ? current_wallpaper_->wallpaper_info().type
: WallpaperType::kCount;
}
bool WallpaperControllerImpl::ShouldShowInitialAnimation() {
// The slower initial animation is only applicable if:
// 1) It's the first run after system boot, not after user sign-out.
if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
chromeos::switches::kFirstExecAfterBoot)) {
return false;
}
// 2) It's at the login screen.
if (Shell::Get()->session_controller()->IsActiveUserSessionStarted() ||
!base::CommandLine::ForCurrentProcess()->HasSwitch(
chromeos::switches::kLoginManager)) {
return false;
}
// 3) It's the first wallpaper being shown, not for the switching between
// multiple user pods.
if (!is_first_wallpaper_)
return false;
return true;
}
bool WallpaperControllerImpl::CanOpenWallpaperPicker() {
return ShouldShowWallpaperSetting() &&
!IsActiveUserWallpaperControlledByPolicy();
}
bool WallpaperControllerImpl::HasShownAnyWallpaper() const {
return !!current_wallpaper_;
}
void WallpaperControllerImpl::MaybeClosePreviewWallpaper() {
if (!confirm_preview_wallpaper_callback_) {
DCHECK(!reload_preview_wallpaper_callback_);
return;
}
// May be null in tests.
if (wallpaper_controller_client_)
wallpaper_controller_client_->MaybeClosePreviewWallpaper();
CancelPreviewWallpaper();
}
void WallpaperControllerImpl::ShowWallpaperImage(const gfx::ImageSkia& image,
WallpaperInfo info,
bool preview_mode,
bool always_on_top) {
// Prevent showing other wallpapers if there is an always-on-top wallpaper.
if (is_always_on_top_wallpaper_ && !always_on_top)
return;
// Ignore show wallpaper requests during preview mode. This could happen if a
// custom wallpaper previously set on another device is being synced.
if (confirm_preview_wallpaper_callback_ && !preview_mode)
return;
if (preview_mode) {
DVLOG(1) << __func__ << " preview_mode=true";
base::UmaHistogramBoolean("Ash.Wallpaper.Preview.Show", true);
for (auto& observer : observers_)
observer.OnWallpaperPreviewStarted();
}
// 1x1 wallpaper should be stretched to fill the entire screen.
// (WALLPAPER_LAYOUT_TILE also serves this purpose.)
if (image.width() == 1 && image.height() == 1)
info.layout = WALLPAPER_LAYOUT_STRETCH;
if (info.type == WallpaperType::kOneShot)
info.one_shot_wallpaper = image.DeepCopy();
VLOG(1) << "SetWallpaper: image_id=" << WallpaperResizer::GetImageId(image)
<< " layout=" << info.layout;
if (WallpaperIsAlreadyLoaded(image, /*compare_layouts=*/true, info.layout)) {
VLOG(1) << "Wallpaper is already loaded";
return;
}
UMA_HISTOGRAM_ENUMERATION("Ash.Wallpaper.Type", info.type,
WallpaperType::kCount);
// Cancel any in-flight color calculation because we have a new wallpaper.
if (color_calculator_) {
color_calculator_->RemoveObserver(this);
color_calculator_.reset();
}
is_first_wallpaper_ = !current_wallpaper_;
current_wallpaper_ = std::make_unique<WallpaperResizer>(
image, GetMaxDisplaySizeInNative(), info, sequenced_task_runner_);
current_wallpaper_->AddObserver(this);
current_wallpaper_->StartResize();
if (is_first_wallpaper_) {
for (auto& observer : observers_)
observer.OnFirstWallpaperShown();
}
for (auto& observer : observers_)
observer.OnWallpaperChanging();
wallpaper_mode_ = WALLPAPER_IMAGE;
UpdateWallpaperForAllRootWindows(
Shell::Get()->session_controller()->IsUserSessionBlocked());
++wallpaper_count_for_testing_;
for (auto& observer : observers_)
observer.OnWallpaperChanged();
}
bool WallpaperControllerImpl::IsPolicyControlled(
const AccountId& account_id) const {
WallpaperInfo info;
return GetUserWallpaperInfo(account_id, &info) &&
info.type == WallpaperType::kPolicy;
}
void WallpaperControllerImpl::UpdateWallpaperBlurForLockState(bool blur) {
if (!IsBlurAllowedForLockState())
return;
bool changed = is_wallpaper_blurred_for_lock_state_ != blur;
// is_wallpaper_blurrred_for_lock_state_ may already be updated in
// InstallDesktopController. Always try to update, then invoke observer
// if something changed.
for (auto* root_window_controller : Shell::GetAllRootWindowControllers()) {
changed |=
root_window_controller->wallpaper_widget_controller()->SetWallpaperBlur(
blur ? wallpaper_constants::kLockLoginBlur
: wallpaper_constants::kClear,
kLockAnimationBlurAnimationDuration);
}
is_wallpaper_blurred_for_lock_state_ = blur;
if (changed) {
for (auto& observer : observers_)
observer.OnWallpaperBlurChanged();
}
}
void WallpaperControllerImpl::RestoreWallpaperBlurForLockState(float blur) {
if (!IsBlurAllowedForLockState())
return;
// |is_wallpaper_blurrred_for_lock_state_| may already be updated in
// InstallDesktopController. Always try to update, then invoke observer
// if something changed.
for (auto* root_window_controller : Shell::GetAllRootWindowControllers()) {
root_window_controller->wallpaper_widget_controller()->SetWallpaperBlur(
blur, kLockAnimationBlurAnimationDuration);
}
DCHECK(is_wallpaper_blurred_for_lock_state_);
is_wallpaper_blurred_for_lock_state_ = false;
for (auto& observer : observers_)
observer.OnWallpaperBlurChanged();
}
bool WallpaperControllerImpl::ShouldApplyShield() const {
// Apply a shield on the wallpaper in a blocked user session or overview or in
// tablet mode unless during wallpaper preview.
const bool needs_shield =
Shell::Get()->session_controller()->IsUserSessionBlocked() ||
Shell::Get()->overview_controller()->InOverviewSession() ||
(Shell::Get()->tablet_mode_controller()->InTabletMode() &&
!confirm_preview_wallpaper_callback_);
return needs_shield && !IsOneShotWallpaper();
}
bool WallpaperControllerImpl::IsBlurAllowedForLockState() const {
return !IsDevicePolicyWallpaper() && !IsOneShotWallpaper();
}
bool WallpaperControllerImpl::SetUserWallpaperInfo(const AccountId& account_id,
const WallpaperInfo& info) {
if (info.type != WallpaperType::kDaily)
daily_refresh_timer_.Stop();
if (IsEphemeralUser(account_id)) {
ephemeral_users_wallpaper_info_[account_id] = info;
return true;
}
WallpaperInfo old_info;
if (local_state_ && GetUserWallpaperInfo(account_id, &old_info)) {
// Remove the color cache of the previous wallpaper if it exists.
DictionaryPrefUpdate wallpaper_colors_update(local_state_,
prefs::kWallpaperColors);
wallpaper_colors_update->RemoveKey(old_info.location);
}
bool success = SetLocalWallpaperInfo(account_id, info);
// Although `WallpaperType::kCustomized` typed wallpapers are syncable, we
// don't set synced info until the image is stored in drivefs, so we know when
// to retry saving it on failure.
if (IsWallpaperTypeSyncable(info.type) &&
info.type != WallpaperType::kCustomized) {
SetSyncedWallpaperInfo(account_id, info);
}
return success;
}
bool WallpaperControllerImpl::GetUserWallpaperInfo(const AccountId& account_id,
WallpaperInfo* info) const {
if (IsEphemeralUser(account_id)) {
// Ephemeral users do not save anything to local state. Return true if the
// info can be found in the map, otherwise return false.
auto it = ephemeral_users_wallpaper_info_.find(account_id);
if (it == ephemeral_users_wallpaper_info_.end())
return false;
*info = it->second;
return true;
}
return GetLocalWallpaperInfo(account_id, info);
}
bool WallpaperControllerImpl::GetWallpaperFromCache(const AccountId& account_id,
gfx::ImageSkia* image) {
CustomWallpaperMap::const_iterator it = wallpaper_cache_map_.find(account_id);
if (it != wallpaper_cache_map_.end() && !it->second.second.isNull()) {
*image = it->second.second;
return true;
}
return false;
}
bool WallpaperControllerImpl::GetPathFromCache(const AccountId& account_id,
base::FilePath* path) {
CustomWallpaperMap::const_iterator it = wallpaper_cache_map_.find(account_id);
if (it != wallpaper_cache_map_.end()) {
*path = it->second.first;
return true;
}
return false;
}
void WallpaperControllerImpl::AddFirstWallpaperAnimationEndCallback(
base::OnceClosure callback,
aura::Window* window) {
WallpaperWidgetController* wallpaper_widget_controller =
RootWindowController::ForWindow(window)->wallpaper_widget_controller();
if (!current_wallpaper_ ||
(is_first_wallpaper_ && wallpaper_widget_controller->IsAnimating())) {
// No wallpaper has been set, or the first wallpaper is still animating.
wallpaper_widget_controller->AddAnimationEndCallback(std::move(callback));
} else {
std::move(callback).Run();
}
}
void WallpaperControllerImpl::StartDecodeFromPath(
const AccountId& account_id,
const base::FilePath& wallpaper_path,
const WallpaperInfo& info,
bool show_wallpaper) {
ReadAndDecodeWallpaper(
base::BindOnce(&WallpaperControllerImpl::OnWallpaperDecoded,
weak_factory_.GetWeakPtr(), account_id, wallpaper_path,
info, show_wallpaper),
sequenced_task_runner_, wallpaper_path);
}
void WallpaperControllerImpl::SetClient(WallpaperControllerClient* client) {
wallpaper_controller_client_ = client;
}
void WallpaperControllerImpl::Init(
const base::FilePath& user_data_path,
const base::FilePath& chromeos_wallpapers_path,
const base::FilePath& chromeos_custom_wallpapers_path,
const base::FilePath& device_policy_wallpaper_path) {
SetGlobalUserDataDir(user_data_path);
SetGlobalChromeOSWallpapersDir(chromeos_wallpapers_path);
SetGlobalChromeOSCustomWallpapersDir(chromeos_custom_wallpapers_path);
SetDevicePolicyWallpaperPath(device_policy_wallpaper_path);
}
void WallpaperControllerImpl::SetCustomWallpaper(
const AccountId& account_id,
const base::FilePath& file_path,
WallpaperLayout layout,
bool preview_mode,
SetCustomWallpaperCallback callback) {
// Invalidate weak ptrs to cancel prior requests to set wallpaper.
set_wallpaper_weak_factory_.InvalidateWeakPtrs();
ReadAndDecodeWallpaper(
base::BindOnce(&WallpaperControllerImpl::OnCustomWallpaperDecoded,
set_wallpaper_weak_factory_.GetWeakPtr(), account_id,
file_path, layout, preview_mode, std::move(callback)),
sequenced_task_runner_, file_path);
}
void WallpaperControllerImpl::SetCustomWallpaper(
const AccountId& account_id,
const std::string& file_name,
WallpaperLayout layout,
const gfx::ImageSkia& image,
bool preview_mode) {
DCHECK(Shell::Get()->session_controller()->IsActiveUserSessionStarted());
if (!CanSetUserWallpaper(account_id))
return;