Coverage Report

Coverage Report - net.sf.json.util.WebUtils

Classes in this File

Line Coverage

Branch Coverage

Complexity

WebUtils

0/47

0/24

2.333

 /*
  * Copyright 2002-2009 the original author or authors.
  *
  * Licensed 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 net.sf.json.util;
 
 import java.util.Iterator;
 
 import net.sf.json.JSON;
 import net.sf.json.JSONArray;
 import net.sf.json.JSONNull;
 import net.sf.json.JSONObject;
 
 /**
  * Provides useful methods for working with JSON and web.
  *
  * @author Andres Almiray <aalmiray@users.sourceforge.net>
  */
 public class WebUtils {
    private static final WebHijackPreventionStrategy DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY = WebHijackPreventionStrategy.INFINITE_LOOP;
    private static WebHijackPreventionStrategy webHijackPreventionStrategy = DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY;
 
    /**
     * Returns the configured WebHijackPreventionStrategy.
     */
    public static WebHijackPreventionStrategy getWebHijackPreventionStrategy() {
       return webHijackPreventionStrategy;
    }
 
    /**
     * Transforms the input Json string using the configured
     * WebHijackPreventionStrategy.<br>
     *
     * @param json the input string
     * @return String a transformed json string
     */
    public static String protect( JSON json ) {
       return protect( json, false );
    }
 
    /**
     * Transforms the input Json string using the configured
     * WebHijackPreventionStrategy.<br>
     *
     * @param json the input string
     * @param shrink if redundant key quotes may be eliminated.
     * @return String a transformed json string
     */
    public static String protect( JSON json, boolean shrink ) {
       String output = !shrink ? json.toString( 0 ) : toString( json );
       return webHijackPreventionStrategy.protect( output );
    }
 
    /**
     * Sets a WebHijackPreventionStrategy.<br>
     * Will use default value (WebHijackPreventionStrategy.INFINITE_LOOP) if
     * null.
     */
    public static void setWebHijackPreventionStrategy( WebHijackPreventionStrategy strategy ) {
       webHijackPreventionStrategy = strategy == null ? DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY
             : strategy;
    }
 
    /**
     * Returns a string represenation of a JSON value.<br>
     * When an object property name does not contain a space (' ') or a colon
     * (':'), the quotes are omitted. This is done to reduce the amount of bytes
     * sent to a web browser.<br/>USE WITH CAUTION.
     */
    public static String toString( JSON json ) {
       if( json instanceof JSONObject ){
          return toString( (JSONObject) json );
       }else if( json instanceof JSONArray ){
          return toString( (JSONArray) json );
       }else{
          return toString( (JSONNull) json );
       }
    }
 
    private static String join( JSONArray jsonArray ) {
       int len = jsonArray.size();
       StringBuffer sb = new StringBuffer();
 
       for( int i = 0; i < len; i += 1 ){
          if( i > 0 ){
             sb.append( "," );
          }
          Object value = jsonArray.get( i );
          sb.append( toString( value ) );
 
       }
       return sb.toString();
    }
 
    private static String quote( String str ) {
       if( str.indexOf( " " ) > -1 || str.indexOf( ":" ) > -1 ){
          return JSONUtils.quote( str );
       }else{
          return str;
       }
    }
 
    private static String toString( JSONArray jsonArray ) {
       try{
          return '[' + join( jsonArray ) + ']';
       }catch( Exception e ){
          return null;
       }
    }
 
    private static String toString( JSONNull jsonNull ) {
       return jsonNull.toString();
    }
 
    private static String toString( JSONObject jsonObject ) {
       if( jsonObject.isNullObject() ){
          return JSONNull.getInstance()
                .toString();
       }
       Iterator keys = jsonObject.keys();
       StringBuffer sb = new StringBuffer( "{" );
 
       while( keys.hasNext() ){
          if( sb.length() > 1 ){
             sb.append( ',' );
          }
          Object o = keys.next();
          sb.append( quote( o.toString() ) );
          sb.append( ':' );
          sb.append( toString( jsonObject.get( String.valueOf( o ) ) ) );
       }
       sb.append( '}' );
       return sb.toString();
    }
 
    private static String toString( Object object ) {
       if( object instanceof JSON ){
          return toString( (JSON) object );
       }else{
          return JSONUtils.valueToString( object );
       }
    }
 
    private WebUtils() {
    }
 }

