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.text.SimpleDateFormat;
025import java.util.Date;
026import java.util.Locale;
027import java.util.Properties;
028import java.util.TimeZone;
029
030import org.codehaus.plexus.util.IOUtil;
031import org.codehaus.plexus.util.Os;
032import org.slf4j.Logger;
033
034/**
035 * Utility class used to report errors, statistics, application version info, etc.
036 *
037 * @author jdcasey
038 *
039 */
040public final class CLIReportingUtils
041{
042
043    public static final long MB = 1024 * 1024;
044
045    private static final long ONE_SECOND = 1000L;
046    private static final long ONE_MINUTE = 60 * ONE_SECOND;
047    private static final long ONE_HOUR = 60 * ONE_MINUTE;
048    private static final long ONE_DAY = 24 * ONE_HOUR;
049
050    public static final String BUILD_VERSION_PROPERTY = "version";
051
052    public static String showVersion()
053    {
054        final String LS = System.getProperty( "line.separator" );
055        Properties properties = getBuildProperties();
056        StringBuilder version = new StringBuilder();
057        version.append( createMavenVersionString( properties ) ).append( LS );
058        version.append( reduce( properties.getProperty( "distributionShortName" ) + " home: "
059                            + System.getProperty( "maven.home", "<unknown maven home>" ) ) ).append( LS );
060        version.append( "Java version: " ).append(
061            System.getProperty( "java.version", "<unknown java version>" ) ).append( ", vendor: " ).append(
062            System.getProperty( "java.vendor", "<unknown vendor>" ) ).append( LS );
063        version.append( "Java home: " ).append( System.getProperty( "java.home", "<unknown java home>" ) ).append( LS );
064        version.append( "Default locale: " ).append( Locale.getDefault() ).append( ", platform encoding: " ).append(
065            System.getProperty( "file.encoding", "<unknown encoding>" ) ).append( LS );
066        version.append( "OS name: \"" ).append( Os.OS_NAME ).append( "\", version: \"" ).append( Os.OS_VERSION ).append(
067            "\", arch: \"" ).append( Os.OS_ARCH ).append( "\", family: \"" ).append( Os.OS_FAMILY ).append( "\"" );
068        return version.toString();
069    }
070
071    /**
072     * Create a human readable string containing the Maven version, buildnumber, and time of build
073     *
074     * @param buildProperties The build properties
075     * @return Readable build info
076     */
077    static String createMavenVersionString( Properties buildProperties )
078    {
079        String timestamp = reduce( buildProperties.getProperty( "timestamp" ) );
080        String version = reduce( buildProperties.getProperty( BUILD_VERSION_PROPERTY ) );
081        String rev = reduce( buildProperties.getProperty( "buildNumber" ) );
082        String distributionName = reduce( buildProperties.getProperty( "distributionName" ) );
083
084        String msg = distributionName + " ";
085        msg += ( version != null ? version : "<version unknown>" );
086        if ( rev != null || timestamp != null )
087        {
088            msg += " (";
089            msg += ( rev != null ? rev : "" );
090            if ( timestamp != null )
091            {
092                String ts = formatTimestamp( Long.valueOf( timestamp ) );
093                msg += ( rev != null ? "; " : "" ) + ts;
094            }
095            msg += ")";
096        }
097        return msg;
098    }
099
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 understands 'ZZ' replacement
155        TimeZone tz = TimeZone.getDefault();
156        int offset = tz.getRawOffset();
157
158        long m = Math.abs( ( offset / ONE_MINUTE ) % 60 );
159        long h = Math.abs( ( offset / ONE_HOUR ) % 24 );
160
161        int offsetDir = (int) Math.signum( (float) offset );
162        char offsetSign = offsetDir >= 0 ? '+' : '-';
163        return String.format( "%tFT%<tT%s%02d:%02d", timestamp, offsetSign, h, m );
164    }
165
166    public static String formatDuration( long duration )
167    {
168        long ms = duration % 1000;
169        long s = ( duration / ONE_SECOND ) % 60;
170        long m = ( duration / ONE_MINUTE ) % 60;
171        long h = ( duration / ONE_HOUR ) % 24;
172        long d = duration / ONE_DAY;
173
174        String format;
175        if ( d > 0 )
176        {
177            format = "%d d %02d:%02d h";
178        }
179        else if ( h > 0 )
180        {
181            format = "%2$02d:%3$02d h";
182        }
183        else if ( m > 0 )
184        {
185            format = "%3$02d:%4$02d min";
186        }
187        else
188        {
189            format = "%4$d.%5$03d s";
190        }
191
192        return String.format( format, d, h, m, s, ms );
193    }
194
195}