1 /*
2  * Copyright (C) 2017 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 
17 package com.android.systemui.statusbar.notification.row;
18 
19 import android.animation.Animator;
20 import android.animation.AnimatorListenerAdapter;
21 import android.animation.AnimatorSet;
22 import android.animation.ObjectAnimator;
23 import android.content.Context;
24 import android.content.res.Resources;
25 import android.graphics.Typeface;
26 import android.metrics.LogMaker;
27 import android.os.Bundle;
28 import android.provider.Settings;
29 import android.service.notification.SnoozeCriterion;
30 import android.service.notification.StatusBarNotification;
31 import android.text.SpannableString;
32 import android.text.style.StyleSpan;
33 import android.util.AttributeSet;
34 import android.util.KeyValueListParser;
35 import android.util.Log;
36 import android.view.LayoutInflater;
37 import android.view.View;
38 import android.view.ViewGroup;
39 import android.view.accessibility.AccessibilityEvent;
40 import android.view.accessibility.AccessibilityNodeInfo;
41 import android.view.accessibility.AccessibilityNodeInfo.AccessibilityAction;
42 import android.widget.ImageView;
43 import android.widget.LinearLayout;
44 import android.widget.TextView;
45 
46 import com.android.internal.annotations.VisibleForTesting;
47 import com.android.internal.logging.MetricsLogger;
48 import com.android.internal.logging.nano.MetricsProto.MetricsEvent;
49 import com.android.systemui.R;
50 import com.android.systemui.animation.Interpolators;
51 import com.android.systemui.plugins.statusbar.NotificationSwipeActionHelper;
52 import com.android.systemui.plugins.statusbar.NotificationSwipeActionHelper.SnoozeOption;
53 
54 import java.util.ArrayList;
55 import java.util.List;
56 import java.util.concurrent.TimeUnit;
57 
58 public class NotificationSnooze extends LinearLayout
59         implements NotificationGuts.GutsContent, View.OnClickListener {
60 
61     private static final String TAG = "NotificationSnooze";
62     /**
63      * If this changes more number increases, more assistant action resId's should be defined for
64      * accessibility purposes, see {@link #setSnoozeOptions(List)}
65      */
66     private static final int MAX_ASSISTANT_SUGGESTIONS = 1;
67     private static final String KEY_DEFAULT_SNOOZE = "default";
68     private static final String KEY_OPTIONS = "options_array";
69     private static final LogMaker OPTIONS_OPEN_LOG =
70             new LogMaker(MetricsEvent.NOTIFICATION_SNOOZE_OPTIONS)
71                     .setType(MetricsEvent.TYPE_OPEN);
72     private static final LogMaker OPTIONS_CLOSE_LOG =
73             new LogMaker(MetricsEvent.NOTIFICATION_SNOOZE_OPTIONS)
74                     .setType(MetricsEvent.TYPE_CLOSE);
75     private static final LogMaker UNDO_LOG =
76             new LogMaker(MetricsEvent.NOTIFICATION_UNDO_SNOOZE)
77                     .setType(MetricsEvent.TYPE_ACTION);
78     private NotificationGuts mGutsContainer;
79     private NotificationSwipeActionHelper mSnoozeListener;
80     private StatusBarNotification mSbn;
81 
82     private View mSnoozeView;
83     private TextView mSelectedOptionText;
84     private TextView mUndoButton;
85     private ImageView mExpandButton;
86     private View mDivider;
87     private ViewGroup mSnoozeOptionContainer;
88     private List<SnoozeOption> mSnoozeOptions;
89     private int mCollapsedHeight;
90     private SnoozeOption mDefaultOption;
91     private SnoozeOption mSelectedOption;
92     private boolean mSnoozing;
93     private boolean mExpanded;
94     private AnimatorSet mExpandAnimation;
95     private KeyValueListParser mParser;
96 
97     private final static int[] sAccessibilityActions = {
98             R.id.action_snooze_shorter,
99             R.id.action_snooze_short,
100             R.id.action_snooze_long,
101             R.id.action_snooze_longer,
102     };
103 
104     private MetricsLogger mMetricsLogger = new MetricsLogger();
105 
NotificationSnooze(Context context, AttributeSet attrs)106     public NotificationSnooze(Context context, AttributeSet attrs) {
107         super(context, attrs);
108         mParser = new KeyValueListParser(',');
109     }
110 
111     @VisibleForTesting
getDefaultOption()112     SnoozeOption getDefaultOption()
113     {
114         return mDefaultOption;
115     }
116 
117     @VisibleForTesting
setKeyValueListParser(KeyValueListParser parser)118     void setKeyValueListParser(KeyValueListParser parser) {
119         mParser = parser;
120     }
121 
122     @Override
onFinishInflate()123     protected void onFinishInflate() {
124         super.onFinishInflate();
125         mCollapsedHeight = getResources().getDimensionPixelSize(R.dimen.snooze_snackbar_min_height);
126         mSnoozeView = findViewById(R.id.notification_snooze);
127         mSnoozeView.setOnClickListener(this);
128         mSelectedOptionText = (TextView) findViewById(R.id.snooze_option_default);
129         mUndoButton = (TextView) findViewById(R.id.undo);
130         mUndoButton.setOnClickListener(this);
131         mExpandButton = (ImageView) findViewById(R.id.expand_button);
132         mDivider = findViewById(R.id.divider);
133         mDivider.setAlpha(0f);
134         mSnoozeOptionContainer = (ViewGroup) findViewById(R.id.snooze_options);
135         mSnoozeOptionContainer.setVisibility(View.INVISIBLE);
136         mSnoozeOptionContainer.setAlpha(0f);
137 
138         // Create the different options based on list
139         mSnoozeOptions = getDefaultSnoozeOptions();
140         createOptionViews();
141 
142         setSelected(mDefaultOption, false);
143     }
144 
145     @Override
onAttachedToWindow()146     protected void onAttachedToWindow() {
147         super.onAttachedToWindow();
148         logOptionSelection(MetricsEvent.NOTIFICATION_SNOOZE_CLICKED, mDefaultOption);
149         dispatchConfigurationChanged(getResources().getConfiguration());
150     }
151 
152     @Override
onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)153     public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
154         super.onInitializeAccessibilityNodeInfo(info);
155         info.addAction(new AccessibilityAction(R.id.action_snooze_undo,
156                 getResources().getString(R.string.snooze_undo)));
157         int count = mSnoozeOptions.size();
158         for (int i = 0; i < count; i++) {
159             AccessibilityAction action = mSnoozeOptions.get(i).getAccessibilityAction();
160             if (action != null) {
161                 info.addAction(action);
162             }
163         }
164     }
165 
166     @Override
performAccessibilityActionInternal(int action, Bundle arguments)167     public boolean performAccessibilityActionInternal(int action, Bundle arguments) {
168         if (super.performAccessibilityActionInternal(action, arguments)) {
169             return true;
170         }
171         if (action == R.id.action_snooze_undo) {
172             undoSnooze(mUndoButton);
173             return true;
174         }
175         for (int i = 0; i < mSnoozeOptions.size(); i++) {
176             SnoozeOption so = mSnoozeOptions.get(i);
177             if (so.getAccessibilityAction() != null
178                     && so.getAccessibilityAction().getId() == action) {
179                 setSelected(so, true);
180                 return true;
181             }
182         }
183         return false;
184     }
185 
setSnoozeOptions(final List<SnoozeCriterion> snoozeList)186     public void setSnoozeOptions(final List<SnoozeCriterion> snoozeList) {
187         if (snoozeList == null) {
188             return;
189         }
190         mSnoozeOptions.clear();
191         mSnoozeOptions = getDefaultSnoozeOptions();
192         final int count = Math.min(MAX_ASSISTANT_SUGGESTIONS, snoozeList.size());
193         for (int i = 0; i < count; i++) {
194             SnoozeCriterion sc = snoozeList.get(i);
195             AccessibilityAction action = new AccessibilityAction(
196                     R.id.action_snooze_assistant_suggestion_1, sc.getExplanation());
197             mSnoozeOptions.add(new NotificationSnoozeOption(sc, 0, sc.getExplanation(),
198                     sc.getConfirmation(), action));
199         }
200         createOptionViews();
201     }
202 
isExpanded()203     public boolean isExpanded() {
204         return mExpanded;
205     }
206 
setSnoozeListener(NotificationSwipeActionHelper listener)207     public void setSnoozeListener(NotificationSwipeActionHelper listener) {
208         mSnoozeListener = listener;
209     }
210 
setStatusBarNotification(StatusBarNotification sbn)211     public void setStatusBarNotification(StatusBarNotification sbn) {
212         mSbn = sbn;
213     }
214 
215     @VisibleForTesting
getDefaultSnoozeOptions()216     ArrayList<SnoozeOption> getDefaultSnoozeOptions() {
217         final Resources resources = getContext().getResources();
218         ArrayList<SnoozeOption> options = new ArrayList<>();
219         try {
220             final String config = Settings.Global.getString(getContext().getContentResolver(),
221                     Settings.Global.NOTIFICATION_SNOOZE_OPTIONS);
222             mParser.setString(config);
223         } catch (IllegalArgumentException e) {
224             Log.e(TAG, "Bad snooze constants");
225         }
226 
227         final int defaultSnooze = mParser.getInt(KEY_DEFAULT_SNOOZE,
228                 resources.getInteger(R.integer.config_notification_snooze_time_default));
229         final int[] snoozeTimes = mParser.getIntArray(KEY_OPTIONS,
230                 resources.getIntArray(R.array.config_notification_snooze_times));
231 
232         for (int i = 0; i < snoozeTimes.length && i < sAccessibilityActions.length; i++) {
233             int snoozeTime = snoozeTimes[i];
234             SnoozeOption option = createOption(snoozeTime, sAccessibilityActions[i]);
235             if (i == 0 || snoozeTime == defaultSnooze) {
236                 mDefaultOption = option;
237             }
238             options.add(option);
239         }
240         return options;
241     }
242 
createOption(int minutes, int accessibilityActionId)243     private SnoozeOption createOption(int minutes, int accessibilityActionId) {
244         Resources res = getResources();
245         boolean showInHours = minutes >= 60;
246         int pluralResId = showInHours
247                 ? R.plurals.snoozeHourOptions
248                 : R.plurals.snoozeMinuteOptions;
249         int count = showInHours ? (minutes / 60) : minutes;
250         String description = res.getQuantityString(pluralResId, count, count);
251         String resultText = String.format(res.getString(R.string.snoozed_for_time), description);
252         AccessibilityAction action = new AccessibilityAction(accessibilityActionId, description);
253         final int index = resultText.indexOf(description);
254         if (index == -1) {
255             return new NotificationSnoozeOption(null, minutes, description, resultText, action);
256         }
257         SpannableString string = new SpannableString(resultText);
258         string.setSpan(new StyleSpan(Typeface.BOLD, res.getConfiguration().fontWeightAdjustment),
259                 index, index + description.length(), 0 /* flags */);
260         return new NotificationSnoozeOption(null, minutes, description, string,
261                 action);
262     }
263 
createOptionViews()264     private void createOptionViews() {
265         mSnoozeOptionContainer.removeAllViews();
266         LayoutInflater inflater = (LayoutInflater) getContext().getSystemService(
267                 Context.LAYOUT_INFLATER_SERVICE);
268         for (int i = 0; i < mSnoozeOptions.size(); i++) {
269             SnoozeOption option = mSnoozeOptions.get(i);
270             TextView tv = (TextView) inflater.inflate(R.layout.notification_snooze_option,
271                     mSnoozeOptionContainer, false);
272             mSnoozeOptionContainer.addView(tv);
273             tv.setText(option.getDescription());
274             tv.setTag(option);
275             tv.setOnClickListener(this);
276         }
277     }
278 
hideSelectedOption()279     private void hideSelectedOption() {
280         final int childCount = mSnoozeOptionContainer.getChildCount();
281         for (int i = 0; i < childCount; i++) {
282             final View child = mSnoozeOptionContainer.getChildAt(i);
283             child.setVisibility(child.getTag() == mSelectedOption ? View.GONE : View.VISIBLE);
284         }
285     }
286 
showSnoozeOptions(boolean show)287     private void showSnoozeOptions(boolean show) {
288         int drawableId = show ? com.android.internal.R.drawable.ic_collapse_notification
289                 : com.android.internal.R.drawable.ic_expand_notification;
290         mExpandButton.setImageResource(drawableId);
291         if (mExpanded != show) {
292             mExpanded = show;
293             animateSnoozeOptions(show);
294             if (mGutsContainer != null) {
295                 mGutsContainer.onHeightChanged();
296             }
297         }
298     }
299 
animateSnoozeOptions(boolean show)300     private void animateSnoozeOptions(boolean show) {
301         if (mExpandAnimation != null) {
302             mExpandAnimation.cancel();
303         }
304         ObjectAnimator dividerAnim = ObjectAnimator.ofFloat(mDivider, View.ALPHA,
305                 mDivider.getAlpha(), show ? 1f : 0f);
306         ObjectAnimator optionAnim = ObjectAnimator.ofFloat(mSnoozeOptionContainer, View.ALPHA,
307                 mSnoozeOptionContainer.getAlpha(), show ? 1f : 0f);
308         mSnoozeOptionContainer.setVisibility(View.VISIBLE);
309         mExpandAnimation = new AnimatorSet();
310         mExpandAnimation.playTogether(dividerAnim, optionAnim);
311         mExpandAnimation.setDuration(150);
312         mExpandAnimation.setInterpolator(show ? Interpolators.ALPHA_IN : Interpolators.ALPHA_OUT);
313         mExpandAnimation.addListener(new AnimatorListenerAdapter() {
314             boolean cancelled = false;
315 
316             @Override
317             public void onAnimationCancel(Animator animation) {
318                 cancelled = true;
319             }
320 
321             @Override
322             public void onAnimationEnd(Animator animation) {
323                 if (!show && !cancelled) {
324                     mSnoozeOptionContainer.setVisibility(View.INVISIBLE);
325                     mSnoozeOptionContainer.setAlpha(0f);
326                 }
327             }
328         });
329         mExpandAnimation.start();
330     }
331 
setSelected(SnoozeOption option, boolean userAction)332     private void setSelected(SnoozeOption option, boolean userAction) {
333         mSelectedOption = option;
334         mSelectedOptionText.setText(option.getConfirmation());
335         showSnoozeOptions(false);
336         hideSelectedOption();
337         if (userAction) {
338             mSnoozeView.sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
339             logOptionSelection(MetricsEvent.NOTIFICATION_SELECT_SNOOZE, option);
340         }
341     }
342 
343     @Override
requestAccessibilityFocus()344     public boolean requestAccessibilityFocus() {
345         if (mExpanded) {
346             return super.requestAccessibilityFocus();
347         } else {
348             mSnoozeView.requestAccessibilityFocus();
349             return false;
350         }
351     }
352 
logOptionSelection(int category, SnoozeOption option)353     private void logOptionSelection(int category, SnoozeOption option) {
354         int index = mSnoozeOptions.indexOf(option);
355         long duration = TimeUnit.MINUTES.toMillis(option.getMinutesToSnoozeFor());
356         mMetricsLogger.write(new LogMaker(category)
357                 .setType(MetricsEvent.TYPE_ACTION)
358                 .addTaggedData(MetricsEvent.FIELD_NOTIFICATION_SNOOZE_INDEX, index)
359                 .addTaggedData(MetricsEvent.FIELD_NOTIFICATION_SNOOZE_DURATION_MS, duration));
360     }
361 
362     @Override
onClick(View v)363     public void onClick(View v) {
364         if (mGutsContainer != null) {
365             mGutsContainer.resetFalsingCheck();
366         }
367         final int id = v.getId();
368         final SnoozeOption tag = (SnoozeOption) v.getTag();
369         if (tag != null) {
370             setSelected(tag, true);
371         } else if (id == R.id.notification_snooze) {
372             // Toggle snooze options
373             showSnoozeOptions(!mExpanded);
374             mMetricsLogger.write(!mExpanded ? OPTIONS_OPEN_LOG : OPTIONS_CLOSE_LOG);
375         } else {
376             // Undo snooze was selected
377             undoSnooze(v);
378             mMetricsLogger.write(UNDO_LOG);
379         }
380     }
381 
undoSnooze(View v)382     private void undoSnooze(View v) {
383         mSelectedOption = null;
384         showSnoozeOptions(false);
385         mGutsContainer.closeControls(v, false);
386     }
387 
388     @Override
getActualHeight()389     public int getActualHeight() {
390         return mExpanded ? getHeight() : mCollapsedHeight;
391     }
392 
393     @Override
willBeRemoved()394     public boolean willBeRemoved() {
395         return mSnoozing;
396     }
397 
398     @Override
getContentView()399     public View getContentView() {
400         // Reset the view before use
401         setSelected(mDefaultOption, false);
402         return this;
403     }
404 
405     @Override
setGutsParent(NotificationGuts guts)406     public void setGutsParent(NotificationGuts guts) {
407         mGutsContainer = guts;
408     }
409 
410     @Override
handleCloseControls(boolean save, boolean force)411     public boolean handleCloseControls(boolean save, boolean force) {
412         if (mExpanded && !force) {
413             // Collapse expanded state on outside touch
414             showSnoozeOptions(false);
415             return true;
416         } else if (mSnoozeListener != null && mSelectedOption != null) {
417             // Snooze option selected so commit it
418             mSnoozing = true;
419             mSnoozeListener.snooze(mSbn, mSelectedOption);
420             return true;
421         } else {
422             // The view should actually be closed
423             setSelected(mSnoozeOptions.get(0), false);
424             return false; // Return false here so that guts handles closing the view
425         }
426     }
427 
428     @Override
isLeavebehind()429     public boolean isLeavebehind() {
430         return true;
431     }
432 
433     @Override
shouldBeSaved()434     public boolean shouldBeSaved() {
435         return true;
436     }
437 
438     @Override
needsFalsingProtection()439     public boolean needsFalsingProtection() {
440         return false;
441     }
442 
443     public class NotificationSnoozeOption implements SnoozeOption {
444         private SnoozeCriterion mCriterion;
445         private int mMinutesToSnoozeFor;
446         private CharSequence mDescription;
447         private CharSequence mConfirmation;
448         private AccessibilityAction mAction;
449 
NotificationSnoozeOption(SnoozeCriterion sc, int minToSnoozeFor, CharSequence description, CharSequence confirmation, AccessibilityAction action)450         public NotificationSnoozeOption(SnoozeCriterion sc, int minToSnoozeFor,
451                 CharSequence description,
452                 CharSequence confirmation, AccessibilityAction action) {
453             mCriterion = sc;
454             mMinutesToSnoozeFor = minToSnoozeFor;
455             mDescription = description;
456             mConfirmation = confirmation;
457             mAction = action;
458         }
459 
460         @Override
getSnoozeCriterion()461         public SnoozeCriterion getSnoozeCriterion() {
462             return mCriterion;
463         }
464 
465         @Override
getDescription()466         public CharSequence getDescription() {
467             return mDescription;
468         }
469 
470         @Override
getConfirmation()471         public CharSequence getConfirmation() {
472             return mConfirmation;
473         }
474 
475         @Override
getMinutesToSnoozeFor()476         public int getMinutesToSnoozeFor() {
477             return mMinutesToSnoozeFor;
478         }
479 
480         @Override
getAccessibilityAction()481         public AccessibilityAction getAccessibilityAction() {
482             return mAction;
483         }
484 
485     }
486 }
487