View Javadoc
1   /**
2    * This file Copyright (c) 2020 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.framework.util;
35  
36  import info.magnolia.cms.security.MgnlUserManager;
37  import info.magnolia.cms.security.User;
38  
39  import java.time.Instant;
40  import java.time.ZoneId;
41  import java.util.Date;
42  import java.util.Locale;
43  import java.util.Optional;
44  import java.util.TimeZone;
45  
46  import org.apache.commons.lang3.StringUtils;
47  
48  /**
49   * Convenience class for getting current user configuration. Mostly for timezone related info.
50   */
51  public final class TimezoneUtil {
52  
53      public static Locale getUserLocale(User user) {
54          return Optional.ofNullable(user.getProperty(MgnlUserManager.PROPERTY_LANGUAGE))
55                  .filter(StringUtils::isNotBlank)
56                  .map(lang -> StringUtils.substringBefore(lang, "_"))
57                  .map(Locale::new)
58                  .orElse(Locale.getDefault());
59      }
60  
61      public static ZoneId getUserZoneId(User user) {
62          return getTimezonePropertyValue(user)
63                  .map(ZoneId::of)
64                  .orElse(ZoneId.systemDefault());
65      }
66  
67      public static TimeZone getUserTimezone(User user) {
68          return getTimezonePropertyValue(user)
69                  .map(TimeZone::getTimeZone)
70                  .orElse(TimeZone.getDefault());
71      }
72  
73      /**
74       * Render short or long info string for current time zone of the form:
75       * info (zoneId)
76       */
77      public static String getTimeZoneInfo(User user, int style) {
78          return getUserTimezone(user).getDisplayName(isUsersZoneInDST(user), style, getUserLocale(user))
79                  + " (" + getUserZoneId(user).getId() + ")";
80      }
81  
82      private static Optional<String> getTimezonePropertyValue(User user) {
83          return Optional.ofNullable(user.getProperty(MgnlUserManager.PROPERTY_TIMEZONE))
84                  .filter(StringUtils::isNotEmpty);
85      }
86  
87      private static boolean isUsersZoneInDST(User user) {
88          return getUserTimezone(user).inDaylightTime(Date.from(Instant.now()));
89      }
90  }