URLPropertyHandler.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.user.propertyhandlers;

import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Locale;
import java.util.Map;

import org.olat.core.gui.components.form.ValidationError;
import org.olat.core.gui.components.form.flexible.FormItem;
import org.olat.core.gui.components.form.flexible.FormItemContainer;
import org.olat.core.id.User;
import org.olat.core.util.StringHelper;
import org.olat.user.UserManager;

/**
 * <h3>Description:</h3>
 * The url field provides a user property that contains a valid URL. 
 * <p>
 * Initial Date: 27.07.2007 <br>
 * 
 * @author Florian Gnaegi, frentix GmbH, http://www.frentix.com
 */
public class URLPropertyHandler extends Generic127CharTextPropertyHandler {
	
	/**
	 * @see org.olat.user.AbstractUserPropertyHandler#getUserPropertyAsHTML(org.olat.core.id.User, java.util.Locale)
	 */
	@Override
	public String getUserPropertyAsHTML(User user, Locale locale) {
		String href = getUserProperty(user, locale);
		if (StringHelper.containsNonWhitespace(href)) {
			href = StringHelper.escapeHtml(href);
			StringBuffer sb = new StringBuffer();
			sb.append("<a href=\"");
			sb.append(href);
			sb.append("\" target=\"_blank\"><i class=\"o_icon o_icon_link_extern\"> </i> ");
			sb.append(href);
			sb.append("</a>");
			String htmlFragment = sb.toString();
			return StringHelper.xssScan(htmlFragment);
		}
		return null;
	}

	/* (non-Javadoc)
	 * @see org.olat.user.propertyhandlers.Generic127CharTextPropertyHandler#addFormItem(java.util.Locale, org.olat.core.id.User, java.lang.String, boolean, org.olat.core.gui.components.form.flexible.FormItemContainer)
	 */
	@Override
	public FormItem addFormItem(Locale locale, User user, String usageIdentifyer, boolean isAdministrativeUser,
			FormItemContainer formItemContainer) {
		org.olat.core.gui.components.form.flexible.elements.TextElement textElement = (org.olat.core.gui.components.form.flexible.elements.TextElement)super.addFormItem(locale, user, usageIdentifyer, isAdministrativeUser, formItemContainer);
		if ( ! UserManager.getInstance().isUserViewReadOnly(usageIdentifyer, this) || isAdministrativeUser) {
			textElement.setExampleKey("form.example.url", null);
		}
		return textElement;
	}

	@Override
	public boolean isValid(User user, FormItem formItem, Map<String,String> formContext) {
		// check parent rules first: check if mandatory and empty
		if ( ! super.isValid(user, formItem, formContext)) return false;
		org.olat.core.gui.components.form.flexible.elements.TextElement uiEl = (org.olat.core.gui.components.form.flexible.elements.TextElement) formItem;
		String value = uiEl.getValue();
		ValidationError validationError = new ValidationError();
		boolean valid = isValidValue(user, value, validationError, formItem.getTranslator().getLocale());
		if(!valid) {
			uiEl.setErrorKey(validationError.getErrorKey(), new String[]{});
		}
		return valid;	
	}

	/* (non-Javadoc)
	 * @see org.olat.user.propertyhandlers.Generic127CharTextPropertyHandler#isValidValue(java.lang.String, org.olat.core.gui.components.form.ValidationError, java.util.Locale)
	 */
	@Override
	public boolean isValidValue(User user, String value, ValidationError validationError, Locale locale) {
		if ( ! super.isValidValue(user, value, validationError, locale)) return false;
		
		boolean allOk = true;
		if (StringHelper.containsNonWhitespace(value)) {			
			// check url address syntax
			try {
				URL url = new URL(value);
				url.toURI();

				if(!"http".equals(url.getProtocol()) && !"https".equals(url.getProtocol())) {
					validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
					allOk &= false;
				}
				if(!StringHelper.containsNonWhitespace(url.getAuthority())) {
					validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
					allOk &= false;
				}
				if(!StringHelper.containsNonWhitespace(url.getHost())) {
					validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
					allOk &= false;
				}
			} catch (MalformedURLException e) {
				validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
				allOk &= false;
			} catch (URISyntaxException e) {
				validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
				allOk &= false;
			}
			
			if(!value.startsWith("http://") &&!value.startsWith("https://")) {
				validationError.setErrorKey(i18nFormElementLabelKey() + ".error.valid");
				allOk &= false;
			}
		}
		
		return allOk;
	}

}