/* 
    P/P   *  Method: org.apache.roller.weblogger.business.AbstractURLStrategy__static_init
          */
     1  /*
     2   * Licensed to the Apache Software Foundation (ASF) under one or more
     3   *  contributor license agreements.  The ASF licenses this file to You
     4   * under the Apache License, Version 2.0 (the "License"); you may not
     5   * use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.  For additional information regarding
    15   * copyright in this work, please see the NOTICE file in the top level
    16   * directory of this distribution.
    17   */
    18  
    19  package org.apache.roller.weblogger.business;
    20  
    21  import java.util.HashMap;
    22  import java.util.Map;
    23  import org.apache.roller.weblogger.config.WebloggerRuntimeConfig;
    24  import org.apache.roller.weblogger.util.URLUtilities;
    25  
    26  
    27  /**
    28   * An abstract Weblogger URLStrategy which implements some of the url methods
    29   * which are not likely to change for any alternate url strategies.
    30   */
    31  public abstract class AbstractURLStrategy implements URLStrategy {
    32      
             /* 
    P/P       *  Method: void org.apache.roller.weblogger.business.AbstractURLStrategy()
              */
    33      public AbstractURLStrategy() {}
    34      
    35      
    36      /**
    37       * Url to login page.
    38       */
    39      public String getLoginURL(boolean absolute) {
    40          
                 /* 
    P/P           *  Method: String getLoginURL(bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuffer:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuffer:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
    41          StringBuffer url = new StringBuffer();
    42          
    43          if(absolute) {
    44              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
    45          } else {
    46              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
    47          }
    48          
    49          url.append("/roller-ui/login-redirect.rol");
    50          
    51          return url.toString();
    52      }
    53      
    54      
    55      /**
    56       * Url to logout page.
    57       */
    58      public String getLogoutURL(boolean absolute) {
    59          
                 /* 
    P/P           *  Method: String getLogoutURL(bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuffer:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuffer:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
    60          StringBuffer url = new StringBuffer();
    61          
    62          if(absolute) {
    63              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
    64          } else {
    65              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
    66          }
    67          
    68          url.append("/roller-ui/logout.rol");
    69          
    70          return url.toString();
    71      }
    72      
    73      
    74      /**
    75       * Get a url to a UI action in a given namespace, optionally specifying
    76       * a weblogHandle parameter if that is needed by the action.
    77       */
    78      public String getActionURL(String action,
    79                                              String namespace,
    80                                              String weblogHandle,
    81                                              Map<String, String> parameters,
    82                                              boolean absolute) {
    83          
                 /* 
    P/P           *  Method: String getActionURL(String, String, String, Map, bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuffer:toString(...)._tainted)
                  *    init'ed(java.lang.StringBuilder:toString(...)._tainted)
                  *    return_value in Addr_Set{&java.lang.StringBuffer:toString(...),&java.lang.StringBuilder:toString(...)}
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  *    parameters: Addr_Set{null}, Inverse{null}
                  *    weblogHandle: Addr_Set{null}, Inverse{null}
                  *    java.util.Map:isEmpty(...)@106: {1}, {0}
                  */
    84          StringBuffer url = new StringBuffer();
    85          
    86          if(absolute) {
    87              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
    88          } else {
    89              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
    90          }
    91          
    92          url.append(namespace);
    93          url.append("/").append(action).append(".rol");
    94          
    95          // put weblog handle parameter, if necessary
    96          Map<String, String> params = new HashMap();
    97          if(weblogHandle != null) {
    98              params.put("weblog", weblogHandle);
    99          }
   100          
   101          // add custom parameters if they exist
   102          if(parameters != null) {
   103              params.putAll(parameters);
   104          }
   105          
   106          if(!params.isEmpty()) {
   107              return url.toString() + URLUtilities.getQueryString(params);
   108          } else {
   109              return url.toString();
   110          }
   111      }
   112      
   113      
   114      /**
   115       * Get a url to add a new weblog entry.
   116       */
   117      public String getEntryAddURL(String weblogHandle,
   118                                                boolean absolute) {
   119          
                 /* 
    P/P           *  Method: String getEntryAddURL(String, bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuilder:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuilder:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
   120          StringBuffer url = new StringBuffer();
   121          
   122          if(absolute) {
   123              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
   124          } else {
   125              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
   126          }
   127          
   128          url.append("/roller-ui/authoring/entryAdd.rol");
   129          
   130          Map params = new HashMap();
   131          params.put("weblog", weblogHandle);
   132          
   133          return url.toString() + URLUtilities.getQueryString(params);
   134      }
   135      
   136      
   137      /**
   138       * Get a url to edit a specific weblog entry.
   139       */
   140      public String getEntryEditURL(String weblogHandle,
   141                                                 String entryId,
   142                                                 boolean absolute) {
   143          
                 /* 
    P/P           *  Method: String getEntryEditURL(String, String, bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuilder:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuilder:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
   144          StringBuffer url = new StringBuffer();
   145          
   146          if(absolute) {
   147              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
   148          } else {
   149              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
   150          }
   151          
   152          url.append("/roller-ui/authoring/entryEdit.rol");
   153          
   154          Map params = new HashMap();
   155          params.put("weblog", weblogHandle);
   156          params.put("bean.id", entryId);
   157          
   158          return url.toString() + URLUtilities.getQueryString(params);
   159      }
   160      
   161      
   162      /**
   163       * Get a url to weblog config page.
   164       */
   165      public String getWeblogConfigURL(String weblogHandle,
   166                                                    boolean absolute) {
   167          
                 /* 
    P/P           *  Method: String getWeblogConfigURL(String, bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuilder:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuilder:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
   168          StringBuffer url = new StringBuffer();
   169          
   170          if(absolute) {
   171              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
   172          } else {
   173              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
   174          }
   175          
   176          url.append("/roller-ui/authoring/weblogConfig.rol");
   177          
   178          Map params = new HashMap();
   179          params.put("weblog", weblogHandle);
   180          
   181          return url.toString() + URLUtilities.getQueryString(params);
   182      }
   183      
   184      
   185      public String getXmlrpcURL(boolean absolute) {
   186          
                 /* 
    P/P           *  Method: String getXmlrpcURL(bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuffer:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuffer:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
   187          StringBuffer url = new StringBuffer();
   188          
   189          if(absolute) {
   190              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
   191          } else {
   192              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
   193          }
   194          
   195          url.append("/roller-services/xmlrpc");
   196          
   197          return url.toString();
   198      }
   199      
   200      
   201      public String getAtomProtocolURL(boolean absolute) {
   202          
                 /* 
    P/P           *  Method: String getAtomProtocolURL(bool)
                  * 
                  *  Preconditions:
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider != null
                  *    (soft) org/apache/roller/weblogger/business/WebloggerFactory.webloggerProvider.webloggerInstance != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.absoluteContextURL)
                  *    (soft) org/apache/roller/weblogger/config/WebloggerRuntimeConfig.log != null
                  *    (soft) init'ed(org/apache/roller/weblogger/config/WebloggerRuntimeConfig.relativeContextURL)
                  * 
                  *  Postconditions:
                  *    init'ed(java.lang.StringBuffer:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuffer:toString(...)
                  * 
                  *  Test Vectors:
                  *    absolute: {0}, {1}
                  */
   203          StringBuffer url = new StringBuffer();
   204          
   205          if(absolute) {
   206              url.append(WebloggerRuntimeConfig.getAbsoluteContextURL());
   207          } else {
   208              url.append(WebloggerRuntimeConfig.getRelativeContextURL());
   209          }
   210          
   211          url.append("/roller-services/app");
   212          
   213          return url.toString();
   214      }
   215      
   216  }