Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.apache.catalina.ssi;
 
 
 import static org.jboss.web.CatalinaMessages.MESSAGES;
 
 import java.util.Date;
 import java.util.Set;
Allows the different SSICommand implementations to share data/talk to each other

Author(s):
Bip Thelin
Amy Roh
Paul Speed
Dan Sandberg
David Becker
Version:
$Revision: 1473 $, $Date: 2010-05-17 19:46:58 +0200 (Mon, 17 May 2010) $
 
 public class SSIMediator {
     protected final static String DEFAULT_CONFIG_ERR_MSG = .ssiDirectiveError();
     protected final static String DEFAULT_CONFIG_TIME_FMT = "%A, %d-%b-%Y %T %Z";
     protected final static String DEFAULT_CONFIG_SIZE_FMT = "abbrev";
     protected static URLEncoder urlEncoder;
     protected String configErrMsg = ;
     protected String className = getClass().getName();
     protected long lastModifiedDate;
     protected int debug;
     protected Strftime strftime;
     static {
         //We try to encode only the same characters that apache does
          = new URLEncoder();
         .addSafeCharacter(',');
         .addSafeCharacter(':');
         .addSafeCharacter('-');
         .addSafeCharacter('_');
         .addSafeCharacter('.');
         .addSafeCharacter('*');
         .addSafeCharacter('/');
         .addSafeCharacter('!');
         .addSafeCharacter('~');
         .addSafeCharacter('\'');
         .addSafeCharacter('(');
         .addSafeCharacter(')');
     }
 
 
     public SSIMediator(SSIExternalResolver ssiExternalResolver,
             long lastModifiedDateint debug) {
         this. = ssiExternalResolver;
         this. = lastModifiedDate;
         this. = debug;
         setConfigTimeFmt(true);
     }
 
 
     public void setConfigErrMsg(String configErrMsg) {
         this. = configErrMsg;
     }
 
 
     public void setConfigTimeFmt(String configTimeFmt) {
         setConfigTimeFmt(configTimeFmtfalse);
     }
 
 
     public void setConfigTimeFmt(String configTimeFmtboolean fromConstructor) {
         this. = configTimeFmt;
         //What's the story here with DateTool.LOCALE_US?? Why??
        this. = new Strftime(configTimeFmt.);
        //Variables like DATE_LOCAL, DATE_GMT, and LAST_MODIFIED need to be
        // updated when
        //the timefmt changes. This is what Apache SSI does.
        setDateVariables(fromConstructor);
    }
    public void setConfigSizeFmt(String configSizeFmt) {
        this. = configSizeFmt;
    }
    public String getConfigErrMsg() {
        return ;
    }
    public String getConfigTimeFmt() {
        return ;
    }
    public String getConfigSizeFmt() {
        return ;
    }
        return ;
    }
    public Collection getVariableNames() {
        Set variableNames = new HashSet();
        //These built-in variables are supplied by the mediator ( if not
        // over-written by
        // the user ) and always exist
        variableNames.add("DATE_GMT");
        variableNames.add("DATE_LOCAL");
        variableNames.add("LAST_MODIFIED");
        .addVariableNames(variableNames);
        //Remove any variables that are reserved by this class
        Iterator iter = variableNames.iterator();
        while (iter.hasNext()) {
            String name = (String)iter.next();
            if (isNameReserved(name)) {
                iter.remove();
            }
        }
        return variableNames;
    }
    public long getFileSize(String pathboolean virtualthrows IOException {
        return .getFileSize(pathvirtual);
    }
    public long getFileLastModified(String pathboolean virtual)
            throws IOException {
        return .getFileLastModified(pathvirtual);
    }
    public String getFileText(String pathboolean virtualthrows IOException {
        return .getFileText(pathvirtual);
    }
    protected boolean isNameReserved(String name) {
        return name.startsWith( + ".");
    }
    public String getVariableValue(String variableName) {
        return getVariableValue(variableName"none");
    }
    public void setVariableValue(String variableNameString variableValue) {
        if (!isNameReserved(variableName)) {
            .setVariableValue(variableNamevariableValue);
        }
    }
    public String getVariableValue(String variableNameString encoding) {
        String lowerCaseVariableName = variableName.toLowerCase(.);
        String variableValue = null;
        if (!isNameReserved(lowerCaseVariableName)) {
            //Try getting it externally first, if it fails, try getting the
            // 'built-in'
            // value
            variableValue = .getVariableValue(variableName);
            if (variableValue == null) {
                variableName = variableName.toUpperCase(.);
                variableValue = (String)
                        .getVariableValue( + "." + variableName);
            }
            if (variableValue != null) {
                variableValue = encode(variableValueencoding);
            }
        }
        return variableValue;
    }


    
Applies variable substitution to the specified String and returns the new resolved string.
    public String substituteVariables(String val) {
        // If it has no references or HTML entities then no work
        // need to be done
        if (val.indexOf('$') < 0 && val.indexOf('&') < 0) return val;
        
        // HTML decoding
        val = val.replace("&lt;""<");
        val = val.replace("&gt;"">");
        val = val.replace("&quot;""\"");
        val = val.replace("&amp;""&");
        StringBuilder sb = new StringBuilder(val);
        int charStart = sb.indexOf("&#");
        while (charStart > -1) {
            int charEnd = sb.indexOf(";"charStart);
            if (charEnd > -1) {
                char c = (char) Integer.parseInt(
                        sb.substring(charStart + 2, charEnd));
                sb.delete(charStartcharEnd + 1);
                sb.insert(charStartc);
                charStart = sb.indexOf("&#");
            } else {
                break;
            }
        }
        for (int i = 0; i < sb.length();) {
            // Find the next $
            for (; i < sb.length(); i++) {
                if (sb.charAt(i) == '$') {
                    i++;
                    break;
                }
            }
            if (i == sb.length()) break;
            // Check to see if the $ is escaped
            if (i > 1 && sb.charAt(i - 2) == '\\') {
                sb.deleteCharAt(i - 2);
                i--;
                continue;
            }
            int nameStart = i;
            int start = i - 1;
            int end = -1;
            int nameEnd = -1;
            char endChar = ' ';
            // Check for {} wrapped var
            if (sb.charAt(i) == '{') {
                nameStart++;
                endChar = '}';
            }
            // Find the end of the var reference
            for (; i < sb.length(); i++) {
                if (sb.charAt(i) == endCharbreak;
            }
            end = i;
            nameEnd = end;
            if (endChar == '}'end++;
            // We should now have enough to extract the var name
            String varName = sb.substring(nameStartnameEnd);
            String value = getVariableValue(varName);
            if (value == nullvalue = "";
            // Replace the var name with its value
            sb.replace(startendvalue);
            // Start searching for the next $ after the value
            // that was just substituted.
            i = start + value.length();
        }
        return sb.toString();
    }
    protected String formatDate(Date dateTimeZone timeZone) {
        String retVal;
        if (timeZone != null) {
            //we temporarily change strftime. Since SSIMediator is inherently
            // single-threaded, this
            //isn't a problem
            TimeZone oldTimeZone = .getTimeZone();
            .setTimeZone(timeZone);
            retVal = .format(date);
            .setTimeZone(oldTimeZone);
        } else {
            retVal = .format(date);
        }
        return retVal;
    }
    protected String encode(String valueString encoding) {
        String retVal = null;
        if (encoding.equalsIgnoreCase("url")) {
            retVal = .encode(value);
        } else if (encoding.equalsIgnoreCase("none")) {
            retVal = value;
        } else if (encoding.equalsIgnoreCase("entity")) {
            retVal = HttpMessages.filter(value);
        } else {
            //This shouldn't be possible
            throw new IllegalArgumentException(.ssiUnknownEncoding(encoding));
        }
        return retVal;
    }
    public void log(String message) {
        .log(messagenull);
    }
    public void log(String messageThrowable throwable) {
        .log(messagethrowable);
    }
    protected void setDateVariables(boolean fromConstructor) {
        boolean alreadySet = .getVariableValue(
                + ".alreadyset") != null;
        //skip this if we are being called from the constructor, and this has
        // already
        // been set
        if (!(fromConstructor && alreadySet)) {
            .setVariableValue( + ".alreadyset",
                    "true");
            Date date = new Date();
            TimeZone timeZone = TimeZone.getTimeZone("GMT");
            String retVal = formatDate(datetimeZone);
            //If we are setting on of the date variables, we want to remove
            // them from the
            // user
            //defined list of variables, because this is what Apache does
            setVariableValue("DATE_GMT"null);
            .setVariableValue( + ".DATE_GMT",
                    retVal);
            retVal = formatDate(datenull);
            setVariableValue("DATE_LOCAL"null);
            .setVariableValue( + ".DATE_LOCAL",
                    retVal);
            retVal = formatDate(new Date(), null);
            setVariableValue("LAST_MODIFIED"null);
            .setVariableValue( + ".LAST_MODIFIED",
                    retVal);
        }
    }
New to GrepCode? Check out our FAQ X