Configuration

Open configuration file - config/wopi.php

• Set the document_manager with your Document Manager.
• Set WOPI_CLIENT_URL Env.
• Enable needed features.

caution

Be sure to set your middleware to restrict access to the application.

Available options

Read the comments above every option

config/wopi.php

return [
     /*
     * Managing documents differs a lot between apps, because of this reason
     * this configration left empty to be implemented by the user There's
     * plans to implement example storage manager in the future though.
     */
    'document_manager' =>  null,

    /*
     * Here, you can customize how would you like to retrive
     * all of the diffrent configration options.
     */
    'config_repository' => Nagi\LaravelWopi\Services\DefaultConfigRepository::class,

    /*
     * This package comes with a convenient implementation of the
     * wopi spec you can build your own and swap it form here.
     */
    'wopi_implementation' => Nagi\LaravelWopi\LaravelWopi::class,

    /*
     * This request get injected into every request, and currently does
     * not have any validation logic. It's a great place to implement
     * custom validation for the access_token and access_token_ttl.
     */
    'wopi_request' =>  Nagi\LaravelWopi\Http\Requests\WopiRequest::class,

    /*
     * Here's you can define your middleware pipeline that every
     * request from the wopi client will go through.
     */
    'middleware' => [Nagi\LaravelWopi\Http\Middleware\ValidateProof::class],

     /*
     * Collabora or Microsoft Office 365 or any WOPI client url.
     */
    'client_url' => env('WOPI_CLIENT_URL', ''),

    /*
     * Tells the WOPI client when an access token expires, represented as
     * a timestamp. It's not a duration rather than a date of expiry.
     */
    'access_token_ttl' => env('WOPI_ACCESS_TOKEN_TTL', 0),

    /*
     * Every request will be approved using RSA keys.
     * It's not recommended to disable it.
     */
    'enable_proof_validation' => true,

    /*
     * Enable/disable support for deleting documents.
     * @default false
     */
    'support_delete' => false,

    /*
     * Enable/disable support for renaming documents.
     * @default false
     */
    'support_rename' => false,

    /*
     * Enable/disable support for updating documents.
     * @default true
     */
    'support_update' => true,

    /*
     * Enable/disable support locking functionality,
     * thought you have to implement lock functions.
     *
     * @default false
     */
    'support_locks' => false,

    /*
     * Enable/disable support for GetLock operation.
     *
     * @default false
     */
    'support_get_locks' => false,

    /*
     * Enable/disable support for lock IDs up to 1024 ASCII characters
     * long. If disabled WOPI clients will assume that lock IDs
     * are limited to 256 ASCII characters.
     *
     * @default false
     */
    'support_extended_lock_length' => false,

    /*
     * Enable/disable support for storing basic information
     * about the user and enable PutUserInfo operation.
     *
     * @default false
     */
    'support_user_info' => false,

];

Dynamic configuration

You can create your own configuration, for example for different enable/disable features based on abilities.

Create new class that implements ConfigRepositoryInterface, for example - TestConfigRepository

namespace App\Http\Services;

use Nagi\LaravelWopi\Contracts\ConfigRepositoryInterface;

class TestConfigRepository implements ConfigRepositoryInterface
{
    // ... implement all methods from interface

    public function supportDelete(): bool
    {
        if (\Auth::user()->can('delete-document')) {
            return true;
        }

        return false;
    }

    ...
}

Or customize how would you like to get discovery.xml file

    public function getDiscoveryXMLConfigFile(): ?string
    {
        $url = "{$this->getWopiClientUrl()}/hosting/discovery";
        $response = Http::get($url);

        if ($response->status() !== 200) {
            throw new Exception("Could not reach to the configuration discovery.xml file from {$url}");
        }

        return $response->body();
    }

For example see src/Services/DefaultConfigRepository

Note on swiping implementations

This package were built to be extremely fixable major classes can be swiped out with your own implementations.

Start with a simple class to swipe WopiRequest which currently doesn't implement any sort of authorization or validation. It also a great place to put your access token validation logic.