Add support for option "rewrite-urls". see #54

Author: Horcrux7

src/com/inet/lib/less/CssFormatter.java

@@ -1,7 +1,7 @@
 /**
  * MIT License (MIT)
  *
- * Copyright (c) 2014 - 2018 Volker Berlin
+ * Copyright (c) 2014 - 2019 Volker Berlin
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -118,7 +118,11 @@ private static class SharedState {
 
     private ReaderFactory                   readerFactory;
 
-    private CssOutput currentOutput;
+    private Map<String, String>             options;
+
+    private int                             rewriteUrl;
+
+    private CssOutput                       currentOutput;
 
     private final static char[]             DIGITS    = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 
@@ -180,10 +184,14 @@ private CssFormatter copy( @Nullable StringBuilder output ) {
      *            A factory for the readers for imports.
      * @param target
      *            the output of the resulting string
+     * @param options
+     *            some optional options, see constants for details
      */
-    void format( LessParser parser, URL baseURL, ReaderFactory readerFactory, StringBuilder target ) {
+    void format( LessParser parser, URL baseURL, ReaderFactory readerFactory, StringBuilder target,  @Nonnull Map<String, String> options ) {
         state.baseURL = baseURL;
         this.readerFactory = readerFactory;
+        this.options = options;
+        this.rewriteUrl = parseRewriteUrl();
         addVariables( parser.getVariables() );
         state.isReference = false;
 
@@ -216,6 +224,26 @@ void format( LessParser parser, URL baseURL, ReaderFactory readerFactory, String
         }
     }
 
+    /**
+     * Parse the parameter rewrite URL
+     * 
+     * @return 0, 1 or 2
+     */
+    private int parseRewriteUrl() {
+        String rewrite = options.get( Less.REWRITE_URLS );
+        if( rewrite != null ) {
+            switch( rewrite.toLowerCase() ) {
+                case "off":
+                    return 0;
+                case "local":
+                    return 1;
+                case "all":
+                    return 2;
+            }
+        }
+        return 0;
+    }
+
     /**
      * Get the formatter for CSS directives.
      * @return the header formatter
@@ -312,6 +340,18 @@ URL getBaseURL() {
         return state.baseURL;
     }
 
+    boolean isRewriteUrl( String url ) {
+        switch( rewriteUrl ) {
+            default:
+            case 0:
+                return false;
+            case 1:
+                return url.startsWith( "." );
+            case 2:
+                return true;
+        }
+    }
+
     /**
      * Get the reader factory.
      * @return the factory

src/com/inet/lib/less/FunctionExpression.java

@@ -54,6 +54,7 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
@@ -239,42 +240,17 @@ public void appendTo( CssFormatter formatter ) {
                     return;
                 case "url":
                     String url = get( 1 ).stringValue( formatter );
-    //                char quoteChar = 0;
-    //                boolean quote = false;
-    //                if( url.length() >= 2 ) {
-    //                    quoteChar = url.charAt( 0 );
-    //                    if( quoteChar == '\'' || quoteChar == '\"' ) {
-    //                        if( url.charAt( url.length() - 1 ) == quoteChar ) {
-    //                            url = url.substring( 1, url.length() - 1 );
-    //                            quote = true;
-    //                        }
-    //                    }
-    //                }
-    //                if( url.startsWith( "../" ) ) {
-    //                    String baseUrl = get( 0 ).stringValue( formatter );
-    //                    baseUrl = baseUrl.substring( 0, baseUrl.lastIndexOf( '/' ) + 1 );
-    //                    boolean append = false;
-    //                    do {
-    //                        if( baseUrl.length() > 0 ) {
-    //                            url = url.substring( 3 );
-    //                            baseUrl = baseUrl.substring( 0, baseUrl.lastIndexOf( '/', baseUrl.length() - 2 ) + 1 );
-    //                            append = true;
-    //                        } else {
-    //                            break;
-    //                        }
-    //                    } while( url.startsWith( "../" ) );
-    //                    if( append ) {
-    //                        url = baseUrl + url;
-    //                    }
-    //                }
+                    String urlStr = UrlUtils.removeQuote( url );
+                    if( formatter.isRewriteUrl( urlStr ) ) {
+                        String relativeUrlStr = get( 0 ).stringValue( formatter );
+                        URL relativeUrl = new URL( "file", null, relativeUrlStr );
+                        relativeUrl = new URL( relativeUrl, urlStr );
+                        boolean quote = url != urlStr;
+                        urlStr = relativeUrl.getPath();
+                        url = quote ? url.charAt( 0 ) + urlStr + url.charAt( 0 ) : urlStr;
+                    }
                     formatter.append( "url(" );
-    //                if( quote ) {
-    //                    formatter.append( quoteChar );
-    //                }
                     formatter.append( url );
-    //                if( quote ) {
-    //                    formatter.append( quoteChar );
-    //                }
                     formatter.append( ")" );
                     return;
                 case "data-uri":

src/com/inet/lib/less/Less.java

@@ -1,7 +1,7 @@
 /**
  * MIT License (MIT)
  *
- * Copyright (c) 2014 - 2016 Volker Berlin
+ * Copyright (c) 2014 - 2019 Volker Berlin
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -32,12 +32,25 @@
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.util.Collections;
+import java.util.Map;
 
 /**
  * The main class of JLessC library. Its contain all start points for converting LESS to CSS files.
  */
 public class Less {
 
+    /**
+     * Key for compress option. true, if the CSS data should be compressed without any extra formating characters.
+     */
+    public static final String COMPRESS     = "compress";
+
+    /**
+     * Rewrites URLs to make them relative to the base less file. 'all' rewrites all URLs, 'local' just those starting
+     * with a '.', 'off' simple inline it.
+     */
+    public static final String REWRITE_URLS = "rewrite-urls";
+
     /**
      * Compile the less data from a string.
      * 
@@ -71,14 +84,55 @@ public static String compile( URL baseURL, String lessData, boolean compress ) t
      *            if any error occur on compiling.
      */
     public static String compile( URL baseURL, String lessData, boolean compress, ReaderFactory readerFactory ) throws LessException {
+        Map<String,String> params = Collections.singletonMap( COMPRESS, Boolean.toString( compress ) );
+        return compile( baseURL, lessData, params, readerFactory );
+    }
+
+    /**
+     * Compile the less data from a string.
+     * 
+     * @param baseURL
+     *            the baseURL for import of external less data.
+     * @param lessData
+     *            the input less data
+     * @param options
+     *            some optional options, see constants for details
+     * @return the resulting less data
+     * @throws LessException 
+     *            if any error occur on compiling.
+     */
+    public static String compile( URL baseURL, String lessData,  Map<String, String> options ) throws LessException {
+        return compile( baseURL, lessData, options, new ReaderFactory() );
+    }
+
+    /**
+     * Compile the less data from a string.
+     * 
+     * @param baseURL
+     *            the baseURL for import of external less data.
+     * @param lessData
+     *            the input less data
+     * @param options
+     *            some optional options, see constants for details
+     * @param readerFactory
+     *            A factory for the readers for imports.
+     * @return the resulting less data
+     * @throws LessException
+     *             if any error occur on compiling.
+     */
+    public static String compile( URL baseURL, String lessData, Map<String, String> options, ReaderFactory readerFactory ) throws LessException {
         try {
+            if( options == null ) {
+                options = Collections.emptyMap();
+            }
             LessParser parser = new LessParser();
             parser.parse( baseURL, new StringReader( lessData ), readerFactory );
-            
-            StringBuilder builder = new StringBuilder();
-            CssFormatter formatter = compress ? new CompressCssFormatter() :  new CssFormatter();
+
+            boolean compress = Boolean.parseBoolean( options.get( COMPRESS ) );
+            CssFormatter formatter = compress ? new CompressCssFormatter() : new CssFormatter();
             parser.parseLazy( formatter );
-            formatter.format( parser, baseURL, readerFactory, builder );
+            StringBuilder builder = new StringBuilder();
+            formatter.format( parser, baseURL, readerFactory, builder, options );
             return builder.toString();
         } catch( LessException ex ) {
             throw ex;

src/com/inet/lib/less/UrlUtils.java

@@ -1,7 +1,7 @@
 /**
  * MIT License (MIT)
  *
- * Copyright (c) 2014 - 2015 Volker Berlin
+ * Copyright (c) 2014 - 2019 Volker Berlin
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -163,20 +163,40 @@ static double getColor( Expression param, CssFormatter formatter ) throws LessEx
      * Implementation of the function data-uri.
      * 
      * @param formatter current formatter
-     * @param relativeURL relative URL of the less script. Is used as base URL
+     * @param relativeUrlStr relative URL of the less script. Is used as base URL
      * @param urlString the url parameter of the function
      * @param type the mime type
      * @throws IOException If any I/O errors occur on reading the content
      */
-    static void dataUri( CssFormatter formatter, String relativeURL, final String urlString, String type ) throws IOException {
-        URL url = new URL( formatter.getBaseURL(), relativeURL );
+    static void dataUri( CssFormatter formatter, String relativeUrlStr, final String urlString, String type ) throws IOException {
+        URL url = formatter.getBaseURL();
         String urlStr = removeQuote( urlString );
-        url = new URL( url, urlStr );
         InputStream input;
+        url = new URL( url, urlStr );
         try {
-            input = formatter.getReaderFactory().openStream( url );
+            try {
+                input = formatter.getReaderFactory().openStream( url );
+            } catch( Exception e ) {
+                // try rewrite location if option "rewrite-urls" is "all" or "local" 
+                if( formatter.isRewriteUrl( "." ) ) {
+                    url = new URL( new URL( formatter.getBaseURL(), relativeUrlStr ), urlStr );
+                    input = formatter.getReaderFactory().openStream( url );
+                } else {
+                    throw e;
+                }
+            }
         } catch( Exception e ) {
-            formatter.append( "url(" ).append( urlString ).append( ')' );
+            boolean quote = urlString != urlStr;
+            String rewrittenUrl;
+            if( formatter.isRewriteUrl( urlStr ) ) {
+                URL relativeUrl = new URL( relativeUrlStr );
+                relativeUrl = new URL( relativeUrl, urlStr );
+                rewrittenUrl = relativeUrl.getPath();
+                rewrittenUrl = quote ? urlString.charAt( 0 ) + rewrittenUrl + urlString.charAt( 0 ) : rewrittenUrl;
+            } else {
+                rewrittenUrl = urlString;
+            }
+            formatter.append( "url(" ).append( rewrittenUrl ).append( ')' );
             return;
         }
         ByteArrayOutputStream buffer = new ByteArrayOutputStream();

test/com/inet/lib/less/RewriteUrls.java

@@ -0,0 +1,69 @@
+/**
+ * MIT License (MIT)
+ *
+ * Copyright (c) 2019 Volker Berlin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * UT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author Volker Berlin
+ * @license: The MIT license <http://opensource.org/licenses/MIT>
+ */
+package com.inet.lib.less;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.HashMap;
+import java.util.Scanner;
+
+import org.junit.Test;
+
+public class RewriteUrls {
+
+    private void test( String rewriteUrl ) throws IOException {
+        Less less = new Less();
+
+        URL baseURL = getClass().getResource( "RewriteUrls/main.less" );
+
+        String lessData = new Scanner( baseURL.openStream(), "UTF-8" ).useDelimiter( "\\A" ).next();
+
+        HashMap<String, String> options = new HashMap<>();
+        options.put( Less.REWRITE_URLS, rewriteUrl );
+
+        String expectedCss = new Scanner( new URL( baseURL, rewriteUrl + ".css" ).openStream(), "UTF-8" ).useDelimiter( "\\A" ).next();;
+
+        assertEquals( expectedCss, less.compile( baseURL, lessData, options ) );
+    }
+
+    @Test
+    public void off() throws IOException {
+        test( "off" );
+    }
+
+    @Test
+    public void local() throws IOException {
+        test( "local" );
+    }
+
+    @Test
+    public void all() throws IOException {
+        test( "all" );
+    }
+}

test/com/inet/lib/less/RewriteUrls/all.css

@@ -0,0 +1,16 @@
+.rule2 {
+  url1: url('subfolder1/image.jpg');
+  url2: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url3: url('subfolder1/subfolder2/subfolder1/image.jpg');
+  url4: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url5: url('subfolder1/DoesNotExists.jpg');
+  url4: url('subfolder1/subfolder2/subfolder1/DoesNotExists.jpg');
+}
+.rule1 {
+  url1: url('subfolder1/image.jpg');
+  url2: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url3: url('subfolder1/subfolder1/image.jpg');
+  url4: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url5: url('subfolder1/DoesNotExists.jpg');
+  url4: url('subfolder1/subfolder1/DoesNotExists.jpg');
+}

test/com/inet/lib/less/RewriteUrls/local.css

@@ -0,0 +1,16 @@
+.rule2 {
+  url1: url('subfolder1/image.jpg');
+  url2: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url3: url('subfolder1/image.jpg');
+  url4: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url5: url('subfolder1/DoesNotExists.jpg');
+  url4: url('subfolder1/DoesNotExists.jpg');
+}
+.rule1 {
+  url1: url('image.jpg');
+  url2: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url3: url('subfolder1/image.jpg');
+  url4: url("data:image/jpeg;base64,bm90IGFjdHVhbGx5IGEganBlZyBmaWxlCg==");
+  url5: url('DoesNotExists.jpg');
+  url4: url('subfolder1/DoesNotExists.jpg');
+}