1 package org
.argeo
.cms
.jcr
.internal
;
3 import static org
.argeo
.cms
.osgi
.DataModelNamespace
.CMS_DATA_MODEL_NAMESPACE
;
4 import static org
.osgi
.service
.http
.whiteboard
.HttpWhiteboardConstants
.HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
;
7 import java
.io
.IOException
;
8 import java
.io
.InputStreamReader
;
11 import java
.nio
.file
.Files
;
12 import java
.nio
.file
.Path
;
13 import java
.util
.ArrayList
;
14 import java
.util
.Arrays
;
15 import java
.util
.HashSet
;
16 import java
.util
.Hashtable
;
17 import java
.util
.List
;
21 import javax
.jcr
.Repository
;
22 import javax
.jcr
.RepositoryException
;
23 import javax
.jcr
.Session
;
24 import javax
.servlet
.Servlet
;
26 import org
.apache
.jackrabbit
.commons
.cnd
.CndImporter
;
27 import org
.apache
.jackrabbit
.core
.RepositoryContext
;
28 import org
.apache
.jackrabbit
.core
.RepositoryImpl
;
29 import org
.argeo
.api
.acr
.spi
.ProvidedRepository
;
30 import org
.argeo
.api
.cms
.CmsConstants
;
31 import org
.argeo
.api
.cms
.CmsLog
;
32 import org
.argeo
.cms
.ArgeoNames
;
33 import org
.argeo
.cms
.jcr
.CmsJcrUtils
;
34 import org
.argeo
.cms
.jcr
.acr
.JcrContentNamespace
;
35 import org
.argeo
.cms
.jcr
.internal
.servlet
.CmsRemotingServlet
;
36 import org
.argeo
.cms
.jcr
.internal
.servlet
.CmsWebDavServlet
;
37 import org
.argeo
.cms
.jcr
.internal
.servlet
.JcrHttpUtils
;
38 import org
.argeo
.cms
.osgi
.DataModelNamespace
;
39 import org
.argeo
.jcr
.Jcr
;
40 import org
.argeo
.jcr
.JcrException
;
41 import org
.argeo
.jcr
.JcrUtils
;
42 import org
.osgi
.framework
.Bundle
;
43 import org
.osgi
.framework
.BundleContext
;
44 import org
.osgi
.framework
.Constants
;
45 import org
.osgi
.framework
.FrameworkUtil
;
46 import org
.osgi
.framework
.InvalidSyntaxException
;
47 import org
.osgi
.framework
.ServiceReference
;
48 import org
.osgi
.framework
.wiring
.BundleCapability
;
49 import org
.osgi
.framework
.wiring
.BundleWire
;
50 import org
.osgi
.framework
.wiring
.BundleWiring
;
51 import org
.osgi
.service
.http
.whiteboard
.HttpWhiteboardConstants
;
52 import org
.osgi
.util
.tracker
.ServiceTracker
;
54 /** Implementation of a CMS deployment. */
55 public class CmsJcrDeployment
{
56 private final CmsLog log
= CmsLog
.getLog(getClass());
57 private final BundleContext bc
= FrameworkUtil
.getBundle(getClass()).getBundleContext();
59 private DataModels dataModels
;
60 private String webDavConfig
= JcrHttpUtils
.WEBDAV_CONFIG
;
62 private boolean argeoDataModelExtensionsAvailable
= false;
65 private boolean nodeAvailable
= false;
67 private ProvidedRepository contentRepository
;
69 // CmsDeployment cmsDeployment;
71 dataModels
= new DataModels(bc
);
73 contentRepository
.registerTypes(JcrContentNamespace
.values());
75 ServiceTracker
<?
, ?
> repoContextSt
= new RepositoryContextStc();
77 // KernelUtils.asyncOpen(repoContextSt);
79 // nodeDeployment = CmsJcrActivator.getService(NodeDeployment.class);
81 // JcrInitUtils.addToDeployment(cmsDeployment);
83 // contentRepository.registerTypes(NamespaceRegistry.PREFIX_JCR, NamespaceRegistry.NAMESPACE_JCR, null);
84 // contentRepository.registerTypes(NamespaceRegistry.PREFIX_MIX, NamespaceRegistry.NAMESPACE_MIX, null);
85 // contentRepository.registerTypes(NamespaceRegistry.PREFIX_NT, NamespaceRegistry.NAMESPACE_NT, null);
88 // // https://jackrabbit.apache.org/archive/wiki/JCR/NamespaceRegistry_115513459.html
89 // contentRepository.registerTypes("rep", "internal", null);
94 // if (nodeHttp != null)
95 // nodeHttp.destroy();
98 for (ServiceReference
<JackrabbitLocalRepository
> sr
: bc
99 .getServiceReferences(JackrabbitLocalRepository
.class, null)) {
100 bc
.getService(sr
).destroy();
102 } catch (InvalidSyntaxException e1
) {
103 log
.error("Cannot clean repositories", e1
);
108 // public void setCmsDeployment(CmsDeployment cmsDeployment) {
109 // this.cmsDeployment = cmsDeployment;
113 * Checks whether the deployment is available according to expectations, and
114 * mark it as available.
116 // private synchronized void checkReadiness() {
117 // if (isAvailable())
119 // if (nodeAvailable && userAdminAvailable && (httpExpected ? httpAvailable : true)) {
120 // String data = KernelUtils.getFrameworkProp(KernelUtils.OSGI_INSTANCE_AREA);
121 // String state = KernelUtils.getFrameworkProp(KernelUtils.OSGI_CONFIGURATION_AREA);
122 // availableSince = System.currentTimeMillis();
123 // long jvmUptime = ManagementFactory.getRuntimeMXBean().getUptime();
124 // String jvmUptimeStr = " in " + (jvmUptime / 1000) + "." + (jvmUptime % 1000) + "s";
125 // log.info("## ARGEO NODE AVAILABLE" + (log.isDebugEnabled() ? jvmUptimeStr : "") + " ##");
126 // if (log.isDebugEnabled()) {
127 // log.debug("## state: " + state);
129 // log.debug("## data: " + data);
131 // long begin = bc.getService(bc.getServiceReference(NodeState.class)).getAvailableSince();
132 // long initDuration = System.currentTimeMillis() - begin;
133 // if (log.isTraceEnabled())
134 // log.trace("Kernel initialization took " + initDuration + "ms");
135 // tributeToFreeSoftware(initDuration);
139 private void prepareNodeRepository(Repository deployedNodeRepository
, List
<String
> publishAsLocalRepo
) {
140 // if (availableSince != null) {
141 // throw new IllegalStateException("Deployment is already available");
145 prepareDataModel(CmsConstants
.NODE_REPOSITORY
, deployedNodeRepository
, publishAsLocalRepo
);
148 // if (deployConfig.isFirstInit()) {
149 // Path restorePath = Paths.get(System.getProperty("user.dir"), "restore");
150 // if (Files.exists(restorePath)) {
151 // if (log.isDebugEnabled())
152 // log.debug("Found backup " + restorePath + ", restoring it...");
153 // LogicalRestore logicalRestore = new LogicalRestore(bc, deployedNodeRepository, restorePath);
154 // KernelUtils.doAsDataAdmin(logicalRestore);
155 // log.info("Restored backup from " + restorePath);
159 // init from repository
160 // Collection<ServiceReference<Repository>> initRepositorySr;
162 // initRepositorySr = bc.getServiceReferences(Repository.class,
163 // "(" + CmsConstants.CN + "=" + CmsConstants.NODE_INIT + ")");
164 // } catch (InvalidSyntaxException e1) {
165 // throw new IllegalArgumentException(e1);
167 // Iterator<ServiceReference<Repository>> it = initRepositorySr.iterator();
168 // while (it.hasNext()) {
169 // ServiceReference<Repository> sr = it.next();
170 // Object labeledUri = sr.getProperties().get(LdapAttrs.labeledURI.name());
171 // Repository initRepository = bc.getService(sr);
172 // if (log.isDebugEnabled())
173 // log.debug("Found init repository " + labeledUri + ", copying it...");
174 // initFromRepository(deployedNodeRepository, initRepository);
175 // log.info("Node repository initialised from " + labeledUri);
179 /** Init from a (typically remote) repository. */
180 private void initFromRepository(Repository deployedNodeRepository
, Repository initRepository
) {
181 Session initSession
= null;
183 initSession
= initRepository
.login();
184 workspaces
: for (String workspaceName
: initSession
.getWorkspace().getAccessibleWorkspaceNames()) {
185 if ("security".equals(workspaceName
))
187 if (log
.isDebugEnabled())
188 log
.debug("Copying workspace " + workspaceName
+ " from init repository...");
189 long begin
= System
.currentTimeMillis();
190 Session targetSession
= null;
191 Session sourceSession
= null;
194 targetSession
= CmsJcrUtils
.openDataAdminSession(deployedNodeRepository
, workspaceName
);
195 } catch (IllegalArgumentException e
) {// no such workspace
196 Session adminSession
= CmsJcrUtils
.openDataAdminSession(deployedNodeRepository
, null);
198 adminSession
.getWorkspace().createWorkspace(workspaceName
);
200 Jcr
.logout(adminSession
);
202 targetSession
= CmsJcrUtils
.openDataAdminSession(deployedNodeRepository
, workspaceName
);
204 sourceSession
= initRepository
.login(workspaceName
);
205 // JcrUtils.copyWorkspaceXml(sourceSession, targetSession);
206 // TODO deal with referenceable nodes
207 JcrUtils
.copy(sourceSession
.getRootNode(), targetSession
.getRootNode());
208 targetSession
.save();
209 long duration
= System
.currentTimeMillis() - begin
;
210 if (log
.isDebugEnabled())
211 log
.debug("Copied workspace " + workspaceName
+ " from init repository in " + (duration
/ 1000)
213 } catch (Exception e
) {
214 log
.error("Cannot copy workspace " + workspaceName
+ " from init repository.", e
);
216 Jcr
.logout(sourceSession
);
217 Jcr
.logout(targetSession
);
220 } catch (RepositoryException e
) {
221 throw new JcrException(e
);
223 Jcr
.logout(initSession
);
227 private void prepareHomeRepository(RepositoryImpl deployedRepository
) {
228 Session adminSession
= KernelUtils
.openAdminSession(deployedRepository
);
230 argeoDataModelExtensionsAvailable
= Arrays
231 .asList(adminSession
.getWorkspace().getNamespaceRegistry().getURIs())
232 .contains(ArgeoNames
.ARGEO_NAMESPACE
);
233 } catch (RepositoryException e
) {
234 log
.warn("Cannot check whether Argeo namespace is registered assuming it isn't.", e
);
235 argeoDataModelExtensionsAvailable
= false;
237 JcrUtils
.logoutQuietly(adminSession
);
240 // Publish home with the highest service ranking
241 Hashtable
<String
, Object
> regProps
= new Hashtable
<>();
242 regProps
.put(CmsConstants
.CN
, CmsConstants
.EGO_REPOSITORY
);
243 regProps
.put(Constants
.SERVICE_RANKING
, Integer
.MAX_VALUE
);
244 Repository egoRepository
= new EgoRepository(deployedRepository
, false);
245 bc
.registerService(Repository
.class, egoRepository
, regProps
);
246 registerRepositoryServlets(CmsConstants
.EGO_REPOSITORY
, egoRepository
);
248 // Keyring only if Argeo extensions are available
249 // if (argeoDataModelExtensionsAvailable) {
250 // new ServiceTracker<CallbackHandler, CallbackHandler>(bc, CallbackHandler.class, null) {
253 // public CallbackHandler addingService(ServiceReference<CallbackHandler> reference) {
254 // NodeKeyRing nodeKeyring = new NodeKeyRing(egoRepository);
255 // CallbackHandler callbackHandler = bc.getService(reference);
256 // nodeKeyring.setDefaultCallbackHandler(callbackHandler);
257 // bc.registerService(LangUtils.names(Keyring.class, CryptoKeyring.class, ManagedService.class),
258 // nodeKeyring, LangUtils.dict(Constants.SERVICE_PID, CmsConstants.NODE_KEYRING_PID));
259 // return callbackHandler;
266 /** Session is logged out. */
267 private void prepareDataModel(String cn
, Repository repository
, List
<String
> publishAsLocalRepo
) {
268 Session adminSession
= KernelUtils
.openAdminSession(repository
);
270 Set
<String
> processed
= new HashSet
<String
>();
271 bundles
: for (Bundle bundle
: bc
.getBundles()) {
272 BundleWiring wiring
= bundle
.adapt(BundleWiring
.class);
275 if (CmsConstants
.NODE_REPOSITORY
.equals(cn
))// process all data models
276 processWiring(cn
, adminSession
, wiring
, processed
, false, publishAsLocalRepo
);
278 List
<BundleCapability
> capabilities
= wiring
.getCapabilities(CMS_DATA_MODEL_NAMESPACE
);
279 for (BundleCapability capability
: capabilities
) {
280 String dataModelName
= (String
) capability
.getAttributes().get(DataModelNamespace
.NAME
);
281 if (dataModelName
.equals(cn
))// process only own data model
282 processWiring(cn
, adminSession
, wiring
, processed
, false, publishAsLocalRepo
);
287 JcrUtils
.logoutQuietly(adminSession
);
291 private void processWiring(String cn
, Session adminSession
, BundleWiring wiring
, Set
<String
> processed
,
292 boolean importListedAbstractModels
, List
<String
> publishAsLocalRepo
) {
293 // recursively process requirements first
294 List
<BundleWire
> requiredWires
= wiring
.getRequiredWires(CMS_DATA_MODEL_NAMESPACE
);
295 for (BundleWire wire
: requiredWires
) {
296 processWiring(cn
, adminSession
, wire
.getProviderWiring(), processed
, true, publishAsLocalRepo
);
299 List
<BundleCapability
> capabilities
= wiring
.getCapabilities(CMS_DATA_MODEL_NAMESPACE
);
300 capabilities
: for (BundleCapability capability
: capabilities
) {
301 if (!importListedAbstractModels
302 && KernelUtils
.asBoolean((String
) capability
.getAttributes().get(DataModelNamespace
.ABSTRACT
))) {
303 continue capabilities
;
305 boolean publish
= registerDataModelCapability(cn
, adminSession
, capability
, processed
);
307 publishAsLocalRepo
.add((String
) capability
.getAttributes().get(DataModelNamespace
.NAME
));
311 private boolean registerDataModelCapability(String cn
, Session adminSession
, BundleCapability capability
,
312 Set
<String
> processed
) {
313 Map
<String
, Object
> attrs
= capability
.getAttributes();
314 String name
= (String
) attrs
.get(DataModelNamespace
.NAME
);
315 if (processed
.contains(name
)) {
316 if (log
.isTraceEnabled())
317 log
.trace("Data model " + name
+ " has already been processed");
322 String path
= (String
) attrs
.get(DataModelNamespace
.CND
);
324 File dataModel
= bc
.getBundle().getDataFile("dataModels/" + path
);
325 if (!dataModel
.exists()) {
326 URL url
= capability
.getRevision().getBundle().getResource(path
);
328 throw new IllegalArgumentException("No data model '" + name
+ "' found under path " + path
);
329 try (Reader reader
= new InputStreamReader(url
.openStream())) {
330 CndImporter
.registerNodeTypes(reader
, adminSession
, true);
332 dataModel
.getParentFile().mkdirs();
333 dataModel
.createNewFile();
334 if (log
.isDebugEnabled())
335 log
.debug("Registered CND " + url
);
336 } catch (Exception e
) {
337 log
.error("Cannot import CND " + url
, e
);
342 if (KernelUtils
.asBoolean((String
) attrs
.get(DataModelNamespace
.ABSTRACT
)))
345 boolean isStandalone
= isStandalone(name
);
346 boolean publishLocalRepo
;
347 if (isStandalone
&& name
.equals(cn
))// includes the node itself
348 publishLocalRepo
= true;
349 else if (!isStandalone
&& cn
.equals(CmsConstants
.NODE_REPOSITORY
))
350 publishLocalRepo
= true;
352 publishLocalRepo
= false;
354 return publishLocalRepo
;
357 boolean isStandalone(String dataModelName
) {
359 // return cmsDeployment.getProps(CmsConstants.NODE_REPOS_FACTORY_PID,
360 // dataModelName) != null;
363 private void publishLocalRepo(String dataModelName
, Repository repository
) {
364 Hashtable
<String
, Object
> properties
= new Hashtable
<>();
365 properties
.put(CmsConstants
.CN
, dataModelName
);
366 LocalRepository localRepository
;
368 if (repository
instanceof RepositoryImpl
) {
369 localRepository
= new JackrabbitLocalRepository((RepositoryImpl
) repository
, dataModelName
);
370 classes
= new String
[] { Repository
.class.getName(), LocalRepository
.class.getName(),
371 JackrabbitLocalRepository
.class.getName() };
373 localRepository
= new LocalRepository(repository
, dataModelName
);
374 classes
= new String
[] { Repository
.class.getName(), LocalRepository
.class.getName() };
376 bc
.registerService(classes
, localRepository
, properties
);
378 // TODO make it configurable
379 registerRepositoryServlets(dataModelName
, localRepository
);
380 if (log
.isTraceEnabled())
381 log
.trace("Published data model " + dataModelName
);
385 // public synchronized Long getAvailableSince() {
386 // return availableSince;
389 // public synchronized boolean isAvailable() {
390 // return availableSince != null;
393 protected void registerRepositoryServlets(String alias
, Repository repository
) {
394 registerRemotingServlet(alias
, repository
);
395 registerWebdavServlet(alias
, repository
);
398 protected void registerWebdavServlet(String alias
, Repository repository
) {
399 CmsWebDavServlet webdavServlet
= new CmsWebDavServlet(alias
, repository
);
400 Hashtable
<String
, String
> ip
= new Hashtable
<>();
401 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsWebDavServlet
.INIT_PARAM_RESOURCE_CONFIG
, webDavConfig
);
402 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsWebDavServlet
.INIT_PARAM_RESOURCE_PATH_PREFIX
,
405 ip
.put(HttpWhiteboardConstants
.HTTP_WHITEBOARD_SERVLET_PATTERN
, "/" + alias
+ "/*");
406 ip
.put(HttpWhiteboardConstants
.HTTP_WHITEBOARD_CONTEXT_SELECT
,
407 "(" + HttpWhiteboardConstants
.HTTP_WHITEBOARD_CONTEXT_PATH
+ "=" + CmsConstants
.PATH_DATA
+ ")");
408 bc
.registerService(Servlet
.class, webdavServlet
, ip
);
411 protected void registerRemotingServlet(String alias
, Repository repository
) {
412 CmsRemotingServlet remotingServlet
= new CmsRemotingServlet(alias
, repository
);
413 Hashtable
<String
, String
> ip
= new Hashtable
<>();
414 ip
.put(CmsConstants
.CN
, alias
);
415 // Properties ip = new Properties();
416 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_RESOURCE_PATH_PREFIX
,
418 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_AUTHENTICATE_HEADER
,
421 // Looks like a bug in Jackrabbit remoting init
424 tmpDir
= Files
.createTempDirectory("remoting_" + alias
);
425 } catch (IOException e
) {
426 throw new RuntimeException("Cannot create temp directory for remoting servlet", e
);
428 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_HOME
, tmpDir
.toString());
429 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_TMP_DIRECTORY
,
430 "remoting_" + alias
);
431 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_PROTECTED_HANDLERS_CONFIG
,
432 JcrHttpUtils
.DEFAULT_PROTECTED_HANDLERS
);
433 ip
.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
+ CmsRemotingServlet
.INIT_PARAM_CREATE_ABSOLUTE_URI
, "false");
435 ip
.put(HttpWhiteboardConstants
.HTTP_WHITEBOARD_SERVLET_PATTERN
, "/" + alias
+ "/*");
436 ip
.put(HttpWhiteboardConstants
.HTTP_WHITEBOARD_CONTEXT_SELECT
,
437 "(" + HttpWhiteboardConstants
.HTTP_WHITEBOARD_CONTEXT_PATH
+ "=" + CmsConstants
.PATH_JCR
+ ")");
438 bc
.registerService(Servlet
.class, remotingServlet
, ip
);
441 public void setContentRepository(ProvidedRepository contentRepository
) {
442 this.contentRepository
= contentRepository
;
445 private class RepositoryContextStc
extends ServiceTracker
<RepositoryContext
, RepositoryContext
> {
447 public RepositoryContextStc() {
448 super(bc
, RepositoryContext
.class, null);
452 public RepositoryContext
addingService(ServiceReference
<RepositoryContext
> reference
) {
453 RepositoryContext repoContext
= bc
.getService(reference
);
454 String cn
= (String
) reference
.getProperty(CmsConstants
.CN
);
456 List
<String
> publishAsLocalRepo
= new ArrayList
<>();
457 if (cn
.equals(CmsConstants
.NODE_REPOSITORY
)) {
458 // JackrabbitDataModelMigration.clearRepositoryCaches(repoContext.getRepositoryConfig());
459 prepareNodeRepository(repoContext
.getRepository(), publishAsLocalRepo
);
460 // TODO separate home repository
461 prepareHomeRepository(repoContext
.getRepository());
462 registerRepositoryServlets(cn
, repoContext
.getRepository());
463 nodeAvailable
= true;
466 prepareDataModel(cn
, repoContext
.getRepository(), publishAsLocalRepo
);
468 // Publish all at once, so that bundles with multiple CNDs are consistent
469 for (String dataModelName
: publishAsLocalRepo
)
470 publishLocalRepo(dataModelName
, repoContext
.getRepository());
476 public void modifiedService(ServiceReference
<RepositoryContext
> reference
, RepositoryContext service
) {
480 public void removedService(ServiceReference
<RepositoryContext
> reference
, RepositoryContext service
) {