1/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.launcher3;
18
19import android.content.pm.PackageManager;
20import android.content.res.Resources;
21import android.util.DisplayMetrics;
22import android.util.Log;
23import android.util.Pair;
24
25import java.io.File;
26
27/**
28 * Utilities to discover and interact with partner customizations. There can
29 * only be one set of customizations on a device, and it must be bundled with
30 * the system.
31 */
32public class Partner {
33
34    static final String TAG = "Launcher.Partner";
35
36    /** Marker action used to discover partner */
37    private static final String
38            ACTION_PARTNER_CUSTOMIZATION = "com.android.launcher3.action.PARTNER_CUSTOMIZATION";
39
40    public static final String RES_FOLDER = "partner_folder";
41    public static final String RES_WALLPAPERS = "partner_wallpapers";
42    public static final String RES_DEFAULT_LAYOUT = "partner_default_layout";
43
44    public static final String RES_DEFAULT_WALLPAPER_HIDDEN = "default_wallpapper_hidden";
45    public static final String RES_SYSTEM_WALLPAPER_DIR = "system_wallpaper_directory";
46
47    public static final String RES_REQUIRE_FIRST_RUN_FLOW = "requires_first_run_flow";
48
49    /** These resources are used to override the device profile  */
50    public static final String RES_GRID_AA_SHORT_EDGE_COUNT = "grid_aa_short_edge_count";
51    public static final String RES_GRID_AA_LONG_EDGE_COUNT = "grid_aa_long_edge_count";
52    public static final String RES_GRID_NUM_ROWS = "grid_num_rows";
53    public static final String RES_GRID_NUM_COLUMNS = "grid_num_columns";
54    public static final String RES_GRID_ICON_SIZE_DP = "grid_icon_size_dp";
55
56    private static boolean sSearched = false;
57    private static Partner sPartner;
58
59    /**
60     * Find and return partner details, or {@code null} if none exists.
61     */
62    public static synchronized Partner get(PackageManager pm) {
63        if (!sSearched) {
64            Pair<String, Resources> apkInfo = Utilities.findSystemApk(ACTION_PARTNER_CUSTOMIZATION, pm);
65            if (apkInfo != null) {
66                sPartner = new Partner(apkInfo.first, apkInfo.second);
67            }
68            sSearched = true;
69        }
70        return sPartner;
71    }
72
73    private final String mPackageName;
74    private final Resources mResources;
75
76    private Partner(String packageName, Resources res) {
77        mPackageName = packageName;
78        mResources = res;
79    }
80
81    public String getPackageName() {
82        return mPackageName;
83    }
84
85    public Resources getResources() {
86        return mResources;
87    }
88
89    public boolean hasDefaultLayout() {
90        int defaultLayout = getResources().getIdentifier(Partner.RES_DEFAULT_LAYOUT,
91                "xml", getPackageName());
92        return defaultLayout != 0;
93    }
94
95    public boolean hasFolder() {
96        int folder = getResources().getIdentifier(Partner.RES_FOLDER,
97                "xml", getPackageName());
98        return folder != 0;
99    }
100
101    public boolean hideDefaultWallpaper() {
102        int resId = getResources().getIdentifier(RES_DEFAULT_WALLPAPER_HIDDEN, "bool",
103                getPackageName());
104        return resId != 0 && getResources().getBoolean(resId);
105    }
106
107    public File getWallpaperDirectory() {
108        int resId = getResources().getIdentifier(RES_SYSTEM_WALLPAPER_DIR, "string",
109                getPackageName());
110        return (resId != 0) ? new File(getResources().getString(resId)) : null;
111    }
112
113    public boolean requiresFirstRunFlow() {
114        int resId = getResources().getIdentifier(RES_REQUIRE_FIRST_RUN_FLOW, "bool",
115                getPackageName());
116        return resId != 0 && getResources().getBoolean(resId);
117    }
118
119    public DeviceProfile getDeviceProfileOverride(DisplayMetrics dm) {
120        boolean containsProfileOverrides = false;
121
122        DeviceProfile dp = new DeviceProfile();
123
124        // We initialize customizable fields to be invalid
125        dp.numRows = -1;
126        dp.numColumns = -1;
127        dp.allAppsShortEdgeCount = -1;
128        dp.allAppsLongEdgeCount = -1;
129
130        try {
131            int resId = getResources().getIdentifier(RES_GRID_NUM_ROWS,
132                    "integer", getPackageName());
133            if (resId > 0) {
134                containsProfileOverrides = true;
135                dp.numRows = getResources().getInteger(resId);
136            }
137
138            resId = getResources().getIdentifier(RES_GRID_NUM_COLUMNS,
139                    "integer", getPackageName());
140            if (resId > 0) {
141                containsProfileOverrides = true;
142                dp.numColumns = getResources().getInteger(resId);
143            }
144
145            resId = getResources().getIdentifier(RES_GRID_AA_SHORT_EDGE_COUNT,
146                    "integer", getPackageName());
147            if (resId > 0) {
148                containsProfileOverrides = true;
149                dp.allAppsShortEdgeCount = getResources().getInteger(resId);
150            }
151
152            resId = getResources().getIdentifier(RES_GRID_AA_LONG_EDGE_COUNT,
153                    "integer", getPackageName());
154            if (resId > 0) {
155                containsProfileOverrides = true;
156                dp.allAppsLongEdgeCount = getResources().getInteger(resId);
157            }
158
159            resId = getResources().getIdentifier(RES_GRID_ICON_SIZE_DP,
160                    "dimen", getPackageName());
161            if (resId > 0) {
162                containsProfileOverrides = true;
163                int px = getResources().getDimensionPixelSize(resId);
164                dp.iconSize = DynamicGrid.dpiFromPx(px, dm);
165            }
166        } catch (Resources.NotFoundException ex) {
167            Log.e(TAG, "Invalid Partner grid resource!", ex);
168        }
169        return containsProfileOverrides ? dp : null;
170    }
171}
172