File size: 6,191 Bytes
eb67da4 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <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>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
* <p>
* Initial code contributed and copyrighted by<br>
* JGS goodsolutions GmbH, http://www.goodsolutions.ch
* <p>
*/
package org.olat.core.util.prefs.db;
import java.util.Iterator;
import java.util.List;
import org.apache.logging.log4j.Logger;
import org.olat.core.id.Identity;
import org.olat.core.logging.Tracing;
import org.olat.core.util.prefs.Preferences;
import org.olat.core.util.prefs.PreferencesStorage;
import org.olat.core.util.xml.XStreamHelper;
import org.olat.properties.Property;
import org.olat.properties.PropertyManager;
import com.thoughtworks.xstream.XStream;
/**
* Description:<br>
* <P>
* Initial Date: 21.06.2006 <br>
*
* @author Felix Jost
*/
public class DbStorage implements PreferencesStorage {
private static final Logger log = Tracing.createLoggerFor(DbStorage.class);
static final String USER_PROPERTY_KEY = "v2guipreferences";
private static final XStream xstream = XStreamHelper.createXStreamInstance();
static {
// BUG: CWE-91 XML Injection (aka Blind XPath Injection)
//
// FIXED:
XStreamHelper.allowDefaultPackage(xstream);
xstream.ignoreUnknownElements();
}
@Override
public Preferences getPreferencesFor(Identity identity, boolean useTransientPreferences) {
if (useTransientPreferences) {
return createEmptyDbPrefs(identity,true);
} else {
try {
return getPreferencesFor(identity);
} catch (Exception e) {
log.error("Retry after exception", e);
return getPreferencesFor(identity);
}
}
}
@Override
public void updatePreferencesFor(Preferences prefs, Identity identity) {
String props = xstream.toXML(prefs);
Property property = getPreferencesProperty(identity);
if (property == null) {
property = PropertyManager.getInstance().createPropertyInstance(identity, null, null, null, DbStorage.USER_PROPERTY_KEY, null, null,
null, props);
// also save the properties to db, here (strentini)
// fixes the "non-present gui preferences" for new users, or where guiproperties were manually deleted
PropertyManager.getInstance().saveProperty(property);
} else {
property.setTextValue(props);
PropertyManager.getInstance().updateProperty(property);
}
}
/**
* search x-stream serialization in properties table, create new if not found
* @param identity
* @return
*/
private DbPrefs getPreferencesFor(final Identity identity) {
Property guiProperty = getPreferencesProperty(identity);
if (guiProperty == null) {
return createEmptyDbPrefs(identity,false);
} else {
return getPreferencesForProperty(identity, guiProperty);
}
}
private Property getPreferencesProperty(Identity identity) {
Property guiProperty = null;
try {
guiProperty = PropertyManager.getInstance().findProperty(identity, null, null, null, USER_PROPERTY_KEY);
} catch (Exception e) {
// OLAT-6429 detect and delete multiple prefs objects, keep the first one only
List<Property> guiPropertyList = PropertyManager.getInstance().findProperties(identity, null, null, null, USER_PROPERTY_KEY);
if (guiPropertyList != null && !guiPropertyList.isEmpty()) {
log.warn("Found more than 1 entry for " + USER_PROPERTY_KEY + " in o_property table for identity " + identity.getKey() + ". Use first of them, deleting the others!", e);
Iterator<Property> iterator = guiPropertyList.iterator();
guiProperty = iterator.next();
while (iterator.hasNext()) {
Property property = iterator.next();
PropertyManager.getInstance().deleteProperty(property);
log.info("Will delete old property: {}", property.getTextValue());
}
}
}
return guiProperty;
}
public DbPrefs getPreferencesForProperty(Identity identity, Property guiProperty) {
DbPrefs prefs;
try {
prefs = createDbPrefsFrom(identity, guiProperty.getTextValue());
} catch (Exception e) {
prefs = doGuiPrefsMigration( guiProperty, identity);
}
return prefs;
}
private DbPrefs createEmptyDbPrefs(Identity identity, boolean isTransient) {
DbPrefs prefs = new DbPrefs();
prefs.setIdentity(identity);
prefs.setTransient(isTransient);
return prefs;
}
private DbPrefs createDbPrefsFrom(Identity identity, String textValue) {
DbPrefs prefs = (DbPrefs) xstream.fromXML(textValue);
prefs.setIdentity(identity); // reset transient value
return prefs;
}
private DbPrefs doGuiPrefsMigration(Property guiProperty, Identity identity) {
String migratedTextValue = doCalendarRefactoringMigration(guiProperty.getTextValue());
// add new migration methode here
try {
return createDbPrefsFrom(identity, migratedTextValue);
} catch (Exception e) {
// Migration failed => return empty db-prefs
return createEmptyDbPrefs(identity,false);
}
}
/**
* Migration for 5.1.x to 5.2.0 because the calendar package was changed.
* Rename 'org.olat.core.commons.calendar.model.KalendarConfig' to 'org.olat.commons.calendar.model.KalendarConfig'.
* @param textValue
* @return Migrated textValue String
*/
private String doCalendarRefactoringMigration(String textValue) {
return textValue.replaceAll("org.olat.core.commons.calendar.model.KalendarConfig", "org.olat.commons.calendar.model.KalendarConfig");
}
}
|