001/* 002 * Copyright 2016 Anyware Services 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package org.ametys.plugins.workspaces.project.observers; 017 018import java.io.IOException; 019import java.io.InputStream; 020import java.util.ArrayList; 021import java.util.Collection; 022import java.util.HashMap; 023import java.util.List; 024import java.util.Map; 025 026import org.apache.avalon.framework.configuration.Configuration; 027import org.apache.avalon.framework.configuration.ConfigurationException; 028import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder; 029import org.apache.avalon.framework.service.ServiceException; 030import org.apache.avalon.framework.service.ServiceManager; 031import org.apache.commons.lang.StringUtils; 032import org.apache.excalibur.source.Source; 033import org.apache.excalibur.source.SourceNotFoundException; 034import org.apache.excalibur.source.SourceResolver; 035import org.xml.sax.SAXException; 036 037import org.ametys.core.model.type.AbstractStringElementType; 038import org.ametys.core.observation.Event; 039import org.ametys.core.observation.ObservationManager; 040import org.ametys.core.user.CurrentUserProvider; 041import org.ametys.core.util.I18nUtils; 042import org.ametys.plugins.repository.data.holder.ModifiableModelAwareDataHolder; 043import org.ametys.plugins.repository.data.holder.group.impl.ModifiableModelAwareRepeaterEntry; 044import org.ametys.plugins.repository.model.RepeaterDefinition; 045import org.ametys.plugins.workflow.support.WorkflowProvider; 046import org.ametys.plugins.workspaces.project.objects.Project; 047import org.ametys.runtime.i18n.I18nizableText; 048import org.ametys.runtime.model.ElementDefinition; 049import org.ametys.runtime.model.ModelItem; 050import org.ametys.web.ObservationConstants; 051import org.ametys.web.repository.page.ModifiablePage; 052import org.ametys.web.repository.page.ModifiableZone; 053import org.ametys.web.repository.page.ModifiableZoneItem; 054import org.ametys.web.repository.page.Page.PageType; 055import org.ametys.web.repository.page.ZoneItem.ZoneType; 056import org.ametys.web.repository.site.Site; 057import org.ametys.web.repository.sitemap.Sitemap; 058import org.ametys.web.service.Service; 059import org.ametys.web.service.ServiceExtensionPoint; 060import org.ametys.web.service.ServiceParameter; 061import org.ametys.web.skin.Skin; 062import org.ametys.web.skin.SkinTemplate; 063import org.ametys.web.skin.SkinTemplateZone; 064import org.ametys.web.skin.SkinsManager; 065 066/** 067 * Initializes all project workspace pages when a sitemap is created. 068 */ 069public class InitializeProjectSitemapObserver extends AbstractInitializeProjectObserver 070{ 071 /** The i18n utils. */ 072 protected I18nUtils _i18nUtils; 073 074 /** The observation manager. */ 075 protected ObservationManager _observationManager; 076 077 /** The skins manager. */ 078 protected SkinsManager _skinsManager; 079 080 /** Current user provider */ 081 protected CurrentUserProvider _currentUserProvider; 082 083 /** The service extension point. */ 084 protected ServiceExtensionPoint _serviceEP; 085 086 /** The plugin name. */ 087 protected String _pluginName; 088 089 /** The i18n catalogue. */ 090 protected String _i18nCatalogue; 091 092 /** The workflow provider */ 093 protected WorkflowProvider _workflowProvider; 094 095 /** Source resover */ 096 protected SourceResolver _sourceResolver; 097 098 @Override 099 public void setPluginInfo(String pluginName, String featureName, String id) 100 { 101 _pluginName = pluginName; 102 _i18nCatalogue = "plugin." + pluginName; 103 } 104 105 @Override 106 public void service(ServiceManager manager) throws ServiceException 107 { 108 super.service(manager); 109 _i18nUtils = (I18nUtils) manager.lookup(I18nUtils.ROLE); 110 _observationManager = (ObservationManager) manager.lookup(ObservationManager.ROLE); 111 _skinsManager = (SkinsManager) manager.lookup(SkinsManager.ROLE); 112 _currentUserProvider = (CurrentUserProvider) manager.lookup(CurrentUserProvider.ROLE); 113 _serviceEP = (ServiceExtensionPoint) manager.lookup(ServiceExtensionPoint.ROLE); 114 _workflowProvider = (WorkflowProvider) manager.lookup(WorkflowProvider.ROLE); 115 _sourceResolver = (SourceResolver) manager.lookup(SourceResolver.ROLE); 116 } 117 118 @Override 119 public void doObserve(Event event, Map<String, Object> transientVars, Site site, Project project) throws Exception 120 { 121 if (project != null) 122 { 123 // Initialize each sitemap with a set of predefined and configured pages 124 for (Sitemap sitemap : site.getSitemaps()) 125 { 126 _initializeSitemap(sitemap, project); 127 } 128 } 129 } 130 131 132 /** 133 * Initialize the given sitemap. 134 * @param sitemap the Sitemap object. 135 * @param project the corresponding project 136 */ 137 protected void _initializeSitemap(Sitemap sitemap, Project project) 138 { 139 // Home page (index) 140 ModifiablePage indexPage = _createPage(sitemap, "index", new I18nizableText(_i18nCatalogue, "PLUGINS_WORKSPACES_PROJECT_WORKSPACE_PAGE_INDEX_TITLE")); 141 if (indexPage != null) 142 { 143 _initializeIndexPage(project, indexPage); 144 } 145 146 _projectManager.initializeModulesSitemap(project, sitemap); 147 148 // Notify of the sitemap change. 149 Map<String, Object> eventParams = new HashMap<>(); 150 eventParams.put(ObservationConstants.ARGS_SITEMAP, sitemap); 151 _observationManager.notify(new Event(ObservationConstants.EVENT_SITEMAP_UPDATED, _currentUserProvider.getUser(), eventParams)); 152 } 153 154 /** 155 * Create a new page if not already exists 156 * @param sitemap The sitemap where the page will be created 157 * @param name The page's name 158 * @param i18nTitle The page's title 159 * @return the created page or <code>null</code> if page already exists 160 */ 161 protected ModifiablePage _createPage(Sitemap sitemap, String name, I18nizableText i18nTitle) 162 { 163 if (!sitemap.hasChild(name)) 164 { 165 ModifiablePage page = sitemap.createChild(name, "ametys:defaultPage"); 166 167 // Title should not be missing, but just in case if the i18n message or the whole catalog does not exists in the requested language 168 // to prevent a non-user-friendly error and still generate the project workspace. 169 page.setTitle(StringUtils.defaultIfEmpty(_i18nUtils.translate(i18nTitle, sitemap.getName()), "Missing title")); 170 page.setType(PageType.NODE); 171 page.setSiteName(sitemap.getSiteName()); 172 page.setSitemapName(sitemap.getName()); 173 174 sitemap.saveChanges(); 175 176 return page; 177 } 178 else 179 { 180 return null; 181 } 182 } 183 184 /** 185 * Initialize the index page. 186 * @param project The project 187 * @param indexPage the index page. 188 */ 189 protected void _initializeIndexPage(Project project, ModifiablePage indexPage) 190 { 191 Site site = indexPage.getSite(); 192 Skin skin = _skinsManager.getSkin(site.getSkinId()); 193 194 String path = "skin:" + site.getSkinId() + "://conf/project-home-model.xml"; 195 Source cfgFile = null; 196 try 197 { 198 cfgFile = _sourceResolver.resolveURI(path); 199 if (!cfgFile.exists()) 200 { 201 throw new SourceNotFoundException(cfgFile.getURI() + " does not exist"); 202 } 203 204 _initializeIndexPage(project, skin, indexPage, cfgFile); 205 } 206 catch (IOException e) 207 { 208 getLogger().error("The model file '{}' for project home page does not exists. The '{}' page of the project workspace {} will be initialized with default values", path, indexPage.getPathInSitemap(), project.getName(), e); 209 } 210 finally 211 { 212 _sourceResolver.release(cfgFile); 213 } 214 } 215 216 /** 217 * Initialize the index page from a configuration file 218 * @param project the project 219 * @param skin the skin 220 * @param indexPage the index page 221 * @param cfgFile the configuration file 222 */ 223 protected void _initializeIndexPage(Project project, Skin skin, ModifiablePage indexPage, Source cfgFile) 224 { 225 try (InputStream is = cfgFile.getInputStream()) 226 { 227 Configuration configuration = new DefaultConfigurationBuilder().build(is); 228 String templateId = configuration.getAttribute("template", "project-index"); 229 230 SkinTemplate template = skin.getTemplate(templateId); 231 if (template == null) 232 { 233 getLogger().error("The project home page template use an unexsiting template '{}'. The '{}' page of the project workspace '{}' could not be initialized.", templateId, indexPage.getPathInSitemap(), project.getName()); 234 return; 235 } 236 237 // Set the type and template. 238 indexPage.setType(PageType.CONTAINER); 239 indexPage.setTemplate(template.getId()); 240 241 // Initialize the zones. 242 Map<String, SkinTemplateZone> templateZones = template.getZones(); 243 244 for (Configuration zoneConf : configuration.getChildren()) 245 { 246 String zoneName = zoneConf.getAttribute("id"); 247 if (templateZones.containsKey(zoneName)) 248 { 249 ModifiableZone zone = indexPage.createZone(zoneName); 250 251 for (Configuration serviceConf : zoneConf.getChildren("service")) 252 { 253 String serviceId = serviceConf.getAttribute("id"); 254 Configuration paramsConf = serviceConf.getChild("parameters", true); 255 256 Service service = _serviceEP.getExtension(serviceId); 257 258 if (service != null) 259 { 260 ModifiableZoneItem zoneItem = zone.addZoneItem(); 261 zoneItem.setType(ZoneType.SERVICE); 262 zoneItem.setServiceId(serviceId); 263 264 Map<String, ModelItem> serviceModelParams = service.getParameters(); 265 _setServiceParameters(serviceModelParams.values(), zoneItem.getServiceParameters(), paramsConf, indexPage.getSitemapName()); 266 } 267 else 268 { 269 getLogger().error("The project home page template defines an unexsiting service '{}'. The '{}' page of the project workspace {} could not be initialized properly.", serviceId, indexPage.getPathInSitemap(), project.getName()); 270 } 271 } 272 } 273 else 274 { 275 getLogger().error("The project home page template defines an unexsiting zone '{}' for template '{}'. The '{}' page of the project workspace {} could not be initialized properly.", zoneName, templateId, indexPage.getPathInSitemap(), project.getName()); 276 } 277 } 278 279 indexPage.saveChanges(); 280 281 Map<String, Object> eventParams = new HashMap<>(); 282 eventParams.put(ObservationConstants.ARGS_PAGE, indexPage); 283 _observationManager.notify(new Event(ObservationConstants.EVENT_PAGE_ADDED, _currentUserProvider.getUser(), eventParams)); 284 } 285 catch (ConfigurationException | SAXException | IOException e) 286 { 287 getLogger().error("Fail to read the project home page model '{}'. The '{}' page of the project workspace {} could not be initialized", cfgFile.getURI(), indexPage.getPathInSitemap(), project.getName(), e); 288 } 289 } 290 291 private void _setServiceParameters (Collection<ModelItem> modelItems, ModifiableModelAwareDataHolder dataHolder, Configuration paramsConf, String lang) throws ConfigurationException 292 { 293 for (ModelItem modelItem : modelItems) 294 { 295 String paramName = modelItem.getName(); 296 297 if (modelItem instanceof ElementDefinition) 298 { 299 Configuration paramConf = paramsConf.getChild(paramName, false); 300 if (paramConf != null) 301 { 302 if (((ElementDefinition) modelItem).isMultiple()) 303 { 304 // FIXME we need a XML service descriptor, for now only multiple values of type string are supported 305 if (((ElementDefinition) modelItem).getType() instanceof AbstractStringElementType) 306 { 307 List<String> typedValues = new ArrayList<>(); 308 309 Configuration[] valuesConf = paramConf.getChildren("value"); 310 for (Configuration valueConf : valuesConf) 311 { 312 typedValues.add(valueConf.getValue()); 313 } 314 315 dataHolder.setValue(paramName, typedValues.toArray(new String[typedValues.size()])); 316 } 317 else 318 { 319 getLogger().warn("Only string multiple values are supported in the XML configuration of a service. Can not evaluate the service parameter " + modelItem.getPath()); 320 } 321 322 } 323 else 324 { 325 String paramValue = paramConf.getValue(""); 326 boolean i18n = paramConf.getAttributeAsBoolean("i18n", false); 327 if (i18n) 328 { 329 I18nizableText i18nText = I18nizableText.parseI18nizableText(paramConf, "application"); 330 paramValue = _i18nUtils.translate(i18nText, lang); 331 } 332 333 Object typedValue = ((ElementDefinition) modelItem).getType().castValue(paramValue); 334 dataHolder.setValue(paramName, typedValue); 335 } 336 337 338 } 339 else if (((ElementDefinition) modelItem).getDefaultValue() != null) 340 { 341 // set default value 342 dataHolder.setValue(paramName, ((ServiceParameter) modelItem).getDefaultValue()); 343 } 344 } 345 else if (modelItem instanceof RepeaterDefinition) 346 { 347 Configuration[] entriesConf = paramsConf.getChild(paramName, true).getChildren("entry"); 348 349 List<ModelItem> subModelItems = ((RepeaterDefinition) modelItem).getChildren(); 350 351 int entryCount = 1; 352 for (Configuration entryConf : entriesConf) 353 { 354 ModifiableModelAwareRepeaterEntry entry = dataHolder.getRepeater(paramName, true).addEntry(entryCount); 355 _setServiceParameters(subModelItems, entry, entryConf, lang); 356 entryCount++; 357 } 358 } 359 } 360 361 } 362}