1		/*
2		* Copyright 2002-2009 the original author or authors.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not 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.
15		*/
16
17		package net.sf.json.util;
18
19		import java.util.Iterator;
20
21		import net.sf.json.JSON;
22		import net.sf.json.JSONArray;
23		import net.sf.json.JSONNull;
24		import net.sf.json.JSONObject;
25
26		/**
27		* Provides useful methods for working with JSON and web.
28		*
29		* @author Andres Almiray <aalmiray@users.sourceforge.net>
30		*/
31		public class WebUtils {
32	0	private static final WebHijackPreventionStrategy DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY = WebHijackPreventionStrategy.INFINITE_LOOP;
33	0	private static WebHijackPreventionStrategy webHijackPreventionStrategy = DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY;
34
35		/**
36		* Returns the configured WebHijackPreventionStrategy.
37		*/
38		public static WebHijackPreventionStrategy getWebHijackPreventionStrategy() {
39	0	return webHijackPreventionStrategy;
40		}
41
42		/**
43		* Transforms the input Json string using the configured
44		* WebHijackPreventionStrategy.<br>
45		*
46		* @param json the input string
47		* @return String a transformed json string
48		*/
49		public static String protect( JSON json ) {
50	0	return protect( json, false );
51		}
52
53		/**
54		* Transforms the input Json string using the configured
55		* WebHijackPreventionStrategy.<br>
56		*
57		* @param json the input string
58		* @param shrink if redundant key quotes may be eliminated.
59		* @return String a transformed json string
60		*/
61		public static String protect( JSON json, boolean shrink ) {
62	0	String output = !shrink ? json.toString( 0 ) : toString( json );
63	0	return webHijackPreventionStrategy.protect( output );
64		}
65
66		/**
67		* Sets a WebHijackPreventionStrategy.<br>
68		* Will use default value (WebHijackPreventionStrategy.INFINITE_LOOP) if
69		* null.
70		*/
71		public static void setWebHijackPreventionStrategy( WebHijackPreventionStrategy strategy ) {
72	0	webHijackPreventionStrategy = strategy == null ? DEFAULT_WEB_HIJACK_PREVENTION_STRATEGY
73		: strategy;
74	0	}
75
76		/**
77		* Returns a string represenation of a JSON value.<br>
78		* When an object property name does not contain a space (' ') or a colon
79		* (':'), the quotes are omitted. This is done to reduce the amount of bytes
80		* sent to a web browser.<br/>USE WITH CAUTION.
81		*/
82		public static String toString( JSON json ) {
83	0	if( json instanceof JSONObject ){
84	0	return toString( (JSONObject) json );
85	0	}else if( json instanceof JSONArray ){
86	0	return toString( (JSONArray) json );
87		}else{
88	0	return toString( (JSONNull) json );
89		}
90		}
91
92		private static String join( JSONArray jsonArray ) {
93	0	int len = jsonArray.size();
94	0	StringBuffer sb = new StringBuffer();
95
96	0	for( int i = 0; i < len; i += 1 ){
97	0	if( i > 0 ){
98	0	sb.append( "," );
99		}
100	0	Object value = jsonArray.get( i );
101	0	sb.append( toString( value ) );
102
103		}
104	0	return sb.toString();
105		}
106
107		private static String quote( String str ) {
108	0	if( str.indexOf( " " ) > -1 \|\| str.indexOf( ":" ) > -1 ){
109	0	return JSONUtils.quote( str );
110		}else{
111	0	return str;
112		}
113		}
114
115		private static String toString( JSONArray jsonArray ) {
116		try{
117	0	return '[' + join( jsonArray ) + ']';
118	0	}catch( Exception e ){
119	0	return null;
120		}
121		}
122
123		private static String toString( JSONNull jsonNull ) {
124	0	return jsonNull.toString();
125		}
126
127		private static String toString( JSONObject jsonObject ) {
128	0	if( jsonObject.isNullObject() ){
129	0	return JSONNull.getInstance()
130		.toString();
131		}
132	0	Iterator keys = jsonObject.keys();
133	0	StringBuffer sb = new StringBuffer( "{" );
134
135	0	while( keys.hasNext() ){
136	0	if( sb.length() > 1 ){
137	0	sb.append( ',' );
138		}
139	0	Object o = keys.next();
140	0	sb.append( quote( o.toString() ) );
141	0	sb.append( ':' );
142	0	sb.append( toString( jsonObject.get( String.valueOf( o ) ) ) );
143	0	}
144	0	sb.append( '}' );
145	0	return sb.toString();
146		}
147
148		private static String toString( Object object ) {
149	0	if( object instanceof JSON ){
150	0	return toString( (JSON) object );
151		}else{
152	0	return JSONUtils.valueToString( object );
153		}
154		}
155
156	0	private WebUtils() {
157	0	}
158		}