001/* 002 * Copyright 2023 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.forms.question.computing; 017 018import java.util.List; 019import java.util.Map; 020 021import org.apache.avalon.framework.context.Context; 022import org.apache.avalon.framework.context.ContextException; 023import org.apache.avalon.framework.context.Contextualizable; 024import org.apache.avalon.framework.service.ServiceException; 025import org.apache.avalon.framework.service.ServiceManager; 026import org.apache.cocoon.components.ContextHelper; 027import org.apache.cocoon.environment.Request; 028import org.apache.cocoon.xml.XMLUtils; 029import org.apache.commons.lang.StringUtils; 030import org.xml.sax.ContentHandler; 031import org.xml.sax.SAXException; 032 033import org.ametys.plugins.forms.repository.FormEntry; 034import org.ametys.plugins.forms.repository.FormQuestion; 035import org.ametys.plugins.repository.AmetysObjectResolver; 036import org.ametys.runtime.model.ModelItem; 037import org.ametys.runtime.model.ViewItem; 038import org.ametys.runtime.model.type.ModelItemTypeConstants; 039import org.ametys.web.repository.page.Page; 040 041/** 042 * Class for current page id computing type 043 */ 044public class CurrentPageIdComputingType extends AbstractStaticComputingType implements Contextualizable 045{ 046 /** The context */ 047 protected Context _context; 048 049 /** The ametys object resolver */ 050 protected AmetysObjectResolver _resolver; 051 052 @Override 053 public void service(ServiceManager manager) throws ServiceException 054 { 055 super.service(manager); 056 _resolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE); 057 } 058 059 public void contextualize(Context context) throws ContextException 060 { 061 _context = context; 062 } 063 064 public Object getComputedValue(FormQuestion question, FormEntry entry) 065 { 066 Request request = ContextHelper.getRequest(_context); 067 return request.getParameter(question.getNameForForm()); 068 } 069 070 public Map<String, ModelItem> getModelItems() 071 { 072 return Map.of(); 073 } 074 075 public String getStorageType(FormQuestion question) 076 { 077 return ModelItemTypeConstants.STRING_TYPE_ID; 078 } 079 080 public List<ViewItem> getViewElements() 081 { 082 return List.of(); 083 } 084 085 @Override 086 public void saxAdditionalValue(ContentHandler contentHandler, FormQuestion question, FormEntry entry) throws SAXException 087 { 088 String pageId = entry.getValue(question.getNameForForm()); 089 if (StringUtils.isNotBlank(pageId)) 090 { 091 Page page = _silentlyResolve(pageId); 092 if (page != null) 093 { 094 XMLUtils.startElement(contentHandler, "page"); 095 XMLUtils.createElement(contentHandler, "title", page.getTitle()); 096 XMLUtils.createElement(contentHandler, "id", page.getId()); 097 XMLUtils.endElement(contentHandler, "page"); 098 } 099 } 100 } 101 102 private Page _silentlyResolve(String pageId) 103 { 104 try 105 { 106 return _resolver.resolveById(pageId); 107 } 108 catch (Exception e) 109 { 110 return null; 111 } 112 } 113 114 @Override 115 public String getJSRenderer() 116 { 117 return "Ametys.plugins.forms.helper.SearchEntriesGridHelper.renderPage"; 118 } 119 120 public Object valueToJSONForClient(Object value, FormQuestion question, FormEntry entry, ModelItem modelItem) throws Exception 121 { 122 String pageId = value != null ? (String) value : null; 123 if (StringUtils.isNotBlank(pageId)) 124 { 125 Page page = _silentlyResolve(pageId); 126 if (page != null) 127 { 128 return Map.of("id", page.getId(), "title", page.getTitle()); 129 } 130 } 131 132 return value; 133 } 134}