View Javadoc
1   package org.apache.maven.cli;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  import java.io.InputStream;
24  import java.util.Date;
25  import java.util.Locale;
26  import java.util.Properties;
27  import java.util.TimeZone;
28  
29  import org.codehaus.plexus.util.IOUtil;
30  import org.codehaus.plexus.util.Os;
31  import org.slf4j.Logger;
32  
33  /**
34   * Utility class used to report errors, statistics, application version info, etc.
35   *
36   * @author jdcasey
37   *
38   */
39  public final class CLIReportingUtils
40  {
41      // CHECKSTYLE_OFF: MagicNumber
42      public static final long MB = 1024 * 1024;
43  
44      private static final long ONE_SECOND = 1000L;
45      private static final long ONE_MINUTE = 60 * ONE_SECOND;
46      private static final long ONE_HOUR = 60 * ONE_MINUTE;
47      private static final long ONE_DAY = 24 * ONE_HOUR;
48      // CHECKSTYLE_ON: MagicNumber
49  
50      public static final String BUILD_VERSION_PROPERTY = "version";
51  
52      public static String showVersion()
53      {
54          final String ls = System.getProperty( "line.separator" );
55          Properties properties = getBuildProperties();
56          StringBuilder version = new StringBuilder();
57          version.append( createMavenVersionString( properties ) ).append( ls );
58          version.append( reduce( properties.getProperty( "distributionShortName" ) + " home: "
59                              + System.getProperty( "maven.home", "<unknown maven home>" ) ) ).append( ls );
60          version.append( "Java version: " ).append(
61              System.getProperty( "java.version", "<unknown java version>" ) ).append( ", vendor: " ).append(
62              System.getProperty( "java.vendor", "<unknown vendor>" ) ).append( ls );
63          version.append( "Java home: " ).append( System.getProperty( "java.home", "<unknown java home>" ) ).append( ls );
64          version.append( "Default locale: " ).append( Locale.getDefault() ).append( ", platform encoding: " ).append(
65              System.getProperty( "file.encoding", "<unknown encoding>" ) ).append( ls );
66          version.append( "OS name: \"" ).append( Os.OS_NAME ).append( "\", version: \"" ).append( Os.OS_VERSION ).append(
67              "\", arch: \"" ).append( Os.OS_ARCH ).append( "\", family: \"" ).append( Os.OS_FAMILY ).append( "\"" );
68          return version.toString();
69      }
70  
71      /**
72       * Create a human readable string containing the Maven version, buildnumber, and time of build
73       *
74       * @param buildProperties The build properties
75       * @return Readable build info
76       */
77      static String createMavenVersionString( Properties buildProperties )
78      {
79          String timestamp = reduce( buildProperties.getProperty( "timestamp" ) );
80          String version = reduce( buildProperties.getProperty( BUILD_VERSION_PROPERTY ) );
81          String rev = reduce( buildProperties.getProperty( "buildNumber" ) );
82          String distributionName = reduce( buildProperties.getProperty( "distributionName" ) );
83  
84          String msg = distributionName + " ";
85          msg += ( version != null ? version : "<version unknown>" );
86          if ( rev != null || timestamp != null )
87          {
88              msg += " (";
89              msg += ( rev != null ? rev : "" );
90              if ( timestamp != null )
91              {
92                  String ts = formatTimestamp( Long.valueOf( timestamp ) );
93                  msg += ( rev != null ? "; " : "" ) + ts;
94              }
95              msg += ")";
96          }
97          return msg;
98      }
99  
100     private static String reduce( String s )
101     {
102         return ( s != null ? ( s.startsWith( "${" ) && s.endsWith( "}" ) ? null : s ) : null );
103     }
104 
105     static Properties getBuildProperties()
106     {
107         Properties properties = new Properties();
108         InputStream resourceAsStream = null;
109         try
110         {
111             resourceAsStream = MavenCli.class.getResourceAsStream( "/org/apache/maven/messages/build.properties" );
112 
113             if ( resourceAsStream != null )
114             {
115                 properties.load( resourceAsStream );
116             }
117         }
118         catch ( IOException e )
119         {
120             System.err.println( "Unable determine version from JAR file: " + e.getMessage() );
121         }
122         finally
123         {
124             IOUtil.close( resourceAsStream );
125         }
126 
127         return properties;
128     }
129 
130     public static void showError( Logger logger, String message, Throwable e, boolean showStackTrace )
131     {
132         if ( showStackTrace )
133         {
134             logger.error( message, e );
135         }
136         else
137         {
138             logger.error( message );
139 
140             if ( e != null )
141             {
142                 logger.error( e.getMessage() );
143 
144                 for ( Throwable cause = e.getCause(); cause != null; cause = cause.getCause() )
145                 {
146                     logger.error( "Caused by: " + cause.getMessage() );
147                 }
148             }
149         }
150     }
151 
152     public static String formatTimestamp( long timestamp )
153     {
154         // Manual construction of the tz offset because only Java 7 is aware of ISO 8601 time zones
155         TimeZone tz = TimeZone.getDefault();
156         int offset = tz.getRawOffset();
157 
158         // Raw offset ignores DST, so check if we are in DST now and add the offset
159         if ( tz.inDaylightTime( new Date( timestamp ) ) )
160         {
161             offset += tz.getDSTSavings();
162         }
163 
164         // CHECKSTYLE_OFF: MagicNumber
165         long m = Math.abs( ( offset / ONE_MINUTE ) % 60 );
166         long h = Math.abs( ( offset / ONE_HOUR ) % 24 );
167         // CHECKSTYLE_ON: MagicNumber
168 
169         int offsetDir = (int) Math.signum( (float) offset );
170         char offsetSign = offsetDir >= 0 ? '+' : '-';
171         return String.format( "%tFT%<tT%s%02d:%02d", timestamp, offsetSign, h, m );
172     }
173 
174     public static String formatDuration( long duration )
175     {
176         // CHECKSTYLE_OFF: MagicNumber
177         long ms = duration % 1000;
178         long s = ( duration / ONE_SECOND ) % 60;
179         long m = ( duration / ONE_MINUTE ) % 60;
180         long h = ( duration / ONE_HOUR ) % 24;
181         long d = duration / ONE_DAY;
182         // CHECKSTYLE_ON: MagicNumber
183 
184         String format;
185         if ( d > 0 )
186         {
187             format = "%d d %02d:%02d h";
188         }
189         else if ( h > 0 )
190         {
191             format = "%2$02d:%3$02d h";
192         }
193         else if ( m > 0 )
194         {
195             format = "%3$02d:%4$02d min";
196         }
197         else
198         {
199             format = "%4$d.%5$03d s";
200         }
201 
202         return String.format( format, d, h, m, s, ms );
203     }
204 
205 }