org.sweble.wikitext.engine.utils.UrlService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swc-engine Show documentation

A minimal engine using the Sweble Wikitext Parser to process articles in the context of a MediaWiki-like configuration.

There is a newer version: 3.1.9

/**
 * Copyright 2011 The Open Source Research Group,
 *                University of Erlangen-Nürnberg
 *
 * 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 org.sweble.wikitext.engine.utils;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.Map;
import java.util.Map.Entry;

import org.sweble.wikitext.engine.PageTitle;

public class UrlService
{
	
	public URL convertUrl(UrlType full, URL titleUrl)
	{
		return titleUrl;
	}
	
	/**
	 * Takes a parameterized URL like
	 * "http://localhost/wiki/index.php?title=$1", replace the parameter "$1"
	 * with the URL-encoded normalized full title and returns the resulting URL.
	 */
	public static URL makeUrlToArticle(String parametrizedUrl, PageTitle title) throws MalformedURLException
	{
		String encodedTitle = UrlEncoding.WIKI.encode(title.getNormalizedFullTitle());
		return new URL(parametrizedUrl.replace("$1", encodedTitle));
	}
	
	/**
	 * Appends (possibly additional) query parameter to a URL.
	 * 
	 * @param urlEncodedQuery
	 *            A URL-encoded query string, e.g.: "key=value&key2=value2&...".
	 */
	public static URL appendQuery(URL url, String urlEncodedQuery) throws MalformedURLException
	{
		String ef = url.toExternalForm();
		return (ef.indexOf('?') != -1) ?
				new URL(ef + "&" + urlEncodedQuery) :
				new URL(ef + "?" + urlEncodedQuery);
	}
	
	/**
	 * Appends (possibly additional) query parameter to a URL.
	 */
	public static URL appendQuery(URL url, Map query) throws MalformedURLException
	{
		return appendQuery(url, queryMapToString(query));
	}
	
	/**
	 * Converts a map of key=value pairs to the URL-encoded query part of an
	 * URL.
	 */
	public static String queryMapToString(Map query)
	{
		StringBuilder b = new StringBuilder();
		UrlEncoding encoder = UrlEncoding.QUERY;
		
		boolean first = true;
		for (Entry e : query.entrySet())
		{
			if (!first)
				b.append('&');
			b.append(encoder.encode(e.getKey()));
			b.append('&');
			b.append(encoder.encode(e.getValue()));
			first = false;
		}
		
		return b.toString();
	}
}