001package org.apache.maven.cli;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.IOException;
023import java.io.InputStream;
024import java.util.Date;
025import java.util.Locale;
026import java.util.Properties;
027import java.util.TimeZone;
028
029import org.codehaus.plexus.util.IOUtil;
030import org.codehaus.plexus.util.Os;
031import org.slf4j.Logger;
032
033/**
034 * Utility class used to report errors, statistics, application version info, etc.
035 *
036 * @author jdcasey
037 *
038 */
039public final class CLIReportingUtils
040{
041
042    public static final long MB = 1024 * 1024;
043
044    private static final long ONE_SECOND = 1000L;
045    private static final long ONE_MINUTE = 60 * ONE_SECOND;
046    private static final long ONE_HOUR = 60 * ONE_MINUTE;
047    private static final long ONE_DAY = 24 * ONE_HOUR;
048
049    public static final String BUILD_VERSION_PROPERTY = "version";
050
051    public static String showVersion()
052    {
053        final String LS = System.getProperty( "line.separator" );
054        Properties properties = getBuildProperties();
055        StringBuilder version = new StringBuilder();
056        version.append( createMavenVersionString( properties ) ).append( LS );
057        version.append( reduce( properties.getProperty( "distributionShortName" ) + " home: "
058                            + System.getProperty( "maven.home", "<unknown maven home>" ) ) ).append( LS );
059        version.append( "Java version: " ).append(
060            System.getProperty( "java.version", "<unknown java version>" ) ).append( ", vendor: " ).append(
061            System.getProperty( "java.vendor", "<unknown vendor>" ) ).append( LS );
062        version.append( "Java home: " ).append( System.getProperty( "java.home", "<unknown java home>" ) ).append( LS );
063        version.append( "Default locale: " ).append( Locale.getDefault() ).append( ", platform encoding: " ).append(
064            System.getProperty( "file.encoding", "<unknown encoding>" ) ).append( LS );
065        version.append( "OS name: \"" ).append( Os.OS_NAME ).append( "\", version: \"" ).append( Os.OS_VERSION ).append(
066            "\", arch: \"" ).append( Os.OS_ARCH ).append( "\", family: \"" ).append( Os.OS_FAMILY ).append( "\"" );
067        return version.toString();
068    }
069
070    /**
071     * Create a human readable string containing the Maven version, buildnumber, and time of build
072     *
073     * @param buildProperties The build properties
074     * @return Readable build info
075     */
076    static String createMavenVersionString( Properties buildProperties )
077    {
078        String timestamp = reduce( buildProperties.getProperty( "timestamp" ) );
079        String version = reduce( buildProperties.getProperty( BUILD_VERSION_PROPERTY ) );
080        String rev = reduce( buildProperties.getProperty( "buildNumber" ) );
081        String distributionName = reduce( buildProperties.getProperty( "distributionName" ) );
082
083        String msg = distributionName + " ";
084        msg += ( version != null ? version : "<version unknown>" );
085        if ( rev != null || timestamp != null )
086        {
087            msg += " (";
088            msg += ( rev != null ? rev : "" );
089            if ( timestamp != null )
090            {
091                String ts = formatTimestamp( Long.valueOf( timestamp ) );
092                msg += ( rev != null ? "; " : "" ) + ts;
093            }
094            msg += ")";
095        }
096        return msg;
097    }
098
099    private static String reduce( String s )
100    {
101        return ( s != null ? ( s.startsWith( "${" ) && s.endsWith( "}" ) ? null : s ) : null );
102    }
103
104    static Properties getBuildProperties()
105    {
106        Properties properties = new Properties();
107        InputStream resourceAsStream = null;
108        try
109        {
110            resourceAsStream = MavenCli.class.getResourceAsStream( "/org/apache/maven/messages/build.properties" );
111
112            if ( resourceAsStream != null )
113            {
114                properties.load( resourceAsStream );
115            }
116        }
117        catch ( IOException e )
118        {
119            System.err.println( "Unable determine version from JAR file: " + e.getMessage() );
120        }
121        finally
122        {
123            IOUtil.close( resourceAsStream );
124        }
125
126        return properties;
127    }
128
129    public static void showError( Logger logger, String message, Throwable e, boolean showStackTrace )
130    {
131        if ( showStackTrace )
132        {
133            logger.error( message, e );
134        }
135        else
136        {
137            logger.error( message );
138
139            if ( e != null )
140            {
141                logger.error( e.getMessage() );
142
143                for ( Throwable cause = e.getCause(); cause != null; cause = cause.getCause() )
144                {
145                    logger.error( "Caused by: " + cause.getMessage() );
146                }
147            }
148        }
149    }
150
151    public static String formatTimestamp( long timestamp )
152    {
153        // Manual construction of the tz offset because only Java 7 is aware of ISO 8601 time zones
154        TimeZone tz = TimeZone.getDefault();
155        int offset = tz.getRawOffset();
156
157        // Raw offset ignores DST, so check if we are in DST now and add the offset
158        if ( tz.inDaylightTime( new Date( timestamp ) ) )
159        {
160            offset += tz.getDSTSavings();
161        }
162
163        long m = Math.abs( ( offset / ONE_MINUTE ) % 60 );
164        long h = Math.abs( ( offset / ONE_HOUR ) % 24 );
165
166        int offsetDir = (int) Math.signum( (float) offset );
167        char offsetSign = offsetDir >= 0 ? '+' : '-';
168        return String.format( "%tFT%<tT%s%02d:%02d", timestamp, offsetSign, h, m );
169    }
170
171    public static String formatDuration( long duration )
172    {
173        long ms = duration % 1000;
174        long s = ( duration / ONE_SECOND ) % 60;
175        long m = ( duration / ONE_MINUTE ) % 60;
176        long h = ( duration / ONE_HOUR ) % 24;
177        long d = duration / ONE_DAY;
178
179        String format;
180        if ( d > 0 )
181        {
182            format = "%d d %02d:%02d h";
183        }
184        else if ( h > 0 )
185        {
186            format = "%2$02d:%3$02d h";
187        }
188        else if ( m > 0 )
189        {
190            format = "%3$02d:%4$02d min";
191        }
192        else
193        {
194            format = "%4$d.%5$03d s";
195        }
196
197        return String.format( format, d, h, m, s, ms );
198    }
199
200}