WebDAV module

Web-based Distributed Authoring and Versioning (WebDAV) is an extension of the HTTP/1.1 protocol. The purpose of this protocol is to present Web content as a writable medium in addition to being a readable medium. WebDAV on Wikipedia and the WebDAV website provide information on this protocol. The WebDAV module implements the protocol for accessing Magnolia's repository on an author instance. This allows users to edit resources and templates on the client computer.

An example of WebDav in use is a designer editing CSS files located in the resources repository using a design tool installed on their computer. Another example is a developer editing Freemarker templates located in the templates workspace using a local tool that provides FreeMarker syntax highlighting and helper functions.

Download

The WebDAV module is not bundled with Magnolia. You can download the WebDav bundle from our Nexus repository.

Installing

WebDAV is a Community Edition module. It is typically not installed.

You need to install the following jars from the downloaded bundle:

• magnolia-module-webdav-2.x
• jackrabbit-webdav-2.8.0
• jackrabbit-jcr-server-2.8.0

The module is dependent on a number of libraries that should already be installed in /<CATALINA_HOME>/webapps/<contextPath>/WEB-INF/lib.

• jcl-over-slf4j-1.7.5
• commons-io-2.4.jar
• jackrabbit-spi-2.8.0.jar
• jackrabbit-spi-commons-2.8.0.jar
• slf4j-api-1.7.5.jar
• tika-core-1.4.jar

java.lang.NullPointerException	
info.magnolia.cms.filters.ServletDispatchingFilter.doFilter(ServletDispatchingFilter.java:123) 
info.magnolia.cms.filters.AbstractMgnlFilter.doFilter(AbstractMgnlFilter.java:91)

Uninstalling

Exposed workspaces

The module allows you to access the following workspaces in the magnolia repository:

• resources
• templates
• scripts
• dam

The content available is the same content you see in these apps:

• STK > Resources.
• STK > Templates.
• Dev > Groovy.
• Assets.

Once the client establishes a WebDAV connection to the repository, the content is displayed like local content and you can edit it locally. You cannot access files that are children of other files in Magnolia.

Access URL

Use the URLs listed below to access a Magnolia workspace with WebDAV.

Format:

• http://<host name>:<port>/<contextPath>/.webdav/<workspace>

Examples:

• http://localhost:8080/magnoliaAuthor/.webdav/templates
• http://localhost:8080/magnoliaAuthor/.webdav/resources
• http://localhost:8080/magnoliaAuthor/.webdav/scripts
• http://localhost:8080/magnoliaAuthor/.webdav/dam

Configuration

Installation of the WebDAV module adds the following configurations:

• Mappings that enable content access to the exposed workspaces.
• WebDAV client callback filter that ensures Magnolia authentication when users access a workspace with WebDAV.

Mappings

The module provides mapping classes for each exposed workspace. The mappings are configured in /modules/webdav/config/mappings.

The mapping configurations for templates, scripts and dam are similar. 

Properties:

• <mapping name>:
  
  • class: mapping class
    
    • SimpleStringPropertyMapping WebDAV mapping that exposes a string property as the file's content and uses a single file extension. Used in the templates and scripts configurations.
    • DamMapping WebDAV mapping for dam workspace.
• dataType: WebDAV data type.
• fileExtensionForExport: File extension of exported file.
• workspace: Workspace that is accessed.

The mappings configuration for resources is more complex because the resources workspace supports a number of resource types. You can view them in STK > Resources. 

 The configuration is in /modules/webdav/config/mappings/resources.

Nodes and properties:

• mappings:
  
  • resources:
    
    • templateNameToExtension: Maps template name to extension.
      
      • <template type>:
        
        • extension: Template file extension.
        • template: Template name.
    • extensionToDefaultTemplate: Maps file extension to template name.
      
      • <resource type>: <template name>.
      • ...
    • class: ResourcesMapping maps a single string property to the file content and the file extension to to the template name, and vice-versa.
    • dataType: WebDAV data type.
    • textStringProperty: Defines the text string property.
    • workspace: Workspace that is accessed.

Callback filter

The WebDAV module defines it's own security client callback filter that ensures Magnolia authentication when users access a workspace with WebDAV. Users login with their Magnolia credentials.

The filter is registered in the filter chain in /server/filters/securityCallback/clientCallbacks/webdav.

Properties:

• webdav:
  
  • class: WebdavClientCallback is the callback for WebDAV clients. It accepts if the header is set correspondingly. Accepts is evaluated depending on WebDAV specific headers. Adds a realmName to the header of the response (like BasicClientCallback), but does not extend AbstractHttpClientCallback.
  • davAgentPattern: The pattern that triggers the filter.

Connecting to a workspace

You need to configure your client computer to communicate with Magnolia workspaces. Once the connection is made, content within the workspaces can be modified as if it resided on the client computer. Depending on the type of client, content can be edited directly or transferred to the client and then transferred back to the workspace. This allows users to use their preferred editing tools on the client computer instead of editing within Magnolia.

In most cases, the connection consists of mapping the client's internal filesystem to a workspace in the repository. Folders and files in the repository appear as any other folder or file on the client. There must be a separate mapping for each workspace.

OS X

To map a workspace in OS X:

1. Go to Finder.
2. Click Go > Connect To Server.
3. Enter the workspace URL in the Server Address field.
4. Click Connect.
5. Enter Magnolia username and password when requested.

Repeat this procedure for each workspace.

Linux

To map a workspace in Linux:

1. Install davfs2.
2. Mount a workspace:
   mount -t davfs2 <directory>
   where directory is the directory that should be mapped to the workspace.
3. Enter Magnolia username and password when requested.

Windows

Connecting to a WebDAV server with Windows is problematic. You can try the options below or connect using a WebDav client. 

Mapping a drive

To map a network drive:

1. Click Start > Computer > Map network drive.
2. Select a drive and enter the workspace URL in the Folder field.
3. Click Finish.

If the mapping completes successfully you can see the selected drive in Windows Explorer. If the mapping does not complete successfully try adding the repository as a network location.

Network location

To add a network location:

1. Click Start > Computer > Map network drive.
2. Click Connect to a Web site that you can use to store your documents and pictures.
3. Select Choose a custom network location.
4. Enter the workspace URL in the Internet or network address field.

If neither methods succeeds, see the support matrix of alternative tools on the Magnolia Wiki.

Mini-Redirector is a Microsoft WebDAV client that is provided as part of Windows 8, Windows 7 and Windows Vista. The client is not installed by default on Windows Server 2008 and later versions. To enable it install the Desktop Experience feature.

If you are using BitKinex, for Server-Site Map configuration you need to set the Type path to Directory WebDAV. By default the path is set to File.