WallpaperManagerService.java revision 61f57379ca2c5b6290c8da7548fa17128f7ab24f
1/*
2 * Copyright (C) 2008 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.server;
18
19import static android.os.FileObserver.*;
20import static android.os.ParcelFileDescriptor.*;
21
22import android.app.AppGlobals;
23import android.app.IWallpaperManager;
24import android.app.IWallpaperManagerCallback;
25import android.app.PendingIntent;
26import android.app.WallpaperInfo;
27import android.app.backup.BackupManager;
28import android.app.backup.WallpaperBackupHelper;
29import android.content.BroadcastReceiver;
30import android.content.ComponentName;
31import android.content.Context;
32import android.content.Intent;
33import android.content.IntentFilter;
34import android.content.ServiceConnection;
35import android.content.pm.IPackageManager;
36import android.content.pm.PackageManager;
37import android.content.pm.ResolveInfo;
38import android.content.pm.ServiceInfo;
39import android.content.pm.PackageManager.NameNotFoundException;
40import android.content.res.Resources;
41import android.os.Binder;
42import android.os.Bundle;
43import android.os.Environment;
44import android.os.FileUtils;
45import android.os.IBinder;
46import android.os.RemoteException;
47import android.os.FileObserver;
48import android.os.ParcelFileDescriptor;
49import android.os.RemoteCallbackList;
50import android.os.SELinux;
51import android.os.ServiceManager;
52import android.os.SystemClock;
53import android.os.UserHandle;
54import android.service.wallpaper.IWallpaperConnection;
55import android.service.wallpaper.IWallpaperEngine;
56import android.service.wallpaper.IWallpaperService;
57import android.service.wallpaper.WallpaperService;
58import android.util.Slog;
59import android.util.SparseArray;
60import android.util.Xml;
61import android.view.Display;
62import android.view.IWindowManager;
63import android.view.WindowManager;
64
65import java.io.FileDescriptor;
66import java.io.IOException;
67import java.io.InputStream;
68import java.io.File;
69import java.io.FileNotFoundException;
70import java.io.FileInputStream;
71import java.io.FileOutputStream;
72import java.io.PrintWriter;
73import java.util.List;
74
75import org.xmlpull.v1.XmlPullParser;
76import org.xmlpull.v1.XmlPullParserException;
77import org.xmlpull.v1.XmlSerializer;
78
79import com.android.internal.content.PackageMonitor;
80import com.android.internal.util.FastXmlSerializer;
81import com.android.internal.util.JournaledFile;
82import com.android.server.am.ActivityManagerService;
83
84class WallpaperManagerService extends IWallpaperManager.Stub {
85    static final String TAG = "WallpaperService";
86    static final boolean DEBUG = false;
87
88    final Object mLock = new Object[0];
89
90    /**
91     * Minimum time between crashes of a wallpaper service for us to consider
92     * restarting it vs. just reverting to the static wallpaper.
93     */
94    static final long MIN_WALLPAPER_CRASH_TIME = 10000;
95    static final String WALLPAPER = "wallpaper";
96    static final String WALLPAPER_INFO = "wallpaper_info.xml";
97
98    /**
99     * Observes the wallpaper for changes and notifies all IWallpaperServiceCallbacks
100     * that the wallpaper has changed. The CREATE is triggered when there is no
101     * wallpaper set and is created for the first time. The CLOSE_WRITE is triggered
102     * everytime the wallpaper is changed.
103     */
104    private class WallpaperObserver extends FileObserver {
105
106        final WallpaperData mWallpaper;
107        final File mWallpaperDir;
108        final File mWallpaperFile;
109
110        public WallpaperObserver(WallpaperData wallpaper) {
111            super(getWallpaperDir(wallpaper.userId).getAbsolutePath(),
112                    CLOSE_WRITE | DELETE | DELETE_SELF);
113            mWallpaperDir = getWallpaperDir(wallpaper.userId);
114            mWallpaper = wallpaper;
115            mWallpaperFile = new File(mWallpaperDir, WALLPAPER);
116        }
117
118        @Override
119        public void onEvent(int event, String path) {
120            if (path == null) {
121                return;
122            }
123            synchronized (mLock) {
124                // changing the wallpaper means we'll need to back up the new one
125                long origId = Binder.clearCallingIdentity();
126                BackupManager bm = new BackupManager(mContext);
127                bm.dataChanged();
128                Binder.restoreCallingIdentity(origId);
129
130                File changedFile = new File(mWallpaperDir, path);
131                if (mWallpaperFile.equals(changedFile)) {
132                    notifyCallbacksLocked(mWallpaper);
133                    if (mWallpaper.wallpaperComponent == null || event != CLOSE_WRITE
134                            || mWallpaper.imageWallpaperPending) {
135                        if (event == CLOSE_WRITE) {
136                            mWallpaper.imageWallpaperPending = false;
137                        }
138                        bindWallpaperComponentLocked(mWallpaper.imageWallpaperComponent, true,
139                                false, mWallpaper);
140                        saveSettingsLocked(mWallpaper);
141                    }
142                }
143            }
144        }
145    }
146
147    final Context mContext;
148    final IWindowManager mIWindowManager;
149    final IPackageManager mIPackageManager;
150    final MyPackageMonitor mMonitor;
151    WallpaperData mLastWallpaper;
152
153    SparseArray<WallpaperData> mWallpaperMap = new SparseArray<WallpaperData>();
154
155    int mCurrentUserId;
156
157    static class WallpaperData {
158
159        int userId;
160
161        File wallpaperFile;
162
163        /**
164         * Client is currently writing a new image wallpaper.
165         */
166        boolean imageWallpaperPending;
167
168        /**
169         * Resource name if using a picture from the wallpaper gallery
170         */
171        String name = "";
172
173        /**
174         * The component name of the currently set live wallpaper.
175         */
176        ComponentName wallpaperComponent;
177
178        /**
179         * The component name of the wallpaper that should be set next.
180         */
181        ComponentName nextWallpaperComponent;
182
183        /**
184         * Name of the component used to display bitmap wallpapers from either the gallery or
185         * built-in wallpapers.
186         */
187        ComponentName imageWallpaperComponent = new ComponentName("com.android.systemui",
188                "com.android.systemui.ImageWallpaper");
189
190        WallpaperConnection connection;
191        long lastDiedTime;
192        boolean wallpaperUpdating;
193        WallpaperObserver wallpaperObserver;
194
195        /**
196         * List of callbacks registered they should each be notified when the wallpaper is changed.
197         */
198        private RemoteCallbackList<IWallpaperManagerCallback> callbacks
199                = new RemoteCallbackList<IWallpaperManagerCallback>();
200
201        int width = -1;
202        int height = -1;
203
204        WallpaperData(int userId) {
205            this.userId = userId;
206            wallpaperFile = new File(getWallpaperDir(userId), WALLPAPER);
207        }
208    }
209
210    class WallpaperConnection extends IWallpaperConnection.Stub
211            implements ServiceConnection {
212        final WallpaperInfo mInfo;
213        final Binder mToken = new Binder();
214        IWallpaperService mService;
215        IWallpaperEngine mEngine;
216        WallpaperData mWallpaper;
217
218        public WallpaperConnection(WallpaperInfo info, WallpaperData wallpaper) {
219            mInfo = info;
220            mWallpaper = wallpaper;
221        }
222
223        public void onServiceConnected(ComponentName name, IBinder service) {
224            synchronized (mLock) {
225                if (mWallpaper.connection == this) {
226                    mWallpaper.lastDiedTime = SystemClock.uptimeMillis();
227                    mService = IWallpaperService.Stub.asInterface(service);
228                    attachServiceLocked(this, mWallpaper);
229                    // XXX should probably do saveSettingsLocked() later
230                    // when we have an engine, but I'm not sure about
231                    // locking there and anyway we always need to be able to
232                    // recover if there is something wrong.
233                    saveSettingsLocked(mWallpaper);
234                }
235            }
236        }
237
238        public void onServiceDisconnected(ComponentName name) {
239            synchronized (mLock) {
240                mService = null;
241                mEngine = null;
242                if (mWallpaper.connection == this) {
243                    Slog.w(TAG, "Wallpaper service gone: " + mWallpaper.wallpaperComponent);
244                    if (!mWallpaper.wallpaperUpdating
245                            && (mWallpaper.lastDiedTime + MIN_WALLPAPER_CRASH_TIME)
246                                > SystemClock.uptimeMillis()
247                            && mWallpaper.userId == mCurrentUserId) {
248                        Slog.w(TAG, "Reverting to built-in wallpaper!");
249                        clearWallpaperLocked(true, mWallpaper.userId);
250                    }
251                }
252            }
253        }
254
255        public void attachEngine(IWallpaperEngine engine) {
256            mEngine = engine;
257        }
258
259        public ParcelFileDescriptor setWallpaper(String name) {
260            synchronized (mLock) {
261                if (mWallpaper.connection == this) {
262                    return updateWallpaperBitmapLocked(name, mWallpaper);
263                }
264                return null;
265            }
266        }
267    }
268
269    class MyPackageMonitor extends PackageMonitor {
270        @Override
271        public void onPackageUpdateFinished(String packageName, int uid) {
272            synchronized (mLock) {
273                for (int i = 0; i < mWallpaperMap.size(); i++) {
274                    WallpaperData wallpaper = mWallpaperMap.valueAt(i);
275                    if (wallpaper.wallpaperComponent != null
276                            && wallpaper.wallpaperComponent.getPackageName().equals(packageName)) {
277                        wallpaper.wallpaperUpdating = false;
278                        ComponentName comp = wallpaper.wallpaperComponent;
279                        clearWallpaperComponentLocked(wallpaper);
280                        // Do this only for the current user's wallpaper
281                        if (wallpaper.userId == mCurrentUserId
282                                && !bindWallpaperComponentLocked(comp, false, false, wallpaper)) {
283                            Slog.w(TAG, "Wallpaper no longer available; reverting to default");
284                            clearWallpaperLocked(false, wallpaper.userId);
285                        }
286                    }
287                }
288            }
289        }
290
291        @Override
292        public void onPackageModified(String packageName) {
293            synchronized (mLock) {
294                for (int i = 0; i < mWallpaperMap.size(); i++) {
295                    WallpaperData wallpaper = mWallpaperMap.valueAt(i);
296                    if (wallpaper.wallpaperComponent == null
297                            || !wallpaper.wallpaperComponent.getPackageName().equals(packageName)) {
298                        continue;
299                    }
300                    doPackagesChangedLocked(true, wallpaper);
301                }
302            }
303        }
304
305        @Override
306        public void onPackageUpdateStarted(String packageName, int uid) {
307            synchronized (mLock) {
308                for (int i = 0; i < mWallpaperMap.size(); i++) {
309                    WallpaperData wallpaper = mWallpaperMap.valueAt(i);
310                    if (wallpaper.wallpaperComponent != null
311                            && wallpaper.wallpaperComponent.getPackageName().equals(packageName)) {
312                        wallpaper.wallpaperUpdating = true;
313                    }
314                }
315            }
316        }
317
318        @Override
319        public boolean onHandleForceStop(Intent intent, String[] packages, int uid, boolean doit) {
320            synchronized (mLock) {
321                boolean changed = false;
322                for (int i = 0; i < mWallpaperMap.size(); i++) {
323                    WallpaperData wallpaper = mWallpaperMap.valueAt(i);
324                    boolean res = doPackagesChangedLocked(doit, wallpaper);
325                    changed |= res;
326                }
327                return changed;
328            }
329        }
330
331        @Override
332        public void onSomePackagesChanged() {
333            synchronized (mLock) {
334                for (int i = 0; i < mWallpaperMap.size(); i++) {
335                    WallpaperData wallpaper = mWallpaperMap.valueAt(i);
336                    doPackagesChangedLocked(true, wallpaper);
337                }
338            }
339        }
340
341        boolean doPackagesChangedLocked(boolean doit, WallpaperData wallpaper) {
342            boolean changed = false;
343            if (wallpaper.wallpaperComponent != null) {
344                int change = isPackageDisappearing(wallpaper.wallpaperComponent
345                        .getPackageName());
346                if (change == PACKAGE_PERMANENT_CHANGE
347                        || change == PACKAGE_TEMPORARY_CHANGE) {
348                    changed = true;
349                    if (doit) {
350                        Slog.w(TAG, "Wallpaper uninstalled, removing: "
351                                + wallpaper.wallpaperComponent);
352                        clearWallpaperLocked(false, wallpaper.userId);
353                    }
354                }
355            }
356            if (wallpaper.nextWallpaperComponent != null) {
357                int change = isPackageDisappearing(wallpaper.nextWallpaperComponent
358                        .getPackageName());
359                if (change == PACKAGE_PERMANENT_CHANGE
360                        || change == PACKAGE_TEMPORARY_CHANGE) {
361                    wallpaper.nextWallpaperComponent = null;
362                }
363            }
364            if (wallpaper.wallpaperComponent != null
365                    && isPackageModified(wallpaper.wallpaperComponent.getPackageName())) {
366                try {
367                    mContext.getPackageManager().getServiceInfo(
368                            wallpaper.wallpaperComponent, 0);
369                } catch (NameNotFoundException e) {
370                    Slog.w(TAG, "Wallpaper component gone, removing: "
371                            + wallpaper.wallpaperComponent);
372                    clearWallpaperLocked(false, wallpaper.userId);
373                }
374            }
375            if (wallpaper.nextWallpaperComponent != null
376                    && isPackageModified(wallpaper.nextWallpaperComponent.getPackageName())) {
377                try {
378                    mContext.getPackageManager().getServiceInfo(
379                            wallpaper.nextWallpaperComponent, 0);
380                } catch (NameNotFoundException e) {
381                    wallpaper.nextWallpaperComponent = null;
382                }
383            }
384            return changed;
385        }
386    }
387
388    public WallpaperManagerService(Context context) {
389        if (DEBUG) Slog.v(TAG, "WallpaperService startup");
390        mContext = context;
391        mIWindowManager = IWindowManager.Stub.asInterface(
392                ServiceManager.getService(Context.WINDOW_SERVICE));
393        mIPackageManager = AppGlobals.getPackageManager();
394        mMonitor = new MyPackageMonitor();
395        mMonitor.register(context, null, true);
396        getWallpaperDir(UserHandle.USER_OWNER).mkdirs();
397        loadSettingsLocked(UserHandle.USER_OWNER);
398    }
399
400    private static File getWallpaperDir(int userId) {
401        return Environment.getUserSystemDirectory(userId);
402    }
403
404    @Override
405    protected void finalize() throws Throwable {
406        super.finalize();
407        for (int i = 0; i < mWallpaperMap.size(); i++) {
408            WallpaperData wallpaper = mWallpaperMap.valueAt(i);
409            wallpaper.wallpaperObserver.stopWatching();
410        }
411    }
412
413    public void systemReady() {
414        if (DEBUG) Slog.v(TAG, "systemReady");
415        WallpaperData wallpaper = mWallpaperMap.get(UserHandle.USER_OWNER);
416        switchWallpaper(wallpaper);
417        wallpaper.wallpaperObserver = new WallpaperObserver(wallpaper);
418        wallpaper.wallpaperObserver.startWatching();
419
420        IntentFilter userFilter = new IntentFilter();
421        userFilter.addAction(Intent.ACTION_USER_SWITCHED);
422        userFilter.addAction(Intent.ACTION_USER_REMOVED);
423        mContext.registerReceiver(new BroadcastReceiver() {
424            @Override
425            public void onReceive(Context context, Intent intent) {
426                String action = intent.getAction();
427                if (Intent.ACTION_USER_SWITCHED.equals(action)) {
428                    switchUser(intent.getIntExtra(Intent.EXTRA_USER_HANDLE, 0));
429                } else if (Intent.ACTION_USER_REMOVED.equals(action)) {
430                    removeUser(intent.getIntExtra(Intent.EXTRA_USER_HANDLE, 0));
431                }
432            }
433        }, userFilter);
434    }
435
436    String getName() {
437        return mWallpaperMap.get(0).name;
438    }
439
440    void removeUser(int userId) {
441        synchronized (mLock) {
442            WallpaperData wallpaper = mWallpaperMap.get(userId);
443            if (wallpaper != null) {
444                wallpaper.wallpaperObserver.stopWatching();
445                mWallpaperMap.remove(userId);
446            }
447            File wallpaperFile = new File(getWallpaperDir(userId), WALLPAPER);
448            wallpaperFile.delete();
449            File wallpaperInfoFile = new File(getWallpaperDir(userId), WALLPAPER_INFO);
450            wallpaperInfoFile.delete();
451        }
452    }
453
454    void switchUser(int userId) {
455        synchronized (mLock) {
456            mCurrentUserId = userId;
457            WallpaperData wallpaper = mWallpaperMap.get(userId);
458            if (wallpaper == null) {
459                wallpaper = new WallpaperData(userId);
460                mWallpaperMap.put(userId, wallpaper);
461                loadSettingsLocked(userId);
462                wallpaper.wallpaperObserver = new WallpaperObserver(wallpaper);
463                wallpaper.wallpaperObserver.startWatching();
464            }
465            switchWallpaper(wallpaper);
466        }
467    }
468
469    void switchWallpaper(WallpaperData wallpaper) {
470        synchronized (mLock) {
471            RuntimeException e = null;
472            try {
473                ComponentName cname = wallpaper.wallpaperComponent != null ?
474                        wallpaper.wallpaperComponent : wallpaper.nextWallpaperComponent;
475                if (bindWallpaperComponentLocked(cname, true, false, wallpaper)) {
476                    return;
477                }
478            } catch (RuntimeException e1) {
479                e = e1;
480            }
481            Slog.w(TAG, "Failure starting previous wallpaper", e);
482            clearWallpaperLocked(false, wallpaper.userId);
483        }
484    }
485
486    public void clearWallpaper() {
487        if (DEBUG) Slog.v(TAG, "clearWallpaper");
488        synchronized (mLock) {
489            clearWallpaperLocked(false, UserHandle.getCallingUserId());
490        }
491    }
492
493    void clearWallpaperLocked(boolean defaultFailed, int userId) {
494        WallpaperData wallpaper = mWallpaperMap.get(userId);
495        File f = new File(getWallpaperDir(userId), WALLPAPER);
496        if (f.exists()) {
497            f.delete();
498        }
499        final long ident = Binder.clearCallingIdentity();
500        RuntimeException e = null;
501        try {
502            wallpaper.imageWallpaperPending = false;
503            if (userId != mCurrentUserId) return;
504            if (bindWallpaperComponentLocked(defaultFailed
505                    ? wallpaper.imageWallpaperComponent
506                    : null, true, false, wallpaper)) {
507                return;
508            }
509        } catch (IllegalArgumentException e1) {
510            e = e1;
511        } finally {
512            Binder.restoreCallingIdentity(ident);
513        }
514
515        // This can happen if the default wallpaper component doesn't
516        // exist.  This should be a system configuration problem, but
517        // let's not let it crash the system and just live with no
518        // wallpaper.
519        Slog.e(TAG, "Default wallpaper component not found!", e);
520        clearWallpaperComponentLocked(wallpaper);
521    }
522
523    public void setDimensionHints(int width, int height) throws RemoteException {
524        checkPermission(android.Manifest.permission.SET_WALLPAPER_HINTS);
525
526        int userId = UserHandle.getCallingUserId();
527        WallpaperData wallpaper = mWallpaperMap.get(userId);
528        if (wallpaper == null) {
529            throw new IllegalStateException("Wallpaper not yet initialized for user " + userId);
530        }
531        if (width <= 0 || height <= 0) {
532            throw new IllegalArgumentException("width and height must be > 0");
533        }
534
535        synchronized (mLock) {
536            if (width != wallpaper.width || height != wallpaper.height) {
537                wallpaper.width = width;
538                wallpaper.height = height;
539                saveSettingsLocked(wallpaper);
540                if (mCurrentUserId != userId) return; // Don't change the properties now
541                if (wallpaper.connection != null) {
542                    if (wallpaper.connection.mEngine != null) {
543                        try {
544                            wallpaper.connection.mEngine.setDesiredSize(
545                                    width, height);
546                        } catch (RemoteException e) {
547                        }
548                        notifyCallbacksLocked(wallpaper);
549                    }
550                }
551            }
552        }
553    }
554
555    public int getWidthHint() throws RemoteException {
556        synchronized (mLock) {
557            WallpaperData wallpaper = mWallpaperMap.get(UserHandle.getCallingUserId());
558            return wallpaper.width;
559        }
560    }
561
562    public int getHeightHint() throws RemoteException {
563        synchronized (mLock) {
564            WallpaperData wallpaper = mWallpaperMap.get(UserHandle.getCallingUserId());
565            return wallpaper.height;
566        }
567    }
568
569    public ParcelFileDescriptor getWallpaper(IWallpaperManagerCallback cb,
570            Bundle outParams) {
571        synchronized (mLock) {
572            // This returns the current user's wallpaper, if called by a system service. Else it
573            // returns the wallpaper for the calling user.
574            int callingUid = Binder.getCallingUid();
575            int wallpaperUserId = 0;
576            if (callingUid == android.os.Process.SYSTEM_UID) {
577                wallpaperUserId = mCurrentUserId;
578            } else {
579                wallpaperUserId = UserHandle.getUserId(callingUid);
580            }
581            WallpaperData wallpaper = mWallpaperMap.get(wallpaperUserId);
582            try {
583                if (outParams != null) {
584                    outParams.putInt("width", wallpaper.width);
585                    outParams.putInt("height", wallpaper.height);
586                }
587                wallpaper.callbacks.register(cb);
588                File f = new File(getWallpaperDir(wallpaperUserId), WALLPAPER);
589                if (!f.exists()) {
590                    return null;
591                }
592                return ParcelFileDescriptor.open(f, MODE_READ_ONLY);
593            } catch (FileNotFoundException e) {
594                /* Shouldn't happen as we check to see if the file exists */
595                Slog.w(TAG, "Error getting wallpaper", e);
596            }
597            return null;
598        }
599    }
600
601    public WallpaperInfo getWallpaperInfo() {
602        int userId = UserHandle.getCallingUserId();
603        synchronized (mLock) {
604            WallpaperData wallpaper = mWallpaperMap.get(userId);
605            if (wallpaper.connection != null) {
606                return wallpaper.connection.mInfo;
607            }
608            return null;
609        }
610    }
611
612    public ParcelFileDescriptor setWallpaper(String name) {
613        if (DEBUG) Slog.v(TAG, "setWallpaper");
614        int userId = UserHandle.getCallingUserId();
615        WallpaperData wallpaper = mWallpaperMap.get(userId);
616        if (wallpaper == null) {
617            throw new IllegalStateException("Wallpaper not yet initialized for user " + userId);
618        }
619        checkPermission(android.Manifest.permission.SET_WALLPAPER);
620        synchronized (mLock) {
621            final long ident = Binder.clearCallingIdentity();
622            try {
623                ParcelFileDescriptor pfd = updateWallpaperBitmapLocked(name, wallpaper);
624                if (pfd != null) {
625                    wallpaper.imageWallpaperPending = true;
626                }
627                return pfd;
628            } finally {
629                Binder.restoreCallingIdentity(ident);
630            }
631        }
632    }
633
634    ParcelFileDescriptor updateWallpaperBitmapLocked(String name, WallpaperData wallpaper) {
635        if (name == null) name = "";
636        try {
637            File dir = getWallpaperDir(wallpaper.userId);
638            if (!dir.exists()) {
639                dir.mkdir();
640                FileUtils.setPermissions(
641                        dir.getPath(),
642                        FileUtils.S_IRWXU|FileUtils.S_IRWXG|FileUtils.S_IXOTH,
643                        -1, -1);
644            }
645            File file = new File(dir, WALLPAPER);
646            ParcelFileDescriptor fd = ParcelFileDescriptor.open(file,
647                    MODE_CREATE|MODE_READ_WRITE);
648            if (!SELinux.restorecon(file)) {
649                return null;
650            }
651            wallpaper.name = name;
652            return fd;
653        } catch (FileNotFoundException e) {
654            Slog.w(TAG, "Error setting wallpaper", e);
655        }
656        return null;
657    }
658
659    public void setWallpaperComponent(ComponentName name) {
660        if (DEBUG) Slog.v(TAG, "setWallpaperComponent name=" + name);
661        int userId = UserHandle.getCallingUserId();
662        WallpaperData wallpaper = mWallpaperMap.get(userId);
663        if (wallpaper == null) {
664            throw new IllegalStateException("Wallpaper not yet initialized for user " + userId);
665        }
666        checkPermission(android.Manifest.permission.SET_WALLPAPER_COMPONENT);
667        synchronized (mLock) {
668            final long ident = Binder.clearCallingIdentity();
669            try {
670                wallpaper.imageWallpaperPending = false;
671                bindWallpaperComponentLocked(name, false, true, wallpaper);
672            } finally {
673                Binder.restoreCallingIdentity(ident);
674            }
675        }
676    }
677
678    boolean bindWallpaperComponentLocked(ComponentName componentName, boolean force,
679            boolean fromUser, WallpaperData wallpaper) {
680        if (DEBUG) Slog.v(TAG, "bindWallpaperComponentLocked: componentName=" + componentName);
681        // Has the component changed?
682        if (!force) {
683            if (wallpaper.connection != null) {
684                if (wallpaper.wallpaperComponent == null) {
685                    if (componentName == null) {
686                        if (DEBUG) Slog.v(TAG, "bindWallpaperComponentLocked: still using default");
687                        // Still using default wallpaper.
688                        return true;
689                    }
690                } else if (wallpaper.wallpaperComponent.equals(componentName)) {
691                    // Changing to same wallpaper.
692                    if (DEBUG) Slog.v(TAG, "same wallpaper");
693                    return true;
694                }
695            }
696        }
697
698        try {
699            if (componentName == null) {
700                String defaultComponent =
701                    mContext.getString(com.android.internal.R.string.default_wallpaper_component);
702                if (defaultComponent != null) {
703                    // See if there is a default wallpaper component specified
704                    componentName = ComponentName.unflattenFromString(defaultComponent);
705                    if (DEBUG) Slog.v(TAG, "Use default component wallpaper:" + componentName);
706                }
707                if (componentName == null) {
708                    // Fall back to static image wallpaper
709                    componentName = wallpaper.imageWallpaperComponent;
710                    //clearWallpaperComponentLocked();
711                    //return;
712                    if (DEBUG) Slog.v(TAG, "Using image wallpaper");
713                }
714            }
715            int serviceUserId = wallpaper.userId;
716            ServiceInfo si = mIPackageManager.getServiceInfo(componentName,
717                    PackageManager.GET_META_DATA | PackageManager.GET_PERMISSIONS, serviceUserId);
718            if (!android.Manifest.permission.BIND_WALLPAPER.equals(si.permission)) {
719                String msg = "Selected service does not require "
720                        + android.Manifest.permission.BIND_WALLPAPER
721                        + ": " + componentName;
722                if (fromUser) {
723                    throw new SecurityException(msg);
724                }
725                Slog.w(TAG, msg);
726                return false;
727            }
728
729            WallpaperInfo wi = null;
730
731            Intent intent = new Intent(WallpaperService.SERVICE_INTERFACE);
732            if (componentName != null && !componentName.equals(wallpaper.imageWallpaperComponent)) {
733                // Make sure the selected service is actually a wallpaper service.
734                List<ResolveInfo> ris =
735                        mIPackageManager.queryIntentServices(intent,
736                                intent.resolveTypeIfNeeded(mContext.getContentResolver()),
737                                PackageManager.GET_META_DATA, serviceUserId);
738                for (int i=0; i<ris.size(); i++) {
739                    ServiceInfo rsi = ris.get(i).serviceInfo;
740                    if (rsi.name.equals(si.name) &&
741                            rsi.packageName.equals(si.packageName)) {
742                        try {
743                            wi = new WallpaperInfo(mContext, ris.get(i));
744                        } catch (XmlPullParserException e) {
745                            if (fromUser) {
746                                throw new IllegalArgumentException(e);
747                            }
748                            Slog.w(TAG, e);
749                            return false;
750                        } catch (IOException e) {
751                            if (fromUser) {
752                                throw new IllegalArgumentException(e);
753                            }
754                            Slog.w(TAG, e);
755                            return false;
756                        }
757                        break;
758                    }
759                }
760                if (wi == null) {
761                    String msg = "Selected service is not a wallpaper: "
762                            + componentName;
763                    if (fromUser) {
764                        throw new SecurityException(msg);
765                    }
766                    Slog.w(TAG, msg);
767                    return false;
768                }
769            }
770
771            // Bind the service!
772            if (DEBUG) Slog.v(TAG, "Binding to:" + componentName);
773            WallpaperConnection newConn = new WallpaperConnection(wi, wallpaper);
774            intent.setComponent(componentName);
775            intent.putExtra(Intent.EXTRA_CLIENT_LABEL,
776                    com.android.internal.R.string.wallpaper_binding_label);
777            intent.putExtra(Intent.EXTRA_CLIENT_INTENT, PendingIntent.getActivity(
778                    mContext, 0,
779                    Intent.createChooser(new Intent(Intent.ACTION_SET_WALLPAPER),
780                            mContext.getText(com.android.internal.R.string.chooser_wallpaper)),
781                            0));
782            if (!mContext.bindService(intent, newConn, Context.BIND_AUTO_CREATE, serviceUserId)) {
783                String msg = "Unable to bind service: "
784                        + componentName;
785                if (fromUser) {
786                    throw new IllegalArgumentException(msg);
787                }
788                Slog.w(TAG, msg);
789                return false;
790            }
791            if (wallpaper.userId == mCurrentUserId && mLastWallpaper != null) {
792                detachWallpaperLocked(mLastWallpaper);
793            }
794            wallpaper.wallpaperComponent = componentName;
795            wallpaper.connection = newConn;
796            wallpaper.lastDiedTime = SystemClock.uptimeMillis();
797            try {
798                if (wallpaper.userId == mCurrentUserId) {
799                    if (DEBUG)
800                        Slog.v(TAG, "Adding window token: " + newConn.mToken);
801                    mIWindowManager.addWindowToken(newConn.mToken,
802                            WindowManager.LayoutParams.TYPE_WALLPAPER);
803                    mLastWallpaper = wallpaper;
804                }
805            } catch (RemoteException e) {
806            }
807        } catch (RemoteException e) {
808            String msg = "Remote exception for " + componentName + "\n" + e;
809            if (fromUser) {
810                throw new IllegalArgumentException(msg);
811            }
812            Slog.w(TAG, msg);
813            return false;
814        }
815        return true;
816    }
817
818    void detachWallpaperLocked(WallpaperData wallpaper) {
819        if (wallpaper.connection != null) {
820            if (wallpaper.connection.mEngine != null) {
821                try {
822                    wallpaper.connection.mEngine.destroy();
823                } catch (RemoteException e) {
824                }
825            }
826            mContext.unbindService(wallpaper.connection);
827            try {
828                if (DEBUG)
829                    Slog.v(TAG, "Removing window token: " + wallpaper.connection.mToken);
830                mIWindowManager.removeWindowToken(wallpaper.connection.mToken);
831            } catch (RemoteException e) {
832            }
833            wallpaper.connection.mService = null;
834            wallpaper.connection.mEngine = null;
835            wallpaper.connection = null;
836        }
837    }
838
839    void clearWallpaperComponentLocked(WallpaperData wallpaper) {
840        wallpaper.wallpaperComponent = null;
841        detachWallpaperLocked(wallpaper);
842    }
843
844    void attachServiceLocked(WallpaperConnection conn, WallpaperData wallpaper) {
845        try {
846            conn.mService.attach(conn, conn.mToken,
847                    WindowManager.LayoutParams.TYPE_WALLPAPER, false,
848                    wallpaper.width, wallpaper.height);
849        } catch (RemoteException e) {
850            Slog.w(TAG, "Failed attaching wallpaper; clearing", e);
851            if (!wallpaper.wallpaperUpdating) {
852                bindWallpaperComponentLocked(null, false, false, wallpaper);
853            }
854        }
855    }
856
857    private void notifyCallbacksLocked(WallpaperData wallpaper) {
858        final int n = wallpaper.callbacks.beginBroadcast();
859        for (int i = 0; i < n; i++) {
860            try {
861                wallpaper.callbacks.getBroadcastItem(i).onWallpaperChanged();
862            } catch (RemoteException e) {
863
864                // The RemoteCallbackList will take care of removing
865                // the dead object for us.
866            }
867        }
868        wallpaper.callbacks.finishBroadcast();
869        final Intent intent = new Intent(Intent.ACTION_WALLPAPER_CHANGED);
870        mContext.sendBroadcastAsUser(intent, new UserHandle(mCurrentUserId));
871    }
872
873    private void checkPermission(String permission) {
874        if (PackageManager.PERMISSION_GRANTED!= mContext.checkCallingOrSelfPermission(permission)) {
875            throw new SecurityException("Access denied to process: " + Binder.getCallingPid()
876                    + ", must have permission " + permission);
877        }
878    }
879
880    private static JournaledFile makeJournaledFile(int userId) {
881        final String base = new File(getWallpaperDir(userId), WALLPAPER_INFO).getAbsolutePath();
882        return new JournaledFile(new File(base), new File(base + ".tmp"));
883    }
884
885    private void saveSettingsLocked(WallpaperData wallpaper) {
886        JournaledFile journal = makeJournaledFile(wallpaper.userId);
887        FileOutputStream stream = null;
888        try {
889            stream = new FileOutputStream(journal.chooseForWrite(), false);
890            XmlSerializer out = new FastXmlSerializer();
891            out.setOutput(stream, "utf-8");
892            out.startDocument(null, true);
893
894            out.startTag(null, "wp");
895            out.attribute(null, "width", Integer.toString(wallpaper.width));
896            out.attribute(null, "height", Integer.toString(wallpaper.height));
897            out.attribute(null, "name", wallpaper.name);
898            if (wallpaper.wallpaperComponent != null
899                    && !wallpaper.wallpaperComponent.equals(wallpaper.imageWallpaperComponent)) {
900                out.attribute(null, "component",
901                        wallpaper.wallpaperComponent.flattenToShortString());
902            }
903            out.endTag(null, "wp");
904
905            out.endDocument();
906            stream.close();
907            journal.commit();
908        } catch (IOException e) {
909            try {
910                if (stream != null) {
911                    stream.close();
912                }
913            } catch (IOException ex) {
914                // Ignore
915            }
916            journal.rollback();
917        }
918    }
919
920    private void migrateFromOld() {
921        File oldWallpaper = new File(WallpaperBackupHelper.WALLPAPER_IMAGE_KEY);
922        File oldInfo = new File(WallpaperBackupHelper.WALLPAPER_INFO_KEY);
923        if (oldWallpaper.exists()) {
924            File newWallpaper = new File(getWallpaperDir(0), WALLPAPER);
925            oldWallpaper.renameTo(newWallpaper);
926        }
927        if (oldInfo.exists()) {
928            File newInfo = new File(getWallpaperDir(0), WALLPAPER_INFO);
929            oldInfo.renameTo(newInfo);
930        }
931    }
932
933    private void loadSettingsLocked(int userId) {
934        if (DEBUG) Slog.v(TAG, "loadSettingsLocked");
935
936        JournaledFile journal = makeJournaledFile(userId);
937        FileInputStream stream = null;
938        File file = journal.chooseForRead();
939        if (!file.exists()) {
940            // This should only happen one time, when upgrading from a legacy system
941            migrateFromOld();
942        }
943        WallpaperData wallpaper = mWallpaperMap.get(userId);
944        if (wallpaper == null) {
945            wallpaper = new WallpaperData(userId);
946            mWallpaperMap.put(userId, wallpaper);
947        }
948        boolean success = false;
949        try {
950            stream = new FileInputStream(file);
951            XmlPullParser parser = Xml.newPullParser();
952            parser.setInput(stream, null);
953
954            int type;
955            do {
956                type = parser.next();
957                if (type == XmlPullParser.START_TAG) {
958                    String tag = parser.getName();
959                    if ("wp".equals(tag)) {
960                        wallpaper.width = Integer.parseInt(parser.getAttributeValue(null, "width"));
961                        wallpaper.height = Integer.parseInt(parser
962                                .getAttributeValue(null, "height"));
963                        wallpaper.name = parser.getAttributeValue(null, "name");
964                        String comp = parser.getAttributeValue(null, "component");
965                        wallpaper.nextWallpaperComponent = comp != null
966                                ? ComponentName.unflattenFromString(comp)
967                                : null;
968                        if (wallpaper.nextWallpaperComponent == null
969                                || "android".equals(wallpaper.nextWallpaperComponent
970                                        .getPackageName())) {
971                            wallpaper.nextWallpaperComponent = wallpaper.imageWallpaperComponent;
972                        }
973
974                        if (DEBUG) {
975                            Slog.v(TAG, "mWidth:" + wallpaper.width);
976                            Slog.v(TAG, "mHeight:" + wallpaper.height);
977                            Slog.v(TAG, "mName:" + wallpaper.name);
978                            Slog.v(TAG, "mNextWallpaperComponent:"
979                                    + wallpaper.nextWallpaperComponent);
980                        }
981                    }
982                }
983            } while (type != XmlPullParser.END_DOCUMENT);
984            success = true;
985        } catch (NullPointerException e) {
986            Slog.w(TAG, "failed parsing " + file + " " + e);
987        } catch (NumberFormatException e) {
988            Slog.w(TAG, "failed parsing " + file + " " + e);
989        } catch (XmlPullParserException e) {
990            Slog.w(TAG, "failed parsing " + file + " " + e);
991        } catch (IOException e) {
992            Slog.w(TAG, "failed parsing " + file + " " + e);
993        } catch (IndexOutOfBoundsException e) {
994            Slog.w(TAG, "failed parsing " + file + " " + e);
995        }
996        try {
997            if (stream != null) {
998                stream.close();
999            }
1000        } catch (IOException e) {
1001            // Ignore
1002        }
1003
1004        if (!success) {
1005            wallpaper.width = -1;
1006            wallpaper.height = -1;
1007            wallpaper.name = "";
1008        }
1009
1010        // We always want to have some reasonable width hint.
1011        WindowManager wm = (WindowManager)mContext.getSystemService(Context.WINDOW_SERVICE);
1012        Display d = wm.getDefaultDisplay();
1013        int baseSize = d.getMaximumSizeDimension();
1014        if (wallpaper.width < baseSize) {
1015            wallpaper.width = baseSize;
1016        }
1017        if (wallpaper.height < baseSize) {
1018            wallpaper.height = baseSize;
1019        }
1020    }
1021
1022    // Called by SystemBackupAgent after files are restored to disk.
1023    void settingsRestored() {
1024        // TODO: If necessary, make it work for secondary users as well. This currently assumes
1025        // restores only to the primary user
1026        if (DEBUG) Slog.v(TAG, "settingsRestored");
1027        WallpaperData wallpaper = null;
1028        boolean success = false;
1029        synchronized (mLock) {
1030            loadSettingsLocked(0);
1031            wallpaper = mWallpaperMap.get(0);
1032            if (wallpaper.nextWallpaperComponent != null
1033                    && !wallpaper.nextWallpaperComponent.equals(wallpaper.imageWallpaperComponent)) {
1034                if (!bindWallpaperComponentLocked(wallpaper.nextWallpaperComponent, false, false,
1035                        wallpaper)) {
1036                    // No such live wallpaper or other failure; fall back to the default
1037                    // live wallpaper (since the profile being restored indicated that the
1038                    // user had selected a live rather than static one).
1039                    bindWallpaperComponentLocked(null, false, false, wallpaper);
1040                }
1041                success = true;
1042            } else {
1043                // If there's a wallpaper name, we use that.  If that can't be loaded, then we
1044                // use the default.
1045                if ("".equals(wallpaper.name)) {
1046                    if (DEBUG) Slog.v(TAG, "settingsRestored: name is empty");
1047                    success = true;
1048                } else {
1049                    if (DEBUG) Slog.v(TAG, "settingsRestored: attempting to restore named resource");
1050                    success = restoreNamedResourceLocked(wallpaper);
1051                }
1052                if (DEBUG) Slog.v(TAG, "settingsRestored: success=" + success);
1053                if (success) {
1054                    bindWallpaperComponentLocked(wallpaper.nextWallpaperComponent, false, false,
1055                            wallpaper);
1056                }
1057            }
1058        }
1059
1060        if (!success) {
1061            Slog.e(TAG, "Failed to restore wallpaper: '" + wallpaper.name + "'");
1062            wallpaper.name = "";
1063            getWallpaperDir(0).delete();
1064        }
1065
1066        synchronized (mLock) {
1067            saveSettingsLocked(wallpaper);
1068        }
1069    }
1070
1071    boolean restoreNamedResourceLocked(WallpaperData wallpaper) {
1072        if (wallpaper.name.length() > 4 && "res:".equals(wallpaper.name.substring(0, 4))) {
1073            String resName = wallpaper.name.substring(4);
1074
1075            String pkg = null;
1076            int colon = resName.indexOf(':');
1077            if (colon > 0) {
1078                pkg = resName.substring(0, colon);
1079            }
1080
1081            String ident = null;
1082            int slash = resName.lastIndexOf('/');
1083            if (slash > 0) {
1084                ident = resName.substring(slash+1);
1085            }
1086
1087            String type = null;
1088            if (colon > 0 && slash > 0 && (slash-colon) > 1) {
1089                type = resName.substring(colon+1, slash);
1090            }
1091
1092            if (pkg != null && ident != null && type != null) {
1093                int resId = -1;
1094                InputStream res = null;
1095                FileOutputStream fos = null;
1096                try {
1097                    Context c = mContext.createPackageContext(pkg, Context.CONTEXT_RESTRICTED);
1098                    Resources r = c.getResources();
1099                    resId = r.getIdentifier(resName, null, null);
1100                    if (resId == 0) {
1101                        Slog.e(TAG, "couldn't resolve identifier pkg=" + pkg + " type=" + type
1102                                + " ident=" + ident);
1103                        return false;
1104                    }
1105
1106                    res = r.openRawResource(resId);
1107                    if (wallpaper.wallpaperFile.exists()) {
1108                        wallpaper.wallpaperFile.delete();
1109                    }
1110                    fos = new FileOutputStream(wallpaper.wallpaperFile);
1111
1112                    byte[] buffer = new byte[32768];
1113                    int amt;
1114                    while ((amt=res.read(buffer)) > 0) {
1115                        fos.write(buffer, 0, amt);
1116                    }
1117                    // mWallpaperObserver will notice the close and send the change broadcast
1118
1119                    Slog.v(TAG, "Restored wallpaper: " + resName);
1120                    return true;
1121                } catch (NameNotFoundException e) {
1122                    Slog.e(TAG, "Package name " + pkg + " not found");
1123                } catch (Resources.NotFoundException e) {
1124                    Slog.e(TAG, "Resource not found: " + resId);
1125                } catch (IOException e) {
1126                    Slog.e(TAG, "IOException while restoring wallpaper ", e);
1127                } finally {
1128                    if (res != null) {
1129                        try {
1130                            res.close();
1131                        } catch (IOException ex) {}
1132                    }
1133                    if (fos != null) {
1134                        FileUtils.sync(fos);
1135                        try {
1136                            fos.close();
1137                        } catch (IOException ex) {}
1138                    }
1139                }
1140            }
1141        }
1142        return false;
1143    }
1144
1145    @Override
1146    protected void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
1147        if (mContext.checkCallingOrSelfPermission(android.Manifest.permission.DUMP)
1148                != PackageManager.PERMISSION_GRANTED) {
1149
1150            pw.println("Permission Denial: can't dump wallpaper service from from pid="
1151                    + Binder.getCallingPid()
1152                    + ", uid=" + Binder.getCallingUid());
1153            return;
1154        }
1155
1156        synchronized (mLock) {
1157            pw.println("Current Wallpaper Service state:");
1158            for (int i = 0; i < mWallpaperMap.size(); i++) {
1159                WallpaperData wallpaper = mWallpaperMap.valueAt(i);
1160                pw.println(" User " + wallpaper.userId + ":");
1161                pw.print("  mWidth=");
1162                pw.print(wallpaper.width);
1163                pw.print(" mHeight=");
1164                pw.println(wallpaper.height);
1165                pw.print("  mName=");
1166                pw.println(wallpaper.name);
1167                pw.print("  mWallpaperComponent=");
1168                pw.println(wallpaper.wallpaperComponent);
1169                if (wallpaper.connection != null) {
1170                    WallpaperConnection conn = wallpaper.connection;
1171                    pw.print("  Wallpaper connection ");
1172                    pw.print(conn);
1173                    pw.println(":");
1174                    if (conn.mInfo != null) {
1175                        pw.print("    mInfo.component=");
1176                        pw.println(conn.mInfo.getComponent());
1177                    }
1178                    pw.print("    mToken=");
1179                    pw.println(conn.mToken);
1180                    pw.print("    mService=");
1181                    pw.println(conn.mService);
1182                    pw.print("    mEngine=");
1183                    pw.println(conn.mEngine);
1184                    pw.print("    mLastDiedTime=");
1185                    pw.println(wallpaper.lastDiedTime - SystemClock.uptimeMillis());
1186                }
1187            }
1188        }
1189    }
1190}
1191