python-raw: add sr-only

java-spring: add a step to save the previous version of the file during processing save

.github/workflows/lint-php.yml

@@ -25,7 +25,5 @@ jobs:
           php-version: '8.2'
           tools: cs2pr, phpcs
           
-      - name: Run phpcs
-        run: |
-          phpcs --version
-          phpcs -q --extensions=php,module,inc,install,test,profile,theme,info --ignore=node_modules,bower_components,vendor,css,js,lib --standard=./ruleset.xml ./
+      - name: Lint
+        run: phpcs .

.gitignore

@@ -22,8 +22,3 @@
 /web/documentserver-example/csharp/packages
 /web/documentserver-example/csharp-mvc/packages
 /web/documentserver-example/java-spring/documents/
-/web/documentserver-example/ruby/.bundle
-/web/documentserver-example/ruby/db/*.sqlite3
-/web/documentserver-example/ruby/db/*.sqlite3-journal
-/web/documentserver-example/ruby/log/*
-/web/documentserver-example/ruby/tmp

.gitmodules

@@ -2,10 +2,6 @@
 	path = web/documentserver-example/java/src/main/resources/assets
 	url = https://github.com/ONLYOFFICE/document-templates
 	branch = main/en
-[submodule "web/documentserver-example/python/assets"]
-	path = web/documentserver-example/python/assets
-	url = https://github.com/ONLYOFFICE/document-templates
-	branch = main/en
 [submodule "web/documentserver-example/csharp-mvc/assets"]
 	path = web/documentserver-example/csharp-mvc/assets
 	url = https://github.com/ONLYOFFICE/document-templates
@@ -38,3 +34,11 @@
 	path = web/documentserver-example/php/assets/document-formats
 	url = https://github.com/ONLYOFFICE/document-formats
 	branch = master
+[submodule "web/documentserver-example/python/assets/document-templates"]
+	path = web/documentserver-example/python/assets/document-templates
+	url = https://github.com/ONLYOFFICE/document-templates
+	branch = main/en
+[submodule "web/documentserver-example/python/assets/document-formats"]
+	path = web/documentserver-example/python/assets/document-formats
+	url = https://github.com/ONLYOFFICE/document-formats
+	branch = master

3rd-Party.license

@@ -303,6 +303,10 @@ PHP_CodeSniffer - PHP_CodeSniffer is a set of two PHP scripts; the main phpcs sc
 License:        BSD-3-Clause
 License File:   PHP_CodeSniffer.license
 
+PHPUnit         - The PHP Unit Testing framework. (https://github.com/sebastianbergmann/phpunit/blob/main/LICENSE)
+License:        BSD 3-Clause
+License File:   phpunit.license
+
 
 web/documentserver-example/python
 
@@ -433,10 +437,6 @@ sorbet        - A fast, powerful type checker designed for Ruby. (https://github
 License:        Apache License 2.0
 License File:   sorbet.license
 
-sqlite3       - This module allows Ruby programs to interface with the SQLite3 database engine (www.sqlite.org). (https://github.com/sparklemotion/sqlite3-ruby/blob/master/LICENSE)
-License:        BSD-3-Clause
-License File:   sqlite3.license
-
 tapioca       - The swiss army knife of RBI generation. (https://github.com/Shopify/tapioca/blob/v0.11.6/LICENSE.txt)
 License:        MIT
 License File:   tapioca.license

CHANGELOG.md

@@ -6,6 +6,9 @@
 - nodejs: delete file without reloading the page
 - nodejs: getting history by a separate request
 - nodejs: restore from history
+- python: restore from history
+- ruby: restore from history
+- php: restore from history
 
 ## 1.6.0
 - nodejs: setUsers for region protection

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/callback/DefaultCallbackManager.java

@@ -163,6 +163,8 @@ public class DefaultCallbackManager implements CallbackManager {
 
             storageMutator.createDirectory(ver);  // create the file version directory
 
+            lastVersion.toFile().renameTo(new File(versionDir + File.separator + "prev" + curExt));
+
             saveFile(byteArrayFile, toSave); // save document file
 
             byte[] byteArrayChanges = getDownloadFile(changesUri); // download file changes

web/documentserver-example/nodejs/views/editor.ejs

@@ -239,7 +239,8 @@
               let fileList = JSON.parse(xhr.responseText);
               let firstXlsxName;
               let file;
-              for (file of fileList) {
+              for (var i = 0; i < fileList.length; i++) {
+                file = fileList[i];
                 if (file["title"]) {
                   if (getFileExt(file["title"]) === "xlsx")
                   {

web/documentserver-example/php/.gitignore

@@ -0,0 +1,2 @@
+logs
+vendor

web/documentserver-example/php/.php-version

@@ -0,0 +1 @@
+8.1.21

web/documentserver-example/php/3rd-Party.license

@@ -31,3 +31,7 @@ License File:   jwt.license
 PHP_CodeSniffer - PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent. (https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt)
 License:        BSD-3-Clause
 License File:   PHP_CodeSniffer.license
+
+PHPUnit         - The PHP Unit Testing framework. (https://github.com/sebastianbergmann/phpunit/blob/main/LICENSE)
+License:        BSD 3-Clause
+License File:   phpunit.license

web/documentserver-example/php/Makefile

@@ -0,0 +1,80 @@
+.DEFAULT_GOAL := help
+
+ADDRESS := $(ADDRESS)
+PORT := $(PORT)
+
+.PHONY: help
+help: #         Show help message for each of the Makefile recipes.
+	@grep -E "^[a-z-]+: #" $(MAKEFILE_LIST) | \
+		awk 'BEGIN {FS = ": # "}; {printf "%s: %s\n", $$1, $$2}'
+
+.PHONY: dev
+dev: #          Install development dependencies.
+	@composer install
+
+.PHONY: prod
+prod: #         Install production dependencies.
+	@composer install --no-dev
+
+ifeq ($(ADDRESS),)
+server-dev: \
+	export ADDRESS := localhost
+else
+server-dev: \
+	export ADDRESS := $(ADDRESS)
+endif
+
+ifeq ($(PORT),)
+server-dev: \
+	export PORT := 9000
+else
+server-dev: \
+	export PORT := $(PORT)
+endif
+
+.PHONY: server-dev
+server-dev: #   Start the development server on localhost at $PORT (default: 9000).
+	@php --server $(ADDRESS):$(PORT)
+
+ifeq ($(ADDRESS),)
+server-prod: \
+	export ADDRESS := 0.0.0.0
+else
+server-prod: \
+	export ADDRESS := $(ADDRESS)
+endif
+
+ifeq ($(PORT),)
+server-prod: \
+	export PORT := 9000
+else
+server-prod: \
+	export PORT := $(PORT)
+endif
+
+.PHONY: server-prod
+server-prod: #  Start the production server on 0.0.0.0 at $PORT (default: 9000).
+	@php-fpm --fpm-config php-fpm.conf
+
+.PHONY: lint
+lint: #         Lint the source code for the style.
+	@./vendor/bin/phpcs .
+
+.PHONY: test
+test: #         Run tests recursively.
+	@./vendor/bin/phpunit \
+		--test-suffix "Tests.php" \
+		--display-incomplete \
+		--display-deprecations \
+		--display-errors \
+		--display-notices \
+		--display-warnings \
+		common
+	@./vendor/bin/phpunit \
+		--test-suffix "Tests.php" \
+		--display-incomplete \
+		--display-deprecations \
+		--display-errors \
+		--display-notices \
+		--display-warnings \
+		configuration

web/documentserver-example/php/ajax.php

@@ -18,6 +18,8 @@
 namespace OnlineEditorsExamplePhp;
 
 use Exception;
+use OnlineEditorsExamplePhp\Common\Path;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\ExampleUsers;
 use OnlineEditorsExamplePhp\Helpers\JwtManager;
@@ -47,41 +49,6 @@ function getHttpOrigin()
     return $origin;
 }
 
-/**
- * Set headers that prevent caching in all the browsers
- *
- * @return void
- */
-function nocacheHeaders()
-{
-    $headers = [
-        'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
-        'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
-        'Pragma' => 'no-cache',
-    ];
-    $headers['Last-Modified'] = false;
-
-    unset($headers['Last-Modified']);
-
-    // In PHP 5.3+, make sure we are not sending a Last-Modified header.
-    if (function_exists('header_remove')) {
-        @header_remove('Last-Modified');
-    } else {
-        // In PHP 5.2, send an empty Last-Modified header, but only as a
-        // last resort to override a header already sent. #WP23021
-        foreach (headers_list() as $header) {
-            if (0 === mb_stripos($header, 'Last-Modified')) {
-                $headers['Last-Modified'] = '';
-                break;
-            }
-        }
-    }
-
-    foreach ($headers as $name => $field_value) {
-        @header("{$name}: {$field_value}");
-    }
-}
-
 /**
  * Save copy as...
  *
@@ -90,6 +57,8 @@ function nocacheHeaders()
 function saveas()
 {
     try {
+        $config_manager = new ConfigurationManager();
+
         $post = json_decode(file_get_contents('php://input'), true);
         $fileurl = $post["url"];
         $title = $post["title"];
@@ -106,8 +75,7 @@ function saveas()
         $content_length = $headers["Content-Length"];
         $data = file_get_contents(str_replace(" ", "%20", $fileurl));
 
-        if ($data === false || $content_length <= 0 || $content_length >
-            $configManager->getConfig("fileSizeMax")) {
+        if ($data === false || $content_length <= 0 || $content_length > $config_manager->maximum_file_size()) {
             $result["error"] = "File size is incorrect";
             return $result;
         }
@@ -133,6 +101,8 @@ function saveas()
  */
 function upload()
 {
+    $config_manager = new ConfigurationManager();
+
     $configManager = new ConfigManager();
     if ($_FILES['files']['error'] > 0) {
         $result["error"] = 'Error ' . json_encode($_FILES['files']['error']);
@@ -154,7 +124,7 @@ function upload()
         $ext = mb_strtolower(pathinfo($_FILES['files']['name'], PATHINFO_EXTENSION));  // get file extension
 
         // check if the file size is correct (it should be less than the max file size, but greater than 0)
-        if ($filesize <= 0 || $filesize > $configManager->getConfig("fileSizeMax")) {
+        if ($filesize <= 0 || $filesize > $config_manager->maximum_file_size()) {
             $result["error"] = 'File size is incorrect';  // if not, then an error occurs
             return $result;
         }
@@ -203,7 +173,15 @@ function track()
         return $data;
     }
 
-    global $_trackerStatus;
+    $_trackerStatus = [
+        0 => 'NotFound',
+        1 => 'Editing',
+        2 => 'MustSave',
+        3 => 'Corrupted',
+        4 => 'Closed',
+        6 => 'MustForceSave',
+        7 => 'CorruptedForceSave',
+    ];
     $status = $_trackerStatus[$data->status];  // get status from the request body
 
     $userAddress = $_GET["userAddress"];
@@ -256,9 +234,8 @@ function convert()
         $fileUri = $post["fileUri"];
         if ($fileUri == null || $fileUri == "") {
             $fileUri = serverPath(true) . '/'
-                . "webeditor-ajax.php"
-                . "?type=download"
-                . "&fileName=" . urlencode($fileName)
+                . "download"
+                . "?fileName=" . urlencode($fileName)
                 . "&userAddress=" . getClientIp();
         }
         $key = getDocEditorKey($fileName);
@@ -391,6 +368,8 @@ function csv()
 function historyDownload()
 {
     try {
+        $config_manager = new ConfigurationManager();
+
         $fileName = basename($_GET["fileName"]);  // get the file name
         $userAddress = $_GET["userAddress"];
 
@@ -400,8 +379,7 @@ function historyDownload()
         $jwtManager = new JwtManager();
         if ($jwtManager->isJwtEnabled()) {
             $configManager = new ConfigManager();
-            $jwtHeader = $configManager->getConfig("docServJwtHeader") == "" ?
-                "Authorization" : $configManager->getConfig("docServJwtHeader");
+            $jwtHeader = $config_manager->jwt_header();
             if (!empty(apache_request_headers()[$jwtHeader])) {
                 $token = $jwtManager->jwtDecode(mb_substr(
                     apache_request_headers()[$jwtHeader],
@@ -438,17 +416,15 @@ function historyDownload()
 function download()
 {
     try {
-        $configManager = new ConfigManager();
-        $fileName = realpath($configManager->getConfig("storagePath"))
-        === $configManager->getConfig("storagePath") ?
-            $_GET["fileName"] : basename($_GET["fileName"]);  // get the file name
+        $config_manager = new ConfigurationManager();
+
+        $fileName = $_GET["fileName"];
         $userAddress = $_GET["userAddress"] ?? null;
         $isEmbedded = $_GET["&dmode"] ?? null;
         $jwtManager = new JwtManager();
 
         if ($jwtManager->isJwtEnabled() && $isEmbedded == null && $userAddress) {
-            $jwtHeader = $configManager->getConfig("docServJwtHeader") == "" ?
-                "Authorization" : $configManager->getConfig("docServJwtHeader");
+            $jwtHeader = $config_manager->jwt_header();
             if (!empty(apache_request_headers()[$jwtHeader])) {
                 $token = $jwtManager->jwtDecode(mb_substr(
                     apache_request_headers()[$jwtHeader],
@@ -605,3 +581,74 @@ function reference()
 
     return $data;
 }
+
+function restore()
+{
+    try {
+        $input = file_get_contents('php://input');
+        $body = json_decode($input);
+
+        $source_basename = $body->fileName;
+        $version = $body->version;
+        $user_id = $body->userId;
+
+        $source_file = getStoragePath($source_basename);
+        $history_directory = getHistoryDir($source_file);
+
+        $bumped_version = getFileVersion($history_directory);
+        $bumped_version_string_directory = getVersionDir($history_directory, $bumped_version);
+        if (!file_exists($bumped_version_string_directory)) {
+            mkdir($bumped_version_string_directory);
+        }
+        $bumped_version_directory = new Path($bumped_version_string_directory);
+
+        $bumped_key_file = $bumped_version_directory->join_path('key.txt');
+        $bumped_key_string_file = $bumped_key_file->string();
+        $bumped_key = getDocEditorKey($source_basename);
+        file_put_contents($bumped_key_string_file, $bumped_key, LOCK_EX);
+
+        $users = new ExampleUsers();
+        $user = $users->getUser($user_id);
+
+        $bumped_changes_file = $bumped_version_directory->join_path('changes.json');
+        $bumped_changes_string_file = $bumped_changes_file->string();
+        $bumped_changes = [
+            'serverVersion' => null,
+            'changes' => array(
+                [
+                    'created' => date('Y-m-d H:i:s'),
+                    'user' => [
+                        'id' => $user->id,
+                        'name' => $user->name
+                    ]
+                ]
+            )
+        ];
+        $bumped_changes_content = json_encode($bumped_changes, JSON_PRETTY_PRINT);
+        file_put_contents($bumped_changes_string_file, $bumped_changes_content, LOCK_EX);
+
+        $source_extension = pathinfo($source_basename, PATHINFO_EXTENSION);
+        $previous_basename = "prev.{$source_extension}";
+
+        $bumped_file = $bumped_version_directory->join_path($previous_basename);
+        $bumped_string_file = $bumped_file->string();
+        copy($source_file, $bumped_string_file);
+
+        $recovery_version_string_directory = getVersionDir($history_directory, $version);
+        $recovery_version_directory = new Path($recovery_version_string_directory);
+        $recovery_file = $recovery_version_directory->join_path($previous_basename);
+        $recovery_string_file = $recovery_file->string();
+        copy($recovery_string_file, $source_file);
+
+        return [
+            'error' => null,
+            'success' => true
+        ];
+    } catch (Exception $error) {
+        $message = $error->getMessage();
+        return [
+            'error' => $message,
+            'success' => false
+        ];
+    }
+}

web/documentserver-example/php/common/HTTPStatus.php

@@ -0,0 +1,22 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+namespace OnlineEditorsExamplePhp\Common;
+
+enum HTTPStatus: int {
+    case not_found = 404;
+}

web/documentserver-example/php/common/Path.php

@@ -0,0 +1,127 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+namespace OnlineEditorsExamplePhp\Common;
+
+final class Path {
+    private string $separator = DIRECTORY_SEPARATOR;
+    private string $string;
+
+    public function __construct(string $path) {
+        $this->string = $path;
+    }
+
+    public function string(): string {
+        return $this->string;
+    }
+
+    public function dirname(): ?string {
+        $string = $this->string();
+        $parsed = pathinfo($string, PATHINFO_DIRNAME);
+        return $parsed ?: null;
+    }
+
+    public function basename(): ?string {
+        $string = $this->string();
+        $parsed = pathinfo($string, PATHINFO_BASENAME);
+        return $parsed ?: null;
+    }
+
+    public function extension(): ?string {
+        $string = $this->string();
+        $parsed = pathinfo($string, PATHINFO_EXTENSION);
+        return $parsed ?: null;
+    }
+
+    public function filename(): ?string {
+        $string = $this->string();
+        $parsed = pathinfo($string, PATHINFO_FILENAME);
+        return $parsed ?: null;
+    }
+
+    public function normalize(): self {
+        $string = $this->string();
+        $filtered = array();
+        $slugs = explode($this->separator, $string);
+        foreach ($slugs as $slug) {
+            if ($slug === '.') {
+                continue;
+            }
+            if ($slug === '..') {
+                array_pop($filtered);
+                continue;
+            }
+            $filtered[] = $slug;
+        }
+        $joined = implode($this->separator, $filtered);
+        $escaped_separator = preg_quote($this->separator, $this->separator);
+        $separator_regex = "/{$escaped_separator}{2,}/";
+        $separated = preg_replace($separator_regex, $this->separator, $joined);
+        return new Path($separated);
+    }
+
+    public function join_path(string $path): self {
+        $string = $this->string();
+        $separator =
+            str_ends_with($string, $this->separator) ||
+            str_starts_with($path, $this->separator)
+            ? ''
+            : $this->separator;
+        return new Path("{$string}{$separator}{$path}");
+    }
+
+    public function absolute(): bool {
+        $string = $this->string();
+
+        $nt_regex = '/^[A-Za-z]:\\\\/';
+        if (preg_match($nt_regex, $string)) {
+            return true;
+        }
+
+        $nt_separator = '\\';
+        if (str_starts_with($string, $nt_separator)) {
+            return true;
+        }
+
+        $posix_separator = '/';
+        if (str_starts_with($string, $posix_separator)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    public function exists(): bool {
+        $string = $this->string();
+        return file_exists($string);
+    }
+
+    public function contents(): string {
+        $string = $this->string();
+        return file_get_contents($string);
+    }
+
+    public function directory(): bool {
+        $string = $this->string();
+        return is_dir($string);
+    }
+
+    public function make_directory(): bool {
+        $string = $this->string();
+        return mkdir($string);
+    }
+}

web/documentserver-example/php/common/PathAbsolutePOSIXTests.php

@@ -0,0 +1,39 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\Path;
+
+final class PathAbsolutePOSIXTests extends TestCase {
+    public function test_recognizes_an_empty_as_a_non_absolute() {
+        $path = new Path('');
+        $absolute = $path->absolute();
+        $this->assertFalse($absolute);
+    }
+
+    public function test_recognizes_a_relative_as_a_non_absolute() {
+        $path = new Path('.');
+        $absolute = $path->absolute();
+        $this->assertFalse($absolute);
+    }
+
+    public function test_recognizes_an_absolute_as_an_absolute() {
+        $path = new Path('/');
+        $absolute = $path->absolute();
+        $this->assertTrue($absolute);
+    }
+}

web/documentserver-example/php/common/PathJoinPOSIXTests.php

@@ -0,0 +1,84 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\Path;
+
+final class PathJoinPOSIXTests extends TestCase {
+    public function test_joins_a_relative_to_an_empty_one() {
+        $path = new Path('');
+        $joined = $path->join_path('srv');
+        $this->assertEquals($joined->dirname(), '/');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_a_relative_to_a_relative_one() {
+        $path = new Path('.');
+        $joined = $path->join_path('srv');
+        $this->assertEquals($joined->dirname(), '.');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_a_relative_to_an_absolute_one() {
+        $path = new Path('/');
+        $joined = $path->join_path('srv');
+        $this->assertEquals($joined->dirname(), '/');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_an_absolute_to_an_empty_one() {
+        $path = new Path('');
+        $joined = $path->join_path('/srv');
+        $this->assertEquals($joined->dirname(), '/');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_an_absolute_to_a_relative_one() {
+        $path = new Path('.');
+        $joined = $path->join_path('/srv');
+        $this->assertEquals($joined->dirname(), '.');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_an_absolute_to_an_absolute_one() {
+        $path = new Path('/');
+        $joined = $path->join_path('/srv');
+        $this->assertEquals($joined->dirname(), '/');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+
+    public function test_joins_an_unnormalized() {
+        $path = new Path('');
+        $joined = $path->join_path('../srv');
+        $this->assertEquals($joined->dirname(), '/..');
+        $this->assertEquals($joined->basename(), 'srv');
+        $this->assertEquals($joined->extension(), null);
+        $this->assertEquals($joined->filename(), 'srv');
+    }
+}

web/documentserver-example/php/common/PathNormalizePOSIXTests.php

@@ -0,0 +1,30 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\Path;
+
+final class PathNormalizePOSIXTests extends TestCase {
+    public function test_normalizes() {
+        $path = new Path('./srv///sub/.././sub/file.docx');
+        $normalized = $path->normalize();
+        $this->assertEquals($normalized->dirname(), 'srv/sub');
+        $this->assertEquals($normalized->basename(), 'file.docx');
+        $this->assertEquals($normalized->extension(), 'docx');
+        $this->assertEquals($normalized->filename(), 'file');
+    }
+}

web/documentserver-example/php/common/PathStringPOSIXTests.php

@@ -0,0 +1,150 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\Path;
+
+final class PathStringPOSIXTests extends TestCase {
+    public function test_generates_with_an_empty() {
+        $path = new Path('');
+        $string = $path->string();
+        $this->assertEquals($string, '');
+    }
+
+    public function test_generates_with_an_empty_relative() {
+        $path = new Path('.');
+        $string = $path->string();
+        $this->assertEquals($string, '.');
+    }
+
+    public function test_generates_with_an_empty_absolute() {
+        $path = new Path('/');
+        $string = $path->string();
+        $this->assertEquals($string, '/');
+    }
+
+    public function test_generates_with_a_relative() {
+        $path = new Path('srv');
+        $string = $path->string();
+        $this->assertEquals($string, 'srv');
+    }
+
+    public function test_generates_with_a_relative_containing_a_directory() {
+        $path = new Path('srv/sub');
+        $string = $path->string();
+        $this->assertEquals($string, 'srv/sub');
+    }
+
+    public function test_generates_with_a_relative_containing_a_file() {
+        $path = new Path('srv/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, 'srv/file.json');
+    }
+
+    public function test_generates_with_a_relative_containing_a_directory_with_a_file() {
+        $path = new Path('srv/sub/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, 'srv/sub/file.json');
+    }
+
+    public function test_generates_with_an_unnormalized_relative() {
+        $path = new Path('srv////sub///file.json');
+        $string = $path->string();
+        $this->assertEquals($string, 'srv////sub///file.json');
+    }
+
+    public function test_generates_with_an_normalized_relative() {
+        $path = new Path('srv////sub///file.json');
+        $normalized = $path->normalize();
+        $string = $normalized->string();
+        $this->assertEquals($string, 'srv/sub/file.json');
+    }
+
+    public function test_generates_with_an_explicit_relative() {
+        $path = new Path('./srv');
+        $string = $path->string();
+        $this->assertEquals($string, './srv');
+    }
+
+    public function test_generates_with_an_explicit_relative_containing_a_directory() {
+        $path = new Path('./srv/sub');
+        $string = $path->string();
+        $this->assertEquals($string, './srv/sub');
+    }
+
+    public function test_generates_with_an_explicit_relative_containing_a_file() {
+        $path = new Path('./srv/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, './srv/file.json');
+    }
+
+    public function test_generates_with_an_explicit_relative_containing_a_directory_with_a_file() {
+        $path = new Path('./srv/sub/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, './srv/sub/file.json');
+    }
+
+    public function test_generates_with_an_explicit_unnormalized_relative() {
+        $path = new Path('./srv////sub///file.json');
+        $string = $path->string();
+        $this->assertEquals($string, './srv////sub///file.json');
+    }
+
+    public function test_generates_with_an_explicit_normalized_relative() {
+        $path = new Path('./srv////sub///file.json');
+        $normalized = $path->normalize();
+        $string = $normalized->string();
+        $this->assertEquals($string, 'srv/sub/file.json');
+    }
+
+    public function test_generates_with_an_absolute() {
+        $path = new Path('/srv');
+        $string = $path->string();
+        $this->assertEquals($string, '/srv');
+    }
+
+    public function test_generates_with_an_absolute_containing_a_directory() {
+        $path = new Path('/srv/sub');
+        $string = $path->string();
+        $this->assertEquals($string, '/srv/sub');
+    }
+
+    public function test_generates_with_an_absolute_containing_a_file() {
+        $path = new Path('/srv/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, '/srv/file.json');
+    }
+
+    public function test_generates_with_an_absolute_containing_a_directory_with_a_file() {
+        $path = new Path('/srv/sub/file.json');
+        $string = $path->string();
+        $this->assertEquals($string, '/srv/sub/file.json');
+    }
+
+    public function test_generates_with_an_unnormalized_absolute() {
+        $path = new Path('/srv////sub///file.json');
+        $string = $path->string();
+        $this->assertEquals($string, '/srv////sub///file.json');
+    }
+
+    public function test_generates_with_an_normalized_absolute() {
+        $path = new Path('/srv////sub///file.json');
+        $normalized = $path->normalize();
+        $string = $normalized->string();
+        $this->assertEquals($string, '/srv/sub/file.json');
+    }
+}

web/documentserver-example/php/common/URL.php

@@ -0,0 +1,132 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+namespace OnlineEditorsExamplePhp\Common;
+
+final class URL {
+    private string $string;
+
+    public function __construct(string $url) {
+        $this->string = $url;
+    }
+
+    public function string(): string {
+        return $this->string;
+    }
+
+    public function scheme(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_SCHEME) ?: null;
+    }
+
+    public function host(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_HOST) ?: null;
+    }
+
+    public function port(): ?int {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_PORT) ?: null;
+    }
+
+    public function user(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_USER) ?: null;
+    }
+
+    public function pass(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_PASS) ?: null;
+    }
+
+    public function path(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_PATH) ?: null;
+    }
+
+    public function query(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_QUERY) ?: null;
+    }
+
+    public function fragment(): ?string {
+        $string = $this->string();
+        return parse_url($string, PHP_URL_FRAGMENT) ?: null;
+    }
+
+    public static function from_components(
+        ?string $scheme,
+        ?string $host,
+        ?int $port,
+        ?string $user,
+        ?string $pass,
+        ?string $path,
+        ?string $query,
+        ?string $fragment
+    ): URL {
+        $string = '';
+        if ($scheme) {
+            $string .= "{$scheme}://";
+        }
+        if ($user) {
+            $string .= $user;
+        }
+        if ($pass) {
+            $string .= ":{$pass}@";
+        }
+        if ($host) {
+            $string .= $host;
+        }
+        if ($port) {
+            $string .= ":{$port}";
+        }
+        if ($path) {
+            $string .= $path;
+        }
+        if ($query) {
+            $string .= "?{$query}";
+        }
+        if ($fragment) {
+            $string .= "#{$fragment}";
+        }
+        return new URL($string);
+    }
+
+    public function join_path(string $path): self {
+        $current_path = $this->path();
+        $separator =
+            $current_path &&
+            (
+                str_ends_with($current_path, '/') ||
+                str_starts_with($path, '/')
+            ) ||
+            !$current_path && str_starts_with($path, '/')
+            ? ''
+            : '/';
+        $separated = "{$current_path}{$separator}{$path}";
+        return URL::from_components(
+            $this->scheme(),
+            $this->host(),
+            $this->port(),
+            $this->user(),
+            $this->pass(),
+            $separated,
+            $this->query(),
+            $this->fragment()
+        );
+    }
+}

web/documentserver-example/php/common/URLFromComponentsTests.php

@@ -0,0 +1,42 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\URL;
+
+final class URLFromComponentsTests extends TestCase {
+    public function test_creates() {
+        $url = URL::from_components(
+            'http',
+            'localhost',
+            8080,
+            'user',
+            'password',
+            '/path',
+            'q=value',
+            'fragment'
+        );
+        $this->assertEquals('http', $url->scheme());
+        $this->assertEquals('localhost', $url->host());
+        $this->assertEquals(8080, $url->port());
+        $this->assertEquals('user', $url->user());
+        $this->assertEquals('password', $url->pass());
+        $this->assertEquals('/path', $url->path());
+        $this->assertEquals('q=value', $url->query());
+        $this->assertEquals('fragment', $url->fragment());
+    }
+}

web/documentserver-example/php/common/URLJoinPathTests.php

@@ -0,0 +1,73 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\URL;
+
+final class URLJoinPathTests extends TestCase {
+    public function test_joins_a_relative_to_an_empty_one() {
+        $url = new URL('http://localhost');
+        $joined = $url->join_path('first');
+        $this->assertEquals('http', $joined->scheme());
+        $this->assertEquals('localhost', $joined->host());
+        $this->assertEquals(null, $joined->port());
+        $this->assertEquals(null, $joined->user());
+        $this->assertEquals(null, $joined->pass());
+        $this->assertEquals('/first', $joined->path());
+        $this->assertEquals(null, $joined->query());
+        $this->assertEquals(null, $joined->fragment());
+    }
+
+    public function test_joins_a_relative() {
+        $url = new URL('http://localhost/first');
+        $joined = $url->join_path('second');
+        $this->assertEquals('http', $joined->scheme());
+        $this->assertEquals('localhost', $joined->host());
+        $this->assertEquals(null, $joined->port());
+        $this->assertEquals(null, $joined->user());
+        $this->assertEquals(null, $joined->pass());
+        $this->assertEquals('/first/second', $joined->path());
+        $this->assertEquals(null, $joined->query());
+        $this->assertEquals(null, $joined->fragment());
+    }
+
+    public function test_joins_an_absolute_to_an_empty_one() {
+        $url = new URL('http://localhost');
+        $joined = $url->join_path('/first');
+        $this->assertEquals('http', $joined->scheme());
+        $this->assertEquals('localhost', $joined->host());
+        $this->assertEquals(null, $joined->port());
+        $this->assertEquals(null, $joined->user());
+        $this->assertEquals(null, $joined->pass());
+        $this->assertEquals('/first', $joined->path());
+        $this->assertEquals(null, $joined->query());
+        $this->assertEquals(null, $joined->fragment());
+    }
+
+    public function test_joins_an_absolute() {
+        $url = new URL('http://localhost/first');
+        $joined = $url->join_path('/second');
+        $this->assertEquals('http', $joined->scheme());
+        $this->assertEquals('localhost', $joined->host());
+        $this->assertEquals(null, $joined->port());
+        $this->assertEquals(null, $joined->user());
+        $this->assertEquals(null, $joined->pass());
+        $this->assertEquals('/first/second', $joined->path());
+        $this->assertEquals(null, $joined->query());
+        $this->assertEquals(null, $joined->fragment());
+    }
+}

web/documentserver-example/php/common/URLStringTests.php

@@ -0,0 +1,30 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Common\URL;
+
+final class URLStringTests extends TestCase {
+    public function test_generates() {
+        $url = new URL('http://user:password@localhost:8080/path?q=value#fragment');
+        $string = $url->string();
+        $this->assertEquals(
+            'http://user:password@localhost:8080/path?q=value#fragment',
+            $string
+        );
+    }
+}

web/documentserver-example/php/composer.json

@@ -1,26 +1,19 @@
 {
+    "require": {
+        "ext-mbstring": "*",
+        "firebase/php-jwt": "^6.8.1"
+    },
     "require-dev": {
-        "squizlabs/php_codesniffer": "*",
-        "ext-mbstring": "*"
+        "squizlabs/php_codesniffer": "^3.7.2",
+        "phpunit/phpunit": "^10.2.6"
     },
-    "scripts": {
-        "code-sniffer": [
-            "./vendor/bin/phpcs --config-set default_standard ruleset.xml",
-            "./vendor/bin/phpcs --config-set colors 1"
-        ],
-        "post-install-cmd": [
-            "@code-sniffer"
-        ],
-        "post-update-cmd": [
-            "@code-sniffer"
-        ]
-    },
-    "autoload-dev": {
+    "autoload": {
         "psr-4": {
             "OnlineEditorsExamplePhp\\" : "",
+            "OnlineEditorsExamplePhp\\Common\\": "common/",
+            "OnlineEditorsExamplePhp\\Configuration\\" : "configuration/",
             "OnlineEditorsExamplePhp\\Helpers\\" : "helpers/",
-            "OnlineEditorsExamplePhp\\Views\\" : "views/",
-            "Firebase\\JWT\\" : "lib/jwt/"
+            "OnlineEditorsExamplePhp\\Views\\" : "views/"
         }
     }
 }

web/documentserver-example/php/config.json

@@ -1,66 +0,0 @@
-{
-  "version": "1.6.0",
-
-  "fileSizeMax": 5242880,
-  "storagePath": "",
-  "alone": false,
-
-  "docServTimeout": "120000",
-  "docServSiteUrl": "https://documentserver/",
-
-  "docServConverterUrl": "ConvertService.ashx",
-  "docServApiUrl": "web-apps/apps/api/documents/api.js",
-  "docServPreloaderUrl": "web-apps/apps/api/documents/cache-scripts.html",
-  "docServCommandUrl": "coauthoring/CommandService.ashx",
-
-  "docServJwtSecret": "",
-  "docServJwtHeader": "Authorization",
-  "docServJwtUseForRequest": true,
-
-  "docServVerifyPeerOff": true,
-
-  "exampleUrl": "",
-  "mobileRegex": "android|avantgo|playbook|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od|ad)|iris|kindle|lge |maemo|midp|mmp|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\\/|plucker|pocket|psp|symbian|treo|up\\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino",
-  "languages": {
-    "en": "English",
-    "hy": "Armenian",
-    "az": "Azerbaijani",
-    "eu": "Basque",
-    "be": "Belarusian",
-    "bg": "Bulgarian",
-    "ca": "Catalan",
-    "zh": "Chinese (Simplified)",
-    "zh-TW": "Chinese (Traditional)",
-    "cs": "Czech",
-    "da": "Danish",
-    "nl": "Dutch",
-    "fi": "Finnish",
-    "fr": "French",
-    "gl": "Galego",
-    "de": "German",
-    "el": "Greek",
-    "hu": "Hungarian",
-    "id": "Indonesian",
-    "it": "Italian",
-    "ja": "Japanese",
-    "ko": "Korean",
-    "lo": "Lao",
-    "lv": "Latvian",
-    "ms": "Malay (Malaysia)",
-    "no": "Norwegian",
-    "pl": "Polish",
-    "pt": "Portuguese (Brazil)",
-    "pt-PT": "Portuguese (Portugal)",
-    "ro": "Romanian",
-    "ru": "Russian",
-    "si": "Sinhala (Sri Lanka)",
-    "sk": "Slovak",
-    "sl": "Slovenian",
-    "es": "Spanish",
-    "sv": "Swedish",
-    "tr": "Turkish",
-    "uk": "Ukrainian",
-    "vi": "Vietnamese",
-    "aa-AA": "Test Language"
-  }
-}

web/documentserver-example/php/configuration/ConfigurationManager.php

@@ -0,0 +1,177 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+namespace OnlineEditorsExamplePhp\Configuration;
+
+use OnlineEditorsExamplePhp\Common\Path;
+use OnlineEditorsExamplePhp\Common\URL;
+
+final class ConfigurationManager {
+    public string $version = '1.6.0';
+
+    public function example_url(): ?URL {
+        $url = getenv('EXAMPLE_URL');
+        if (!$url) {
+            return null;
+        }
+        return new URL($url);
+    }
+
+    public function document_server_url(): URL {
+        $url = getenv('DOCUMENT_SERVER_URL') ?: 'http://document-server';
+        return new URL($url);
+    }
+
+    public function document_server_api_url(): URL {
+        $server_url = $this->document_server_url();
+        $path = getenv('DOCUMENT_SERVER_API_PATH')
+            ?: 'web-apps/apps/api/documents/api.js';
+        return $server_url->join_path($path);
+    }
+
+    public function document_server_preloader_url(): URL {
+        $server_url = $this->document_server_url();
+        $path = getenv('DOCUMENT_SERVER_PRELOADER_PATH')
+            ?: 'web-apps/apps/api/documents/cache-scripts.html';
+        return $server_url->join_path($path);
+    }
+
+    public function document_server_command_url(): URL {
+        $server_url = $this->document_server_url();
+        $path = getenv('DOCUMENT_SERVER_COMMAND_PATH')
+            ?: 'coauthoring/CommandService.ashx';
+        return $server_url->join_path($path);
+    }
+
+    public function document_server_converter_url(): URL {
+        $server_url = $this->document_server_url();
+        $path = getenv('DOCUMENT_SERVER_CONVERTER_PATH')
+            ?: 'ConvertService.ashx';
+        return $server_url->join_path($path);
+    }
+
+    public function jwt_secret(): string {
+        return getenv('JWT_SECRET') ?: '';
+    }
+
+    public function jwt_header(): string {
+        return getenv('JWT_HEADER') ?: 'Authorization';
+    }
+
+    public function jwt_use_for_request(): bool {
+        $use = getenv('JWT_USE_FOR_REQUEST');
+        if (!$use) {
+            return true;
+        }
+        return filter_var($use, FILTER_VALIDATE_BOOLEAN);
+    }
+
+    public function ssl_verify_peer_mode_enabled(): bool {
+        $enabled = getenv('SSL_VERIFY_PEER_MODE_ENABLED');
+        if (!$enabled) {
+            return false;
+        }
+        return filter_var($enabled, FILTER_VALIDATE_BOOLEAN);
+    }
+
+    public function storage_path(): Path {
+        $storage_path = getenv('STORAGE_PATH') ?: 'storage';
+        $storage_directory = new Path($storage_path);
+        if ($storage_directory->absolute()) {
+            return $storage_directory;
+        }
+
+        $storage_string_directory = $storage_directory->string();
+        $current_directory = new Path(__DIR__);
+        $directory = $current_directory
+            ->join_path('..')
+            ->join_path($storage_string_directory);
+        return $directory->normalize();
+    }
+
+    public function single_user(): bool {
+        $single = getenv('SINGLE_USER');
+        if (!$single) {
+            return false;
+        }
+        return filter_var($single, FILTER_VALIDATE_BOOLEAN);
+    }
+
+    public function maximum_file_size(): int {
+        $size = getenv('MAXIMUM_FILE_SIZE');
+        if (!$size) {
+            return 5 * 1024 * 1024;
+        }
+        return intval($size);
+    }
+
+    public function conversion_timeout(): int {
+        $timeout = getenv('CONVERSION_TIMEOUT');
+        if (!$timeout) {
+            return 120 * 1000;
+        }
+        return intval($timeout);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function languages(): array {
+        return [
+            'en' => "English",
+            'hy' => 'Armenian',
+            'az' => 'Azerbaijani',
+            'eu' => 'Basque',
+            'be' => 'Belarusian',
+            'bg' => 'Bulgarian',
+            'ca' => 'Catalan',
+            'zh' => 'Chinese (Simplified)',
+            'zh-TW' => 'Chinese (Traditional)',
+            'cs' => 'Czech',
+            'da' => 'Danish',
+            'nl' => 'Dutch',
+            'fi' => 'Finnish',
+            'fr' => 'French',
+            'gl' => 'Galego',
+            'de' => 'German',
+            'el' => 'Greek',
+            'hu' => 'Hungarian',
+            'id' => 'Indonesian',
+            'it' => 'Italian',
+            'ja' => 'Japanese',
+            'ko' => 'Korean',
+            'lo' => 'Lao',
+            'lv' => 'Latvian',
+            'ms' => 'Malay (Malaysia)',
+            'no' => 'Norwegian',
+            'pl' => 'Polish',
+            'pt' => 'Portuguese (Brazil)',
+            'pt-PT' => 'Portuguese (Portugal)',
+            'ro' => 'Romanian',
+            'ru' => 'Russian',
+            'si' => 'Sinhala (Sri Lanka)',
+            'sk' => 'Slovak',
+            'sl' => 'Slovenian',
+            'es' => 'Spanish',
+            'sv' => 'Swedish',
+            'tr' => 'Turkish',
+            'uk' => 'Ukrainian',
+            'vi' => 'Vietnamese',
+            'aa-AA' => 'Test Language'
+        ];
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerConversionTimeoutTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerConversionTimeoutTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $timeout = $config_manager->conversion_timeout();
+        $this->assertEquals(120_000, $timeout);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('CONVERSION_TIMEOUT=10');
+        $config_manager = new ConfigurationManager();
+        $timeout = $config_manager->conversion_timeout();
+        $this->assertEquals(10, $timeout);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerDocumentServerAPIURLTests.php

@@ -0,0 +1,53 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerDocumentServerAPIURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_api_url();
+        $this->assertEquals(
+            'http://document-server/web-apps/apps/api/documents/api.js',
+            $url->string()
+        );
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('DOCUMENT_SERVER_API_PATH=/api');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_api_url();
+        $this->assertEquals(
+            'http://document-server/api',
+            $url->string()
+        );
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerDocumentServerCommandURLTests.php

@@ -0,0 +1,53 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerDocumentServerCommandURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_command_url();
+        $this->assertEquals(
+            'http://document-server/coauthoring/CommandService.ashx',
+            $url->string()
+        );
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('DOCUMENT_SERVER_COMMAND_PATH=/command');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_command_url();
+        $this->assertEquals(
+            'http://document-server/command',
+            $url->string()
+        );
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerDocumentServerConverterURLTests.php

@@ -0,0 +1,53 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerDocumentServerConverterURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_converter_url();
+        $this->assertEquals(
+            'http://document-server/ConvertService.ashx',
+            $url->string()
+        );
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('DOCUMENT_SERVER_CONVERTER_PATH=/converter');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_converter_url();
+        $this->assertEquals(
+            'http://document-server/converter',
+            $url->string()
+        );
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerDocumentServerPreloaderURLTests.php

@@ -0,0 +1,53 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerDocumentServerPreloaderURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_preloader_url();
+        $this->assertEquals(
+            'http://document-server/web-apps/apps/api/documents/cache-scripts.html',
+            $url->string()
+        );
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('DOCUMENT_SERVER_PRELOADER_PATH=/preloader');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_preloader_url();
+        $this->assertEquals(
+            'http://document-server/preloader',
+            $url->string()
+        );
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerDocumentServerURLTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerDocumentServerURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_url();
+        $this->assertEquals('http://document-server', $url->string());
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('DOCUMENT_SERVER_URL=http://localhost');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->document_server_url();
+        $this->assertEquals('http://localhost', $url->string());
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerExampleURLTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerExampleURLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->example_url();
+        $this->assertNull($url);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('EXAMPLE_URL=http://localhost');
+        $config_manager = new ConfigurationManager();
+        $url = $config_manager->example_url();
+        $this->assertEquals('http://localhost', $url->string());
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerJWTHeaderTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerJWTHeaderTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $header = $config_manager->jwt_header();
+        $this->assertEquals('Authorization', $header);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('JWT_HEADER=Proxy-Authorization');
+        $config_manager = new ConfigurationManager();
+        $header = $config_manager->jwt_header();
+        $this->assertEquals('Proxy-Authorization', $header);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerJWTSecretTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerJWTSecretTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $secret = $config_manager->jwt_secret();
+        $this->assertEquals('', $secret);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('JWT_SECRET=your-256-bit-secret');
+        $config_manager = new ConfigurationManager();
+        $secret = $config_manager->jwt_secret();
+        $this->assertEquals('your-256-bit-secret', $secret);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerJWTUseForRequest.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerJWTUseForRequest extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $use = $config_manager->jwt_use_for_request();
+        $this->assertTrue($use);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('JWT_USE_FOR_REQUEST=false');
+        $config_manager = new ConfigurationManager();
+        $use = $config_manager->jwt_use_for_request();
+        $this->assertFalse($use);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerMaximumFileSizeTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerMaximumFileSizeTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $size = $config_manager->maximum_file_size();
+        $this->assertEquals(5_242_880, $size);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('MAXIMUM_FILE_SIZE=10');
+        $config_manager = new ConfigurationManager();
+        $size = $config_manager->maximum_file_size();
+        $this->assertEquals(10, $size);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerSSLTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerSSLTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $enabled = $config_manager->ssl_verify_peer_mode_enabled();
+        $this->assertFalse($enabled);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('SSL_VERIFY_PEER_MODE_ENABLED=true');
+        $config_manager = new ConfigurationManager();
+        $enabled = $config_manager->ssl_verify_peer_mode_enabled();
+        $this->assertTrue($enabled);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerSingleUserTests.php

@@ -0,0 +1,47 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerSingleUserTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $single = $config_manager->single_user();
+        $this->assertFalse($single);
+    }
+
+    public function test_assigns_a_value_from_the_environment() {
+        putenv('SINGLE_USER=true');
+        $config_manager = new ConfigurationManager();
+        $single = $config_manager->single_user();
+        $this->assertTrue($single);
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerStoragePathTests.php

@@ -0,0 +1,56 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerStoragePathTests extends TestCase {
+    public array $env;
+
+    public function __construct(string $name) {
+        $this->env = getenv();
+        parent::__construct($name);
+    }
+
+    protected function setUp(): void {
+        foreach ($this->env as $key => $value) {
+            putenv("{$key}={$value}");
+        }
+    }
+
+    public function test_assigns_a_default_value() {
+        $config_manager = new ConfigurationManager();
+        $path = $config_manager->storage_path();
+        $this->assertTrue($path->absolute());
+        $this->assertEquals($path->basename(), 'storage');
+    }
+
+    public function test_assigns_a_relative_path_from_the_environment() {
+        putenv('STORAGE_PATH=directory');
+        $config_manager = new ConfigurationManager();
+        $path = $config_manager->storage_path();
+        $this->assertTrue($path->absolute());
+        $this->assertEquals($path->basename(), 'directory');
+    }
+
+    public function test_assigns_an_absolute_path_from_the_environment() {
+        putenv('STORAGE_PATH=/directory');
+        $config_manager = new ConfigurationManager();
+        $path = $config_manager->storage_path();
+        $this->assertEquals($path->string(), '/directory');
+    }
+}

web/documentserver-example/php/configuration/ConfigurationManagerTests.php

@@ -0,0 +1,26 @@
+<?php
+//
+// (c) Copyright Ascensio System SIA 2023
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+use PHPUnit\Framework\TestCase;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
+final class ConfigurationManagerTests extends TestCase {
+    public function test_corresponds_the_latest_version() {
+        $config_manager = new ConfigurationManager();
+        $this->assertEquals('1.6.0', $config_manager->version);
+    }
+}

web/documentserver-example/php/doceditor.php

@@ -1,26 +0,0 @@
-<?php
-/**
- * (c) Copyright Ascensio System SIA 2023
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-namespace OnlineEditorsExamplePhp;
-
-use OnlineEditorsExamplePhp\Views\DocEditorView;
-
-require_once dirname(__FILE__) . '/functions.php';
-require_once dirname(__FILE__) . '/vendor/autoload.php';
-
-$docEditorView = new DocEditorView($_REQUEST);
-$docEditorView->render();

web/documentserver-example/php/functions.php

@@ -18,6 +18,7 @@
 namespace OnlineEditorsExamplePhp;
 
 use Exception;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\ExampleUsers;
 use OnlineEditorsExamplePhp\Helpers\JwtManager;
@@ -92,10 +93,10 @@ function getClientIp()
  */
 function serverPath($forDocumentServer = null)
 {
-    $configManager = new ConfigManager();
-    return $forDocumentServer && $configManager->getConfig("storagePath") != null
-    && $configManager->getConfig("exampleUrl") != ""
-        ? $configManager->getConfig("exampleUrl")
+    $config_manager = new ConfigurationManager();
+    $example_url = $config_manager->example_url();
+    return $forDocumentServer && $example_url
+        ? $example_url->string()
         : (getScheme() . '://' . $_SERVER['HTTP_HOST']);
 }
 
@@ -108,11 +109,8 @@ function serverPath($forDocumentServer = null)
  */
 function getCurUserHostAddress($userAddress = null)
 {
-    $configManager = new ConfigManager();
-    if ($configManager->getConfig("alone")) {
-        if (empty($configManager->getConfig("storagePath"))) {
-            return "Storage";
-        }
+    $config_manager = new ConfigurationManager();
+    if ($config_manager->single_user()) {
         return "";
     }
     if (is_null($userAddress)) {
@@ -222,39 +220,21 @@ function getScheme()
  */
 function getStoragePath($fileName, $userAddress = null)
 {
-    $configManager = new ConfigManager();
-    $storagePath = trim(
-        str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $configManager->getConfig("storagePath")),
-        DIRECTORY_SEPARATOR
-    );
-    if (!empty($storagePath) && !file_exists($storagePath) && !is_dir($storagePath)) {
-        mkdir($storagePath);
+    $config_manager = new ConfigurationManager();
+    $storage_path = $config_manager->storage_path();
+
+    if (!$storage_path->exists()) {
+        $storage_path->make_directory();
     }
 
-    if (realpath($storagePath) === $storagePath) {
-        $directory = $storagePath;
-    } else {
-        $directory = __DIR__ . DIRECTORY_SEPARATOR . $storagePath;
+    $user_ip = getCurUserHostAddress($userAddress);
+    $user_directory = $storage_path->join_path($user_ip);
+    if (!$user_directory->exists()) {
+        $user_directory->make_directory();
     }
 
-    if ($storagePath != "") {
-        $directory = $directory  . DIRECTORY_SEPARATOR;
-
-        // if the file directory doesn't exist, make it
-        if (!file_exists($directory) && !is_dir($directory)) {
-            mkdir($directory);
-        }
-    }
-
-    if (realpath($storagePath) !== $storagePath) {
-        $directory = $directory . getCurUserHostAddress($userAddress) . DIRECTORY_SEPARATOR;
-    }
-
-    if (!file_exists($directory) && !is_dir($directory)) {
-        mkdir($directory);
-    }
-    sendlog("getStoragePath result: " . $directory . basename($fileName), "common.log");
-    return realpath($storagePath) === $storagePath ? $directory . $fileName : $directory . basename($fileName);
+    $file = $user_directory->join_path($fileName);
+    return $file->string();
 }
 
 /**
@@ -268,43 +248,30 @@ function getStoragePath($fileName, $userAddress = null)
  */
 function getForcesavePath($fileName, $userAddress, $create)
 {
-    $configManager = new ConfigManager();
-    $storagePath = trim(
-        str_replace(
-            ['/', '\\'],
-            DIRECTORY_SEPARATOR,
-            $configManager->getConfig("storagePath")
-        ),
-        DIRECTORY_SEPARATOR
-    );
+    $config_manager = new ConfigurationManager();
+    $storage_path = $config_manager->storage_path();
 
-    // create the directory to this file version
-    if (realpath($storagePath) === $storagePath) {
-        $directory = $storagePath . DIRECTORY_SEPARATOR;
-    } else {
-        $directory = __DIR__ . DIRECTORY_SEPARATOR . $storagePath . getCurUserHostAddress($userAddress) .
-            DIRECTORY_SEPARATOR;
+    $user_ip = getCurUserHostAddress($userAddress);
+    $user_directory = $storage_path->join_path($user_ip);
+    if (!$user_directory->exists()) {
+        return '';
     }
 
-    if (!is_dir($directory)) {
-        return "";
+    $history_directory = $user_directory->join_path("{$fileName}-hist");
+    if (!$history_directory->exists()) {
+        if ($create) {
+            $history_directory->make_directory();
+        } else {
+            return '';
+        }
     }
 
-    // create the directory to the history of this file version
-    $directory = $directory . $fileName . "-hist" . DIRECTORY_SEPARATOR;
-    if (!$create && !is_dir($directory)) {
-        return "";
+    $file = $history_directory->join_path($fileName);
+    if (!$file->exists() && !$create) {
+        return '';
     }
 
-    if (!file_exists($directory) && !is_dir($directory)) {
-        mkdir($directory);
-    }
-    $directory = $directory . $fileName;
-    if (!$create && !file_exists($directory)) {
-        return "";
-    }
-
-    return $directory;
+    return $file->string();
 }
 
 /**
@@ -370,38 +337,21 @@ function getFileVersion($histDir)
 function getStoredFiles()
 {
     $configManager = new ConfigManager();
-    $storagePath = trim(str_replace(
-        ['/', '\\'],
-        DIRECTORY_SEPARATOR,
-        $configManager->getConfig("storagePath")
-    ), DIRECTORY_SEPARATOR);
-    if (!empty($storagePath) && !file_exists($storagePath) && !is_dir($storagePath)) {
-        mkdir($storagePath);
+
+    $config_manager = new ConfigurationManager();
+    $storage_path = $config_manager->storage_path();
+
+    if (!$storage_path->exists()) {
+        $storage_path->make_directory();
     }
 
-    if (realpath($storagePath) === $storagePath) {
-        $directory = $storagePath;
-    } else {
-        $directory = __DIR__ . DIRECTORY_SEPARATOR . $storagePath;
+    $user_ip = getCurUserHostAddress();
+    $user_directory = $storage_path->join_path($user_ip);
+    if (!$user_directory->exists()) {
+        $user_directory->make_directory();
     }
 
-    // get the storage path and check if it exists
-    $result = [];
-    if ($storagePath != "") {
-        $directory = $directory . DIRECTORY_SEPARATOR;
-
-        if (!file_exists($directory) && !is_dir($directory)) {
-            return $result;
-        }
-    }
-
-    if (realpath($storagePath) !== $storagePath) {
-        $directory = $directory . getCurUserHostAddress() . DIRECTORY_SEPARATOR;
-    }
-
-    if (!file_exists($directory) && !is_dir($directory)) {
-        return $result;
-    }
+    $directory = $user_directory->string();
 
     $cdir = scandir($directory);  // get all the files and folders from the directory
     $result = [];
@@ -432,21 +382,8 @@ function getStoredFiles()
  */
 function getVirtualPath($forDocumentServer)
 {
-    $configManager = new ConfigManager();
-    $storagePath = trim(str_replace(
-        ['/', '\\'],
-        '/',
-        $configManager->getConfig("storagePath")
-    ), '/');
-    $storagePath = $storagePath != "" ? $storagePath . '/' : "";
-
-    if (realpath($storagePath) === $storagePath) {
-        $virtPath = serverPath($forDocumentServer) . '/' . $storagePath . '/';
-    } else {
-        $virtPath = serverPath($forDocumentServer) . '/' . $storagePath . getCurUserHostAddress() . '/';
-    }
-    sendlog("getVirtualPath virtPath: " . $virtPath, "common.log");
-    return $virtPath;
+    $server_url = serverPath($forDocumentServer);
+    return $server_url . '/' . getCurUserHostAddress() . '/';
 }
 
 /**
@@ -689,6 +626,8 @@ function sendRequestToConvertService(
     $filePass,
     $lang
 ) {
+    $config_manager = new ConfigurationManager();
+
     if (empty($from_extension)) {
         $path_parts = pathinfo($document_uri);
         $from_extension = mb_strtolower($path_parts['extension']);
@@ -707,9 +646,7 @@ function sendRequestToConvertService(
     // generate document token
     $document_revision_id = generateRevisionId($document_revision_id);
 
-    $configManager = new ConfigManager();
-    $urlToConverter = $configManager->getConfig("docServSiteUrl").
-        $configManager->getConfig("docServConverterUrl");
+    $urlToConverter = $config_manager->document_server_converter_url()->string();
 
     $arr = [
         "async" => $is_async,
@@ -724,8 +661,7 @@ function sendRequestToConvertService(
 
     // add header token
     $headerToken = "";
-    $jwtHeader = $configManager->getConfig("docServJwtHeader") ==
-    "" ? "Authorization" : $configManager->getConfig("docServJwtHeader");
+    $jwtHeader = $config_manager->jwt_header();
 
     $jwtManager = new JwtManager();
     if ($jwtManager->isJwtEnabled() && $jwtManager->tokenUseForRequest()) {
@@ -738,7 +674,7 @@ function sendRequestToConvertService(
     // request parameters
     $opts = ['http' => [
         'method' => 'POST',
-        'timeout' => $configManager->getConfig("docServTimeout"),
+        'timeout' => $config_manager->conversion_timeout(),
         'header' => "Content-type: application/json\r\n" .
                     "Accept: application/json\r\n" .
                     (empty($headerToken) ? "" : $jwtHeader.": Bearer $headerToken\r\n"),
@@ -747,7 +683,7 @@ function sendRequestToConvertService(
     ];
 
     if (mb_substr($urlToConverter, 0, mb_strlen("https")) === "https") {
-        if ($configManager->getConfig("docServVerifyPeerOff") === true) {
+        if ($config_manager->ssl_verify_peer_mode_enabled()) {
             $opts['ssl'] = ['verify_peer' => false, 'verify_peer_name' => false];
         }
     }
@@ -890,7 +826,10 @@ function tryGetDefaultByType($createExt, $user)
 {
     $sample = isset($_GET["sample"]) && $_GET["sample"];
     $demoName = ($sample ? "sample." : "new.") . $createExt;
-    $demoPath = "assets" . DIRECTORY_SEPARATOR . ($sample ? "sample" : "new") . DIRECTORY_SEPARATOR;
+    $demoPath =
+      "assets" . DIRECTORY_SEPARATOR .
+      "document-templates" . DIRECTORY_SEPARATOR .
+      ($sample ? "sample" : "new") . DIRECTORY_SEPARATOR;
     $demoFilename = GetCorrectName($demoName);
 
     if (!@copy(dirname(__FILE__) . DIRECTORY_SEPARATOR . $demoPath . $demoName, getStoragePath($demoFilename))) {
@@ -914,9 +853,8 @@ function tryGetDefaultByType($createExt, $user)
 function getCallbackUrl($fileName)
 {
     return serverPath(true) . '/'
-        . "webeditor-ajax.php"
-        . "?type=track"
-        . "&fileName=" . urlencode($fileName)
+        . "track"
+        . "?fileName=" . urlencode($fileName)
         . "&userAddress=" . getClientIp();
 }
 
@@ -933,10 +871,9 @@ function getCreateUrl($fileName, $uid, $type)
 {
     $ext = trim(getInternalExtension($fileName), '.');
     return serverPath(false) . '/'
-        . "doceditor.php"
+        . "editor"
         . "?fileExt=" . $ext
-        . "&user=" . $uid
-        . "&type=" . $type;
+        . "&user=" . $uid;
 }
 
 /**
@@ -953,9 +890,8 @@ function getHistoryDownloadUrl($fileName, $version, $file, $isServer = true)
 {
     $userAddress = $isServer ? "&userAddress=" . getClientIp() : "";
     return serverPath($isServer) . '/'
-        . "webeditor-ajax.php"
-        . "?type=history"
-        . "&fileName=" . urlencode($fileName)
+        . "history"
+        . "?fileName=" . urlencode($fileName)
         . "&ver=" . $version
         . "&file=" . urlencode($file)
         . $userAddress;
@@ -973,9 +909,8 @@ function getDownloadUrl($fileName, $isServer = true)
 {
     $userAddress = $isServer ? "&userAddress=" . getClientIp() : "";
     return serverPath($isServer) . '/'
-        . "webeditor-ajax.php"
-        . "?type=download"
-        . "&fileName=" . urlencode($fileName)
+        . "download"
+        . "?fileName=" . urlencode($fileName)
         . $userAddress;
 }
 
@@ -992,8 +927,6 @@ function getDownloadUrl($fileName, $isServer = true)
  */
 function getHistory($filename, $filetype, $docKey, $fileuri, $isEnableDirectUrl)
 {
-    $configManager = new ConfigManager();
-    $storagePath = $configManager->getConfig("storagePath");
     $histDir = getHistoryDir(getStoragePath($filename));  // get the path to the file history
 
     if (getFileVersion($histDir) > 0) {  // check if the file was modified (the file version is greater than 0)
@@ -1034,13 +967,11 @@ function getHistory($filename, $filetype, $docKey, $fileuri, $isEnableDirectUrl)
             $directUrl = $i == $curVer ? fileUri($filename, false) :
                 getHistoryDownloadUrl($filename, $i, "prev.".$fileExe, false);
             $prevFileUrl = $i == $curVer ? $fileuri : getHistoryDownloadUrl($filename, $i, "prev.".$fileExe);
-            if (realpath($storagePath) === $storagePath) {
-                $prevFileUrl = $i == $curVer ? getDownloadUrl($filename) :
-                    getHistoryDownloadUrl($filename, $i, "prev.".$fileExe);
-                if ($isEnableDirectUrl) {
-                    $directUrl = $i == $curVer ? getDownloadUrl($filename, false) :
-                        getHistoryDownloadUrl($filename, $i, "prev.".$fileExe, false);
-                }
+            $prevFileUrl = $i == $curVer ? getDownloadUrl($filename) :
+                getHistoryDownloadUrl($filename, $i, "prev.".$fileExe);
+            if ($isEnableDirectUrl) {
+                $directUrl = $i == $curVer ? getDownloadUrl($filename, false) :
+                    getHistoryDownloadUrl($filename, $i, "prev.".$fileExe, false);
             }
 
             $dataObj["url"] = $prevFileUrl;  // write file url to the data object

web/documentserver-example/php/helpers/ConfigManager.php

@@ -20,20 +20,13 @@ namespace OnlineEditorsExamplePhp\Helpers;
 
 final class ConfigManager
 {
-    private mixed $config;
     private mixed $configFormats;
 
     public function __construct()
     {
-        $this->config = json_decode($this->getConfigurationJson());
         $this->configFormats = json_decode($this->getConfigurationFromatsJson());
     }
 
-    private function getConfigurationJson(): bool|string
-    {
-        return file_exists("./config.json") ? file_get_contents("./config.json") : false;
-    }
-
     private function getConfigurationFromatsJson(): bool|string
     {
         return file_exists("./assets/document-formats/onlyoffice-docs-formats.json")
@@ -41,18 +34,6 @@ final class ConfigManager
             : false;
     }
 
-    /**
-     * @param string|null $configName
-     * @return mixed
-     */
-    public function getConfig(string $configName = null): mixed
-    {
-        if ($configName) {
-            return $this->config->$configName ?? "";
-        }
-        return $this->config;
-    }
-
     public function getSuppotredFormats(): mixed
     {
         return $this->configFormats;

web/documentserver-example/php/helpers/JwtManager.php

@@ -18,6 +18,10 @@ namespace OnlineEditorsExamplePhp\Helpers;
  * limitations under the License.
  */
 
+use Firebase\JWT\JWT;
+use Firebase\JWT\Key;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+
 final class JwtManager
 {
     /**
@@ -27,8 +31,8 @@ final class JwtManager
      */
     public function isJwtEnabled(): bool
     {
-        $configManager = new ConfigManager();
-        return !empty($configManager->getConfig("docServJwtSecret"));
+        $config_manager = new ConfigurationManager();
+        return !empty($config_manager->jwt_secret());
     }
 
     /**
@@ -38,8 +42,8 @@ final class JwtManager
      */
     public function tokenUseForRequest(): bool
     {
-        $configManager = new ConfigManager();
-        return $configManager->getConfig("docServJwtUseForRequest") ?: false;
+        $config_manager = new ConfigurationManager();
+        return $config_manager->jwt_use_for_request() ?: false;
     }
 
     /**
@@ -51,8 +55,8 @@ final class JwtManager
      */
     public function jwtEncode($payload)
     {
-        $configManager = new ConfigManager();
-        return \Firebase\JWT\JWT::encode($payload, $configManager->getConfig("docServJwtSecret"));
+        $config_manager = new ConfigurationManager();
+        return JWT::encode($payload, $config_manager->jwt_secret(), 'HS256');
     }
 
     /**
@@ -64,12 +68,11 @@ final class JwtManager
      */
     public function jwtDecode($token)
     {
-        $configManager = new ConfigManager();
+        $config_manager = new ConfigurationManager();
         try {
-            $payload = \Firebase\JWT\JWT::decode(
+            $payload = JWT::decode(
                 $token,
-                $configManager->getConfig("docServJwtSecret"),
-                ["HS256"]
+                new Key($config_manager->jwt_secret(), 'HS256')
             );
         } catch (\UnexpectedValueException $e) {
             $payload = "";

web/documentserver-example/php/index.php

@@ -17,10 +17,140 @@
 
 namespace OnlineEditorsExamplePhp;
 
+require_once __DIR__ . '/vendor/autoload.php';
+require_once __DIR__ . '/ajax.php';
+require_once __DIR__ . '/functions.php';
+require_once __DIR__ . '/trackmanager.php';
+
+use OnlineEditorsExamplePhp\Common\HTTPStatus;
+use OnlineEditorsExamplePhp\Common\URL;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
+use OnlineEditorsExamplePhp\Views\DocEditorView;
 use OnlineEditorsExamplePhp\Views\IndexView;
 
-require_once dirname(__FILE__) . '/functions.php';
-require_once dirname(__FILE__) . '/vendor/autoload.php';
+function configure() {
+    $config_manager = new ConfigurationManager();
+    if ($config_manager->ssl_verify_peer_mode_enabled()) {
+        // Ignore self-signed certificate.
+        stream_context_set_default([
+            'ssl' => [
+                'verify_peer' => false,
+                'verify_peer_name' => false
+            ]
+        ]);
+    }
+}
 
-$indexView = new IndexView($_REQUEST);
-$indexView->render();
+function routers() {
+    // TODO: delete fallback.
+    // In theory, the content type of the response should be declared inside the
+    // router function. However, this statement isn't true for all routers, and
+    // it's also not true for all branches in all routers. Therefore, we are
+    // setting the default content type for all routers here.
+    header('Content-Type: application/json; charset=utf-8');
+
+    header('Cache-Control: no-cache, must-revalidate, max-age=0');
+    header('Expires: Wed, 11 Jan 1984 05:00:00 GMT');
+    header('Pragma: no-cache');
+    @header_remove('Last-Modified');
+    header('X-Content-Type-Options: nosniff');
+    header('X-Robots-Tag: noindex');
+
+    $url = new URL($_SERVER['REQUEST_URI']);
+    sendlog($url->string(), 'webedior-ajax.log');
+
+    $path = $url->path();
+    if (!$path || $path === '/') {
+        header('Content-Type: text/html; charset=utf-8');
+        $view = new IndexView($_REQUEST);
+        $view->render();
+        return;
+    }
+    if (str_starts_with($path, '/editor')) {
+        header('Content-Type: text/html; charset=utf-8');
+        $view = new DocEditorView($_REQUEST);
+        $view->render();
+        return;
+    }
+    if (str_starts_with($path, '/assets')) {
+        $response = assets();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/convert')) {
+        $response = convert();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/csv')) {
+        $response = csv();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/delete')) {
+        $response = delete();
+        $response['status'] = isset($response['error']) ? 'error' : 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/download')) {
+        $response = download();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/files')) {
+        $response = files();
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/history')) {
+        $response = historyDownload();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/reference')) {
+        $response = reference();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/rename')) {
+        $response = renamefile();
+        $content = json_encode($response);
+        echo $content;
+        return;
+    }
+    if (str_starts_with($path, '/restore')) {
+        $response = restore();
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/saveas')) {
+        $response = saveas();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/track')) {
+        $response = track();
+        $response['status'] = 'success';
+        echo json_encode($response);
+        return;
+    }
+    if (str_starts_with($path, '/upload')) {
+        $response = upload();
+        $response['status'] = isset($response['error']) ? 'error' : 'success';
+        echo json_encode($response);
+        return;
+    }
+
+    http_response_code(HTTPStatus::not_found->value);
+}
+
+configure();
+routers();

web/documentserver-example/php/js/jscript.js

@@ -125,7 +125,7 @@ if (typeof jQuery != "undefined") {
         jq("#filePass").val("");
 
         timer = setTimeout(function () {
-            var requestAddress = "webeditor-ajax.php?type=convert&user=" + user;
+            var requestAddress = "convert?user=" + user;
 
             jq.ajax({
                 async: true,
@@ -247,7 +247,7 @@ if (typeof jQuery != "undefined") {
 
     jq(document).on("click", "#beginEdit:not(.disable)", function () {
         var fileId = encodeURIComponent(jq('#hiddenFileName').val());
-        var url = "doceditor.php?fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
+        var url = "editor?fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
@@ -256,7 +256,7 @@ if (typeof jQuery != "undefined") {
 
     jq(document).on("click", "#beginView:not(.disable)", function () {
         var fileId = encodeURIComponent(jq('#hiddenFileName').val());
-        var url = "doceditor.php?action=view&fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
+        var url = "editor?action=view&fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
@@ -265,7 +265,7 @@ if (typeof jQuery != "undefined") {
 
     jq(document).on("click", "#beginEmbedded:not(.disable)", function () {
         var fileId = encodeURIComponent(jq('#hiddenFileName').val());
-        var url = "doceditor.php?type=embedded&fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
+        var url = "editor?type=embedded&fileID=" + fileId + "&user=" + user + "&directUrl=" + directUrl;
 
         jq("#mainProgress").addClass("embedded");
         jq("#beginEmbedded").addClass("disable");
@@ -297,7 +297,7 @@ if (typeof jQuery != "undefined") {
     jq(document).on("click", ".delete-file", function () {
         var fileName = jq(this).attr("data");
 
-        var requestAddress = "webeditor-ajax.php?type=delete&fileName=" + fileName;
+        var requestAddress = "delete?fileName=" + fileName;
 
         jq.ajax({
             async: true,

web/documentserver-example/php/lib/jwt/BeforeValidException.php

@@ -1,7 +0,0 @@
-<?php
-namespace Firebase\JWT;
-
-class BeforeValidException extends \UnexpectedValueException
-{
-
-}

web/documentserver-example/php/lib/jwt/ExpiredException.php

@@ -1,7 +0,0 @@
-<?php
-namespace Firebase\JWT;
-
-class ExpiredException extends \UnexpectedValueException
-{
-
-}

web/documentserver-example/php/lib/jwt/JWT.php

@@ -1,370 +0,0 @@
-<?php
-
-namespace Firebase\JWT;
-use \DomainException;
-use \InvalidArgumentException;
-use \UnexpectedValueException;
-use \DateTime;
-
-/**
- * JSON Web Token implementation, based on this spec:
- * http://tools.ietf.org/html/draft-ietf-oauth-json-web-token-06
- *
- * PHP version 5
- *
- * @category Authentication
- * @package  Authentication_JWT
- * @author   Neuman Vong <neuman@twilio.com>
- * @author   Anant Narayanan <anant@php.net>
- * @license  http://opensource.org/licenses/BSD-3-Clause 3-clause BSD
- * @link     https://github.com/firebase/php-jwt
- */
-class JWT
-{
-
-    /**
-     * When checking nbf, iat or expiration times,
-     * we want to provide some extra leeway time to
-     * account for clock skew.
-     */
-    public static $leeway = 0;
-
-    /**
-     * Allow the current timestamp to be specified.
-     * Useful for fixing a value within unit testing.
-     *
-     * Will default to PHP time() value if null.
-     */
-    public static $timestamp = null;
-
-    public static $supported_algs = array(
-        'HS256' => array('hash_hmac', 'SHA256'),
-        'HS512' => array('hash_hmac', 'SHA512'),
-        'HS384' => array('hash_hmac', 'SHA384'),
-        'RS256' => array('openssl', 'SHA256'),
-    );
-
-    /**
-     * Decodes a JWT string into a PHP object.
-     *
-     * @param string        $jwt            The JWT
-     * @param string|array  $key            The key, or map of keys.
-     *                                      If the algorithm used is asymmetric, this is the public key
-     * @param array         $allowed_algs   List of supported verification algorithms
-     *                                      Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
-     *
-     * @return object The JWT's payload as a PHP object
-     *
-     * @throws UnexpectedValueException     Provided JWT was invalid
-     * @throws SignatureInvalidException    Provided JWT was invalid because the signature verification failed
-     * @throws BeforeValidException         Provided JWT is trying to be used before it's eligible as defined by 'nbf'
-     * @throws BeforeValidException         Provided JWT is trying to be used before it's been created as defined by 'iat'
-     * @throws ExpiredException             Provided JWT has since expired, as defined by the 'exp' claim
-     *
-     * @uses jsonDecode
-     * @uses urlsafeB64Decode
-     */
-    public static function decode($jwt, $key, $allowed_algs = array())
-    {
-        $timestamp = is_null(static::$timestamp) ? time() : static::$timestamp;
-
-        if (empty($key)) {
-            throw new InvalidArgumentException('Key may not be empty');
-        }
-        if (!is_array($allowed_algs)) {
-            throw new InvalidArgumentException('Algorithm not allowed');
-        }
-        $tks = explode('.', $jwt);
-        if (count($tks) != 3) {
-            throw new UnexpectedValueException('Wrong number of segments');
-        }
-        list($headb64, $bodyb64, $cryptob64) = $tks;
-        if (null === ($header = static::jsonDecode(static::urlsafeB64Decode($headb64)))) {
-            throw new UnexpectedValueException('Invalid header encoding');
-        }
-        if (null === $payload = static::jsonDecode(static::urlsafeB64Decode($bodyb64))) {
-            throw new UnexpectedValueException('Invalid claims encoding');
-        }
-        $sig = static::urlsafeB64Decode($cryptob64);
-        
-        if (empty($header->alg)) {
-            throw new UnexpectedValueException('Empty algorithm');
-        }
-        if (empty(static::$supported_algs[$header->alg])) {
-            throw new UnexpectedValueException('Algorithm not supported');
-        }
-        if (!in_array($header->alg, $allowed_algs)) {
-            throw new UnexpectedValueException('Algorithm not allowed');
-        }
-        if (is_array($key) || $key instanceof \ArrayAccess) {
-            if (isset($header->kid)) {
-                $key = $key[$header->kid];
-            } else {
-                throw new UnexpectedValueException('"kid" empty, unable to lookup correct key');
-            }
-        }
-
-        // Check the signature
-        if (!static::verify("$headb64.$bodyb64", $sig, $key, $header->alg)) {
-            throw new SignatureInvalidException('Signature verification failed');
-        }
-
-        // Check if the nbf if it is defined. This is the time that the
-        // token can actually be used. If it's not yet that time, abort.
-        if (isset($payload->nbf) && $payload->nbf > ($timestamp + static::$leeway)) {
-            throw new BeforeValidException(
-                'Cannot handle token prior to ' . date(DateTime::ISO8601, $payload->nbf)
-            );
-        }
-
-        // Check that this token has been created before 'now'. This prevents
-        // using tokens that have been created for later use (and haven't
-        // correctly used the nbf claim).
-        if (isset($payload->iat) && $payload->iat > ($timestamp + static::$leeway)) {
-            throw new BeforeValidException(
-                'Cannot handle token prior to ' . date(DateTime::ISO8601, $payload->iat)
-            );
-        }
-
-        // Check if this token has expired.
-        if (isset($payload->exp) && ($timestamp - static::$leeway) >= $payload->exp) {
-            throw new ExpiredException('Expired token');
-        }
-
-        return $payload;
-    }
-
-    /**
-     * Converts and signs a PHP object or array into a JWT string.
-     *
-     * @param object|array  $payload    PHP object or array
-     * @param string        $key        The secret key.
-     *                                  If the algorithm used is asymmetric, this is the private key
-     * @param string        $alg        The signing algorithm.
-     *                                  Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
-     * @param mixed         $keyId
-     * @param array         $head       An array with header elements to attach
-     *
-     * @return string A signed JWT
-     *
-     * @uses jsonEncode
-     * @uses urlsafeB64Encode
-     */
-    public static function encode($payload, $key, $alg = 'HS256', $keyId = null, $head = null)
-    {
-        $header = array('typ' => 'JWT', 'alg' => $alg);
-        if ($keyId !== null) {
-            $header['kid'] = $keyId;
-        }
-        if ( isset($head) && is_array($head) ) {
-            $header = array_merge($head, $header);
-        }
-        $segments = array();
-        $segments[] = static::urlsafeB64Encode(static::jsonEncode($header));
-        $segments[] = static::urlsafeB64Encode(static::jsonEncode($payload));
-        $signing_input = implode('.', $segments);
-
-        $signature = static::sign($signing_input, $key, $alg);
-        $segments[] = static::urlsafeB64Encode($signature);
-
-        return implode('.', $segments);
-    }
-
-    /**
-     * Sign a string with a given key and algorithm.
-     *
-     * @param string            $msg    The message to sign
-     * @param string|resource   $key    The secret key
-     * @param string            $alg    The signing algorithm.
-     *                                  Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
-     *
-     * @return string An encrypted message
-     *
-     * @throws DomainException Unsupported algorithm was specified
-     */
-    public static function sign($msg, $key, $alg = 'HS256')
-    {
-        if (empty(static::$supported_algs[$alg])) {
-            throw new DomainException('Algorithm not supported');
-        }
-        list($function, $algorithm) = static::$supported_algs[$alg];
-        switch($function) {
-            case 'hash_hmac':
-                return hash_hmac($algorithm, $msg, $key, true);
-            case 'openssl':
-                $signature = '';
-                $success = openssl_sign($msg, $signature, $key, $algorithm);
-                if (!$success) {
-                    throw new DomainException("OpenSSL unable to sign data");
-                } else {
-                    return $signature;
-                }
-        }
-    }
-
-    /**
-     * Verify a signature with the message, key and method. Not all methods
-     * are symmetric, so we must have a separate verify and sign method.
-     *
-     * @param string            $msg        The original message (header and body)
-     * @param string            $signature  The original signature
-     * @param string|resource   $key        For HS*, a string key works. for RS*, must be a resource of an openssl public key
-     * @param string            $alg        The algorithm
-     *
-     * @return bool
-     *
-     * @throws DomainException Invalid Algorithm or OpenSSL failure
-     */
-    private static function verify($msg, $signature, $key, $alg)
-    {
-        if (empty(static::$supported_algs[$alg])) {
-            throw new DomainException('Algorithm not supported');
-        }
-
-        list($function, $algorithm) = static::$supported_algs[$alg];
-        switch($function) {
-            case 'openssl':
-                $success = openssl_verify($msg, $signature, $key, $algorithm);
-                if (!$success) {
-                    throw new DomainException("OpenSSL unable to verify data: " . openssl_error_string());
-                } else {
-                    return $signature;
-                }
-            case 'hash_hmac':
-            default:
-                $hash = hash_hmac($algorithm, $msg, $key, true);
-                if (function_exists('hash_equals')) {
-                    return hash_equals($signature, $hash);
-                }
-                $len = min(static::safeStrlen($signature), static::safeStrlen($hash));
-
-                $status = 0;
-                for ($i = 0; $i < $len; $i++) {
-                    $status |= (ord($signature[$i]) ^ ord($hash[$i]));
-                }
-                $status |= (static::safeStrlen($signature) ^ static::safeStrlen($hash));
-
-                return ($status === 0);
-        }
-    }
-
-    /**
-     * Decode a JSON string into a PHP object.
-     *
-     * @param string $input JSON string
-     *
-     * @return object Object representation of JSON string
-     *
-     * @throws DomainException Provided string was invalid JSON
-     */
-    public static function jsonDecode($input)
-    {
-        if (version_compare(PHP_VERSION, '5.4.0', '>=') && !(defined('JSON_C_VERSION') && PHP_INT_SIZE > 4)) {
-            /** In PHP >=5.4.0, json_decode() accepts an options parameter, that allows you
-             * to specify that large ints (like Steam Transaction IDs) should be treated as
-             * strings, rather than the PHP default behaviour of converting them to floats.
-             */
-            $obj = json_decode($input, false, 512, JSON_BIGINT_AS_STRING);
-        } else {
-            /** Not all servers will support that, however, so for older versions we must
-             * manually detect large ints in the JSON string and quote them (thus converting
-             *them to strings) before decoding, hence the preg_replace() call.
-             */
-            $max_int_length = strlen((string) PHP_INT_MAX) - 1;
-            $json_without_bigints = preg_replace('/:\s*(-?\d{'.$max_int_length.',})/', ': "$1"', $input);
-            $obj = json_decode($json_without_bigints);
-        }
-
-        if (function_exists('json_last_error') && $errno = json_last_error()) {
-            static::handleJsonError($errno);
-        } elseif ($obj === null && $input !== 'null') {
-            throw new DomainException('Null result with non-null input');
-        }
-        return $obj;
-    }
-
-    /**
-     * Encode a PHP object into a JSON string.
-     *
-     * @param object|array $input A PHP object or array
-     *
-     * @return string JSON representation of the PHP object or array
-     *
-     * @throws DomainException Provided object could not be encoded to valid JSON
-     */
-    public static function jsonEncode($input)
-    {
-        $json = json_encode($input);
-        if (function_exists('json_last_error') && $errno = json_last_error()) {
-            static::handleJsonError($errno);
-        } elseif ($json === 'null' && $input !== null) {
-            throw new DomainException('Null result with non-null input');
-        }
-        return $json;
-    }
-
-    /**
-     * Decode a string with URL-safe Base64.
-     *
-     * @param string $input A Base64 encoded string
-     *
-     * @return string A decoded string
-     */
-    public static function urlsafeB64Decode($input)
-    {
-        $remainder = strlen($input) % 4;
-        if ($remainder) {
-            $padlen = 4 - $remainder;
-            $input .= str_repeat('=', $padlen);
-        }
-        return base64_decode(strtr($input, '-_', '+/'));
-    }
-
-    /**
-     * Encode a string with URL-safe Base64.
-     *
-     * @param string $input The string you want encoded
-     *
-     * @return string The base64 encode of what you passed in
-     */
-    public static function urlsafeB64Encode($input)
-    {
-        return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
-    }
-
-    /**
-     * Helper method to create a JSON error.
-     *
-     * @param int $errno An error number from json_last_error()
-     *
-     * @return void
-     */
-    private static function handleJsonError($errno)
-    {
-        $messages = array(
-            JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
-            JSON_ERROR_CTRL_CHAR => 'Unexpected control character found',
-            JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON'
-        );
-        throw new DomainException(
-            isset($messages[$errno])
-            ? $messages[$errno]
-            : 'Unknown JSON error: ' . $errno
-        );
-    }
-
-    /**
-     * Get the number of bytes in cryptographic strings.
-     *
-     * @param string
-     *
-     * @return int
-     */
-    private static function safeStrlen($str)
-    {
-        if (function_exists('mb_strlen')) {
-            return mb_strlen($str, '8bit');
-        }
-        return strlen($str);
-    }
-}

web/documentserver-example/php/lib/jwt/LICENSE

@@ -1,30 +0,0 @@
-Copyright (c) 2011, Neuman Vong
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials provided
-      with the distribution.
-
-    * Neither the name of Neuman Vong nor the names of other
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

web/documentserver-example/php/lib/jwt/SignatureInvalidException.php

@@ -1,7 +0,0 @@
-<?php
-namespace Firebase\JWT;
-
-class SignatureInvalidException extends \UnexpectedValueException
-{
-
-}

web/documentserver-example/php/licenses/3rd-Party.license

@@ -31,3 +31,7 @@ License File:   jwt.license
 PHP_CodeSniffer - PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent. (https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt)
 License:        BSD-3-Clause
 License File:   PHP_CodeSniffer.license
+
+PHPUnit         - The PHP Unit Testing framework. (https://github.com/sebastianbergmann/phpunit/blob/main/LICENSE)
+License:        BSD 3-Clause
+License File:   phpunit.license

web/documentserver-example/php/licenses/phpunit.license

@@ -1,27 +1,29 @@
-Copyright (c) 2004, Jamis Buck (jamis@jamisbuck.org)
+BSD 3-Clause License
+
+Copyright (c) 2001-2023, Sebastian Bergmann
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
 
-    * The names of its contributors may not be used to endorse or promote
-      products derived from this software without specific prior written
-      permission.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

web/documentserver-example/php/php-fpm.conf

@@ -0,0 +1,13 @@
+[global]
+daemonize = no
+
+[www]
+user = www-data
+group = www-data
+listen = ${ADDRESS}:${PORT}
+pm = dynamic
+pm.max_children = 5
+pm.start_servers = 2
+pm.min_spare_servers = 1
+pm.max_spare_servers = 3
+clear_env = no

web/documentserver-example/php/phpcs.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<ruleset name="Custom Standard">
+  <description>A custom coding standard</description>
+
+  <rule ref="PSR2"/>
+
+  <rule ref="Generic.Files.LineLength">
+    <properties>
+      <property name="lineLimit" value="120"/>
+      <property name="absoluteLineLimit" value="0"/>
+    </properties>
+  </rule>
+</ruleset>

web/documentserver-example/php/ruleset.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0"?>
-<ruleset name="CustomRuleset">
-    <description>This standard changes the line length</description>
-
-    <!-- Insert all sniff from PSR2 standard -->
-    <rule ref="PSR2"/>
-
-    <rule ref="Generic.Files.LineLength">
-        <properties>
-            <property name="lineLimit" value="120"/>
-            <property name="absoluteLineLimit" value="0"/>
-        </properties>
-     </rule>
-</ruleset>

web/documentserver-example/php/templates/docEditor.tpl

@@ -103,7 +103,7 @@
 
             event.data.directUrl = !!config.document.directUrl;
             let xhr = new XMLHttpRequest();
-            xhr.open("POST", "webeditor-ajax.php?type=reference");
+            xhr.open("POST", "reference");
             xhr.setRequestHeader("Content-Type", "application/json");
             xhr.send(JSON.stringify(event.data));
             xhr.onload = function () {
@@ -161,7 +161,7 @@
                 url: url
             };
             let xhr = new XMLHttpRequest();
-            xhr.open("POST", "webeditor-ajax.php?type=saveas");
+            xhr.open("POST", "saveas");
             xhr.setRequestHeader('Content-Type', 'application/json');
             xhr.send(JSON.stringify(data));
             xhr.onload = function () {
@@ -181,7 +181,7 @@
             };
 
             let xhr = new XMLHttpRequest();
-            xhr.open("POST", "webeditor-ajax.php?type=rename");
+            xhr.open("POST", "rename");
             xhr.setRequestHeader('Content-Type', 'application/json');
             xhr.send(JSON.stringify(data));
             xhr.onload = function () {
@@ -189,6 +189,27 @@
             }
         };
 
+        function onRequestRestore(event) {
+          const query = new URLSearchParams(window.location.search)
+          const config = {config}
+          const payload = {
+            fileName: query.get('fileID'),
+            version: event.data.version,
+            userId: query.get('user') || config.editorConfig.user.id
+          }
+          const request = new XMLHttpRequest()
+          request.open("PUT", 'restore')
+          request.send(JSON.stringify(payload))
+          request.onload = function () {
+            if (request.status != 200) {
+              response = JSON.parse(request.response)
+              innerAlert(response.error)
+              return
+            }
+            document.location.reload();
+          }
+        }
+
         var сonnectEditor = function () {
             {fileNotFoundAlert}
 
@@ -208,6 +229,7 @@
                 'onRequestCompareFile': onRequestCompareFile,
                 'onRequestMailMergeRecipients': onRequestMailMergeRecipients,
                 'onRequestReferenceData': onRequestReferenceData,
+                'onRequestRestore': onRequestRestore
             };
 
                 {history}

web/documentserver-example/php/templates/index.tpl

@@ -35,19 +35,19 @@
                                 <ul class="try-editor-list clearFix">
                                     <li>
                                         <a class="try-editor word reload-page" target="_blank"
-                                           href="doceditor.php?fileExt=docx&user={user}">Document</a>
+                                           href="editor?fileExt=docx&user={user}">Document</a>
                                     </li>
                                     <li>
                                         <a class="try-editor cell reload-page" target="_blank"
-                                           href="doceditor.php?fileExt=xlsx&user={user}">Spreadsheet</a>
+                                           href="editor?fileExt=xlsx&user={user}">Spreadsheet</a>
                                     </li>
                                     <li>
                                         <a class="try-editor slide reload-page" target="_blank"
-                                           href="doceditor.php?fileExt=pptx&user={user}">Presentation</a>
+                                           href="editor?fileExt=pptx&user={user}">Presentation</a>
                                     </li>
                                     <li>
                                         <a class="try-editor form reload-page" target="_blank"
-                                           href="doceditor.php?fileExt=docxf&user={user}">Form template</a>
+                                           href="editor?fileExt=docxf&user={user}">Form template</a>
                                     </li>
                                 </ul>
                                 <label class="side-option">
@@ -58,7 +58,7 @@
                             <div class="upload-panel clearFix">
                                 <a class="file-upload">Upload file
                                     <input type="file" id="fileupload" name="files"
-                                           data-url="webeditor-ajax.php?type=upload&user={user}" />
+                                           data-url="upload?user={user}" />
                                 </a>
                             </div>
 

web/documentserver-example/php/trackmanager.php

@@ -18,6 +18,7 @@
 namespace OnlineEditorsExamplePhp;
 
 use Exception;
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\JwtManager;
 
@@ -28,6 +29,8 @@ use OnlineEditorsExamplePhp\Helpers\JwtManager;
  */
 function readBody()
 {
+    $config_manager = new ConfigurationManager();
+
     $result["error"] = 0;
     $configManager = new ConfigManager();
     $jwtManager = new JwtManager();
@@ -53,8 +56,7 @@ function readBody()
 
         $inHeader = false;
         $data = "";
-        $jwtHeader = $configManager->getConfig("docServJwtHeader") ==
-        "" ? "Authorization" : $configManager->getConfig("docServJwtHeader");
+        $jwtHeader = $config_manager->jwt_header();
 
         if (!empty($data["token"])) {  // if the document token is in the data
             $data = $jwtManager->jwtDecode($data["token"]);  // decode it
@@ -290,10 +292,10 @@ function processForceSave($data, $fileName, $userAddress)
  */
 function commandRequest($method, $key, $meta = null)
 {
-    $configManager = new ConfigManager();
+    $config_manager = new ConfigurationManager();
+
     $jwtManager = new JwtManager();
-    $documentCommandUrl = $configManager->getConfig("docServSiteUrl").
-        $configManager->getConfig("docServCommandUrl");
+    $documentCommandUrl = $config_manager->document_server_command_url()->string();
 
     $arr = [
         "c" => $method,
@@ -305,8 +307,7 @@ function commandRequest($method, $key, $meta = null)
     }
 
     $headerToken = "";
-    $jwtHeader = $configManager->getConfig("docServJwtHeader") == "" ? "Authorization" :
-        $configManager->getConfig("docServJwtHeader");
+    $jwtHeader = $config_manager->jwt_header();
 
     // check if a secret key to generate token exists or not
     if ($jwtManager->isJwtEnabled() && $jwtManager->tokenUseForRequest()) {
@@ -326,7 +327,7 @@ function commandRequest($method, $key, $meta = null)
     ]];
 
     if (mb_substr($documentCommandUrl, 0, mb_strlen("https")) === "https") {
-        if ($configManager->getConfig("docServVerifyPeerOff") === true) {
+        if ($config_manager->ssl_verify_peer_mode_enabled()) {
             $opts['ssl'] = ['verify_peer' => false, 'verify_peer_name' => false];
         }
     }

web/documentserver-example/php/views/DocEditorView.php

@@ -17,6 +17,7 @@
 
 namespace OnlineEditorsExamplePhp\Views;
 
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\ExampleUsers;
 use OnlineEditorsExamplePhp\Helpers\JwtManager;
@@ -39,6 +40,9 @@ final class DocEditorView extends View
     public function __construct($request, $tempName = "docEditor")
     {
         parent::__construct($tempName);
+
+        $config_manager = new ConfigurationManager();
+
         $externalUrl = $request["fileUrl"] ?? "";
         $confgManager = new ConfigManager();
         $jwtManager = new JwtManager();
@@ -59,15 +63,12 @@ final class DocEditorView extends View
             $filename = tryGetDefaultByType($createExt, $user);
 
             // create the demo file url
-            $new_url = "doceditor.php?fileID=" . $filename . "&user=" . $request["user"];
+            $new_url = "editor?fileID=" . $filename . "&user=" . $request["user"];
             header('Location: ' . $new_url, true);
             exit;
         }
 
         $fileuri = fileUri($filename, true);
-        $fileuriUser = realpath($confgManager->getConfig("storagePath")) ===
-        $confgManager->getConfig("storagePath") ?
-            getDownloadUrl($filename) . "&dmode=emb" : fileUri($filename);
         $directUrl = getDownloadUrl($filename, false);
         $docKey = getDocEditorKey($filename);
         $filetype = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
@@ -200,21 +201,21 @@ final class DocEditorView extends View
         // a document for comparing
         $dataCompareFile = $isEnableDirectUrl ? [
             "fileType" => "docx",
-            "url" => serverPath(true) . "/webeditor-ajax.php?type=assets&name=sample.docx",
-            "directUrl" => serverPath(false) . "/webeditor-ajax.php?type=assets&name=sample.docx",
+            "url" => serverPath(true) . "/assets?name=sample.docx",
+            "directUrl" => serverPath(false) . "/assets?name=sample.docx",
         ] : [
             "fileType" => "docx",
-            "url" => serverPath(true) . "/webeditor-ajax.php?type=assets&name=sample.docx",
+            "url" => serverPath(true) . "/assets?name=sample.docx",
         ];
 
         // recipients data for mail merging
         $dataMailMergeRecipients = $isEnableDirectUrl ? [
             "fileType" => "csv",
-            "url" => serverPath(true) . "/webeditor-ajax.php?type=csv",
-            "directUrl" => serverPath(false) . "/webeditor-ajax.php?type=csv",
+            "url" => serverPath(true) . "/csv",
+            "directUrl" => serverPath(false) . "/csv",
         ] : [
             "fileType" => "csv",
-            "url" => serverPath(true) . "/webeditor-ajax.php?type=csv",
+            "url" => serverPath(true) . "/csv",
         ];
 
         // users data for mentions
@@ -266,7 +267,7 @@ final class DocEditorView extends View
         }
         $this->tagsValues = [
             "docType" => getDocumentType($filename),
-            "apiUrl" => $confgManager->getConfig("docServSiteUrl").$confgManager->getConfig("docServApiUrl"),
+            "apiUrl" => $config_manager->document_server_api_url()->string(),
             "dataInsertImage" => mb_strimwidth(
                 json_encode($dataInsertImage),
                 1,

web/documentserver-example/php/views/IndexStoredListView.php

@@ -50,40 +50,40 @@ class IndexStoredListView extends View
                     )
                 ).']">';
                 $layout .= ' <td class="contentCells"><a class="stored-edit '.
-                    $storeFile->documentType.'" href="doceditor.php?fileID='.
+                    $storeFile->documentType.'" href="editor?fileID='.
                     urlencode($storeFile->name).
                     '&user='.$user.
                     $directUrlArg .'" target="_blank">'.'<span>'.$storeFile->name.'</span></a></td>';
                 if ($storeFile->canEdit) {
-                    $layout .= ' <td class="contentCells contentCells-icon">   <a href="doceditor.php?fileID='.
+                    $layout .= ' <td class="contentCells contentCells-icon">   <a href="editor?fileID='.
                     urlencode($storeFile->name).'&user=' . htmlentities($user).$directUrlArg.
                      '&action=edit&type=desktop" target="_blank">'.
                      '<img src="css/images/desktop.svg" alt="Open in editor for full size screens"'.
                      ' title="Open in editor for full size screens"/></a></td>'.
-                     ' <td class="contentCells contentCells-icon">  <a href="doceditor.php?fileID='.
+                     ' <td class="contentCells contentCells-icon">  <a href="editor?fileID='.
                         urlencode($storeFile->name).'&user=' . htmlentities($user).$directUrlArg.
                      '&action=edit&type=mobile" target="_blank">'.
                     '<img src="css/images/mobile.svg" alt="Open in editor for mobile devices"'.
                     ' title="Open in editor for mobile devices" /></a></td>'.
-                     ' <td class="contentCells contentCells-icon">  <a href="doceditor.php?fileID='.
+                     ' <td class="contentCells contentCells-icon">  <a href="editor?fileID='.
                         urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                     '&action=comment&type=desktop" target="_blank">'.
                     '   <img src="css/images/comment.svg" alt="Open in editor for comment"'.
                     ' title="Open in editor for comment" /></a></td>';
                     if ($storeFile->documentType == "word") {
-                        $layout .= '<td class="contentCells contentCells-icon">   <a href="doceditor.php?fileID='.
+                        $layout .= '<td class="contentCells contentCells-icon">   <a href="editor?fileID='.
                             urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                             '&action=review&type=desktop" target="_blank">'.
                         '   <img src="css/images/review.svg" alt="Open in editor for review"'.
                         ' title="Open in editor for review" /></a></td>'.
-                        ' <td class="contentCells contentCells-icon ">   <a href="doceditor.php?fileID='.
+                        ' <td class="contentCells contentCells-icon ">   <a href="editor?fileID='.
                         urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                             '&action=blockcontent&type=desktop" target="_blank">'.
                         '   <img src="css/images/block-content.svg"'.
                             ' alt="Open in editor without content control modification"'.
                         ' title="Open in editor without content control modification"</a></td>';
                     } elseif ($storeFile->documentType == "cell") {
-                        $layout .= '<td class="contentCells contentCells-icon">  <a href="doceditor.php?fileID='.
+                        $layout .= '<td class="contentCells contentCells-icon">  <a href="editor?fileID='.
                             urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                             '&action=filter&type=desktop" target="_blank">'.
                         '   <img src="css/images/filter.svg" alt="Open in editor without access to change the filter"'.
@@ -95,7 +95,7 @@ class IndexStoredListView extends View
                     if ($storeFile->isFillFormDoc) {
                         $layout.= ' <td class="contentCells contentCells-shift contentCells-icon'.
                             ' firstContentCellShift">'.
-                        '  <a href="doceditor.php?fileID='.urlencode($storeFile->name).
+                        '  <a href="editor?fileID='.urlencode($storeFile->name).
                             '&user='.htmlentities($user).$directUrlArg.
                             '&action=fillForms&type=desktop" target="_blank">'.
                         '   <img src="css/images/fill-forms.svg" alt="Open in editor for filling in forms"'.
@@ -105,7 +105,7 @@ class IndexStoredListView extends View
                         'firstContentCellShift"></td>';
                     }
                 } elseif ($storeFile->isFillFormDoc) {
-                    $layout .= '<td class="contentCells contentCells-icon">   <a href="doceditor.php?fileID='.
+                    $layout .= '<td class="contentCells contentCells-icon">   <a href="editor?fileID='.
                         urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                         '&action=fillForms&type=desktop" target="_blank">'.
                     '   <img src="css/images/mobile-fill-forms.svg" alt="Open in editor for filling in forms'.
@@ -114,7 +114,7 @@ class IndexStoredListView extends View
                     '<td class="contentCells contentCells-icon"></td>'.
                     '<td class="contentCells contentCells-icon"></td>'.
                     '<td class="contentCells contentCells-shift contentCells-icon firstContentCellShift">'.
-                    '<a href="doceditor.php?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
+                    '<a href="editor?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
                         $directUrlArg.'&action=fillForms&type=desktop" target="_blank">'.
                     '<img src="css/images/fill-forms.svg" alt="Open in editor for filling in forms"'.
                     ' title="Open in editor for filling in forms"/></a></td>';
@@ -123,22 +123,22 @@ class IndexStoredListView extends View
                         'contentCellsEmpty" colspan="6"></td>';
                 }
                 $layout .= '<td class="contentCells contentCells-icon firstContentCellViewers">'.
-                    '  <a href="doceditor.php?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
+                    '  <a href="editor?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
                         $directUrlArg.'&action=view&type=desktop" target="_blank">'.
                     '   <img src="css/images/desktop.svg" alt="Open in viewer for full size screens"'.
                     ' title="Open in viewer for full size screens" /></a></td>'.
-                    ' <td class="contentCells contentCells-icon">  <a href="doceditor.php?fileID='.
+                    ' <td class="contentCells contentCells-icon">  <a href="editor?fileID='.
                         urlencode($storeFile->name).'&user='.htmlentities($user).$directUrlArg.
                         '&action=view&type=mobile" target="_blank">'.
                     '   <img src="css/images/mobile.svg" alt="Open in viewer for mobile devices"'.
                     ' title="Open in viewer for mobile devices" /></a></td>'.
                     ' <td class="contentCells contentCells-icon contentCells-shift">'.
-                    '  <a href="doceditor.php?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
+                    '  <a href="editor?fileID='.urlencode($storeFile->name).'&user='.htmlentities($user).
                         $directUrlArg.'&action=embedded&type=embedded" target="_blank">'.
                     '   <img src="css/images/embeded.svg" alt="Open in embedded mode"'.
                     ' title="Open in embedded mode" /></a>'.
                     ' <td class="contentCells contentCells-icon contentCells-shift  downloadContentCellShift">'.
-                    '<a href="webeditor-ajax.php?type=download&fileName='.urlencode($storeFile->name).'">'.
+                    '<a href="download?fileName='.urlencode($storeFile->name).'">'.
                     '   <img class="icon-download" src="css/images/download.svg"  alt="Download" title="Download"'.
                     ' /></a></td>'.
                     '<td class="contentCells contentCells-icon contentCells-shift">'.

web/documentserver-example/php/views/IndexView.php

@@ -17,6 +17,7 @@
 
 namespace OnlineEditorsExamplePhp\Views;
 
+use OnlineEditorsExamplePhp\Configuration\ConfigurationManager;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\ExampleUsers;
 use function OnlineEditorsExamplePhp\getStoredFiles;
@@ -61,8 +62,8 @@ final class IndexView extends View
     private function getLanguageListOptionsLayout()
     {
         $layout = "";
-        $configManager = new ConfigManager();
-        foreach ($configManager->getConfig("languages") as $key => $language) {
+        $config_manager = new ConfigurationManager();
+        foreach ($config_manager->languages() as $key => $language) {
             $layout .= '<option value="'.$key.'">'.$language.'</option>'.PHP_EOL;
         }
         return $layout;
@@ -100,16 +101,12 @@ final class IndexView extends View
 
     private function getPreloaderUrl()
     {
-        $configManager = new ConfigManager();
-
-        return $configManager->getConfig("docServSiteUrl").
-        $configManager->getConfig("docServPreloaderUrl");
+        $config_manager = new ConfigurationManager();
+        return $config_manager->document_server_preloader_url()->string();
     }
 
     private function getEditButton()
     {
-        $configManager = new ConfigManager();
-        return $configManager->getConfig("mode") != "view" ?
-        '<div id="beginEdit" class="button orange disable">Edit</div>' : "";
+        return '<div id="beginEdit" class="button orange disable">Edit</div>';
     }
 }

web/documentserver-example/php/web.config

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<configuration>
-  <system.web>
-    <customErrors mode="Off"/>
-  </system.web>
-  <system.webServer>
-    <defaultDocument enabled="true" />
-    <httpErrors errorMode="Detailed"/>
-    <urlCompression doDynamicCompression="false"/>
-    <httpProtocol>
-        <customHeaders>
-            <add name="Access-Control-Allow-Origin" value="*" />
-        </customHeaders>
-    </httpProtocol>
-  </system.webServer>
-</configuration>

web/documentserver-example/php/webeditor-ajax.php

@@ -1,120 +0,0 @@
-<?php
-/**
- * (c) Copyright Ascensio System SIA 2023
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-namespace OnlineEditorsExamplePhp;
-
-use OnlineEditorsExamplePhp\Helpers\ConfigManager;
-
-/**
- * WebEditor AJAX Process Execution.
- */
-
-require_once dirname(__FILE__) . '/ajax.php';
-require_once dirname(__FILE__) . '/functions.php';
-require_once dirname(__FILE__) . '/trackmanager.php';
-require_once dirname(__FILE__) . '/vendor/autoload.php';
-
-$configManager = new ConfigManager();
-// define tracker status
-$_trackerStatus = [
-    0 => 'NotFound',
-    1 => 'Editing',
-    2 => 'MustSave',
-    3 => 'Corrupted',
-    4 => 'Closed',
-    6 => 'MustForceSave',
-    7 => 'CorruptedForceSave',
-];
-
-// ignore self-signed certificate
-if ($configManager->getConfig("docServVerifyPeerOff") === true) {
-    stream_context_set_default([
-        'ssl' => [
-            'verify_peer' => false,
-            'verify_peer_name' => false,
-        ],
-    ]);
-}
-
-// check if type value exists
-if (isset($_GET["type"]) && !empty($_GET["type"])) {
-    @header('Content-Type: application/json; charset==utf-8');
-    @header('X-Robots-Tag: noindex');
-    @header('X-Content-Type-Options: nosniff');
-
-    // set headers that prevent caching in all the browsers
-    nocacheHeaders();
-
-    // write the request result to the log file
-    sendlog(serialize($_GET), "webedior-ajax.log");
-
-    $type = $_GET["type"];
-
-    // switch case for type value
-    switch ($type) {
-        case "upload":
-            $response_array = upload();
-            $response_array['status'] = isset($response_array['error']) ? 'error' : 'success';
-            die(json_encode($response_array));
-        case "download":
-            $response_array = download();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "history":
-            $response_array = historyDownload();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "convert":
-            $response_array = convert();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "track":
-            $response_array = track();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "delete":
-            $response_array = delete();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "assets":
-            $response_array = assets();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "csv":
-            $response_array = csv();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "reference":
-            $response_array = reference();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "files":
-            $response_array = files();
-            die(json_encode($response_array));
-        case "saveas":
-            $response_array = saveas();
-            $response_array['status'] = 'success';
-            die(json_encode($response_array));
-        case "rename":
-            $response_array = renamefile();
-            die(json_encode($response_array));
-        default:
-            $response_array['status'] = 'error';
-            $response_array['error'] = '404 Method not found';
-            die(json_encode($response_array));
-    }
-}

web/documentserver-example/python/.gitignore

@@ -1,2 +1,3 @@
 *.egg-info
 build
+storage

web/documentserver-example/python/Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.11.4-alpine3.18 AS example-base
+WORKDIR /srv
+COPY . .
+RUN \
+	apk update && \
+	apk add --no-cache \
+		libmagic \
+		make
+
+FROM example-base AS example-dev
+RUN make dev
+CMD ["make", "server-dev"]
+
+FROM example-base AS example-prod
+RUN make prod
+CMD ["make", "server-prod"]
+
+FROM nginx:1.23.4-alpine3.17 AS proxy
+COPY proxy/nginx.conf /etc/nginx/nginx.conf

web/documentserver-example/python/Makefile

@@ -1,20 +1,55 @@
 .DEFAULT_GOAL := help
 
 .PHONY: help
-help: #  Show help message for each of the Makefile recipes.
-	@grep -E "^[a-z]+: #" $(MAKEFILE_LIST) | \
-		sort | \
+help: #          Show help message for each of the Makefile recipes.
+	@grep -E "^[a-z-]+: #" $(MAKEFILE_LIST) | \
 		awk 'BEGIN {FS = ": # "}; {printf "%s: %s\n", $$1, $$2}'
 
 .PHONY: dev
-dev: #   Install development dependencies.
+dev: #           Install development dependencies.
 	@pip install --editable .[development]
 
+.PHONY: prod
+prod: #          Install production dependencies.
+	@pip install .
+
+.PHONY: server-dev
+server-dev: #    Start the development server on localhost at $PORT (default: 8000).
+	@python manage.py runserver
+
+.PHONY: server-prod
+server-prod: \
+	export DEBUG := false
+server-prod: #   Start the production server on 0.0.0.0 at $PORT (default: 8000).
+	@python manage.py runserver
+
+.PHONY: compose-dev
+compose-dev: #   Up containers in a development environment.
+	@docker-compose \
+		--file compose-base.yml \
+		--file compose-dev.yml \
+		build
+	@docker-compose \
+		--file compose-base.yml \
+		--file compose-dev.yml \
+		up --detach
+
+.PHONY: compose-prod
+compose-prod: #  Up containers in a production environment.
+	@docker-compose \
+		--file compose-base.yml \
+		--file compose-prod.yml \
+		build
+	@docker-compose \
+		--file compose-base.yml \
+		--file compose-prod.yml \
+		up --detach
+
 .PHONY: lint
-lint: #  Lint the source code for style and check for types.
+lint: #          Lint the source code for style and check for types.
 	@flake8
 	@mypy .
 
-.PHONY: prod
-prod: #  Install production dependencies.
-	@pip install .
+.PHONY: test
+test: #          Recursively run the tests.
+	@python -m unittest ./src/**/*_tests.py

web/documentserver-example/python/compose-base.yml

@@ -0,0 +1,33 @@
+version: "3.8"
+
+services:
+  # document-server:
+  #   container_name: document-server
+  #   image: onlyoffice/documentserver:7.3.3.50
+  #   expose:
+  #     - "80"
+  #   environment:
+  #     - JWT_SECRET=your-256-bit-secret
+
+  example:
+    container_name: example
+    build:
+      context: .
+    expose:
+      - "80"
+    environment:
+      - ADDRESS=0.0.0.0
+      - DOCUMENT_SERVER_PRIVATE_URL=http://proxy:8080
+      - DOCUMENT_SERVER_PUBLIC_URL=http://localhost:8080
+      - EXAMPLE_URL=http://proxy
+      - JWT_SECRET=your-256-bit-secret
+      - PORT=80
+
+  proxy:
+    container_name: proxy
+    build:
+      context: .
+      target: proxy
+    ports:
+      - "80:80"
+      - "8080:8080"

web/documentserver-example/python/compose-dev.yml

@@ -0,0 +1,6 @@
+version: "3.8"
+
+services:
+  example:
+    build:
+      target: example-dev

web/documentserver-example/python/compose-prod.yml

@@ -0,0 +1,6 @@
+version: "3.8"
+
+services:
+  example:
+    build:
+      target: example-prod

web/documentserver-example/python/config.py

@@ -1,108 +0,0 @@
-import os
-
-VERSION = '1.6.0'
-
-FILE_SIZE_MAX = 5242880
-STORAGE_PATH = 'app_data'
-
-DOC_SERV_FILLFORMS = [".docx", ".oform"]
-DOC_SERV_VIEWED = [".djvu", ".oxps", ".pdf", ".xps"]  # file extensions that can be viewed
-DOC_SERV_EDITED = [                                             # file extensions that can be edited
-    ".csv", ".docm", ".docx", ".docxf", ".dotm", ".dotx",
-    ".epub", ".fb2", ".html", ".odp", ".ods", ".odt", ".otp",
-    ".ots", ".ott", ".potm", ".potx", ".ppsm", ".ppsx", ".pptm",
-    ".pptx", ".rtf", ".txt", ".xlsm", ".xlsx", ".xltm", ".xltx"
-]
-DOC_SERV_CONVERT = [                                            # file extensions that can be converted
-    ".doc", ".dot", ".dps", ".dpt", ".epub", ".et", ".ett", ".fb2",
-    ".fodp", ".fods", ".fodt", ".htm", ".html", ".mht", ".mhtml",
-    ".odp", ".ods", ".odt", ".otp", ".ots", ".ott", ".pot", ".pps",
-    ".ppt", ".rtf", ".stw", ".sxc", ".sxi", ".sxw", ".wps", ".wpt",
-    ".xls", ".xlsb", ".xlt", ".xml"
-]
-
-DOC_SERV_TIMEOUT = 120000
-
-DOC_SERV_SITE_URL = 'http://documentserver/'
-
-DOC_SERV_CONVERTER_URL = 'ConvertService.ashx'
-DOC_SERV_API_URL = 'web-apps/apps/api/documents/api.js'
-DOC_SERV_PRELOADER_URL = 'web-apps/apps/api/documents/cache-scripts.html'
-DOC_SERV_COMMAND_URL='coauthoring/CommandService.ashx'
-
-EXAMPLE_DOMAIN = None
-
-DOC_SERV_JWT_SECRET = ''  # the secret key for generating token
-DOC_SERV_JWT_HEADER = 'Authorization'
-DOC_SERV_JWT_USE_FOR_REQUEST = True
-
-DOC_SERV_VERIFY_PEER = False
-
-EXT_SPREADSHEET = [
-    ".xls", ".xlsx", ".xlsm", ".xlsb",
-    ".xlt", ".xltx", ".xltm",
-    ".ods", ".fods", ".ots", ".csv"
-]
-
-EXT_PRESENTATION = [
-    ".pps", ".ppsx", ".ppsm",
-    ".ppt", ".pptx", ".pptm",
-    ".pot", ".potx", ".potm",
-    ".odp", ".fodp", ".otp"
-]
-
-EXT_DOCUMENT = [
-    ".doc", ".docx", ".docm",
-    ".dot", ".dotx", ".dotm",
-    ".odt", ".fodt", ".ott", ".rtf", ".txt",
-    ".html", ".htm", ".mht", ".xml",
-    ".pdf", ".djvu", ".fb2", ".epub", ".xps", ".oxps", ".oform"
-]
-
-LANGUAGES = {
-    'en': 'English',
-    'hy': 'Armenian',
-    'az': 'Azerbaijani',
-    'eu': 'Basque',
-    'be': 'Belarusian',
-    'bg': 'Bulgarian',
-    'ca': 'Catalan',
-    'zh': 'Chinese (Simplified)',
-    'zh-TW': 'Chinese (Traditional)',
-    'cs': 'Czech',
-    'da': 'Danish',
-    'nl': 'Dutch',
-    'fi': 'Finnish',
-    'fr': 'French',
-    'gl': 'Galego',
-    'de': 'German',
-    'el': 'Greek',
-    'hu': 'Hungarian',
-    'id': 'Indonesian',
-    'it': 'Italian',
-    'ja': 'Japanese',
-    'ko': 'Korean',
-    'lo': 'Lao',
-    'lv': 'Latvian',
-    'ms': 'Malay (Malaysia)',
-    'no': 'Norwegian',
-    'pl': 'Polish',
-    'pt': 'Portuguese (Brazil)',
-    'pt-PT': 'Portuguese (Portugal)',
-    'ro': 'Romanian',
-    'ru': 'Russian',
-    'si': 'Sinhala (Sri Lanka)',
-    'sk': 'Slovak',
-    'sl': 'Slovenian',
-    'es': 'Spanish',
-    'sv': 'Swedish',
-    'tr': 'Turkish',
-    'uk': 'Ukrainian',
-    'vi': 'Vietnamese',
-    'aa-AA': 'Test Language'
-}
-
-if os.environ.get("EXAMPLE_DOMAIN"):  # generates a link for example domain
-    EXAMPLE_DOMAIN = os.environ.get("EXAMPLE_DOMAIN")
-if os.environ.get("DOC_SERV"):  # generates links for document server
-    DOC_SERV_SITE_URL = os.environ.get("DOC_SERV")

web/documentserver-example/python/manage.py

@@ -1,21 +1,92 @@
-#!/usr/bin/env python
-"""Django's command-line utility for administrative tasks."""
-import os
-import sys
+from os import environ
+from pathlib import Path
+from sys import argv
+from uuid import uuid1
+from django import setup
+from django.conf import settings
+from django.core.management import execute_from_command_line
+from django.core.management.commands.runserver import Command as RunServer
+from django.conf.urls.static import static
+from django.urls import path
+from src.common import string
+from src.views import actions, index
 
+def debug():
+    env = environ.get('DEBUG')
+    return string.boolean(env, True)
 
-def main():
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'src.settings')
-    try:
-        from django.core.management import execute_from_command_line
-    except ImportError as exc:
-        raise ImportError(
-            "Couldn't import Django. Are you sure it's installed and "
-            "available on your PYTHONPATH environment variable? Did you "
-            "forget to activate a virtual environment?"
-        ) from exc
-    execute_from_command_line(sys.argv)
+def address():
+    env = environ.get('ADDRESS')
+    if env is not None:
+        return env
+    if settings.DEBUG:
+        return RunServer.default_addr
+    return '0.0.0.0'
 
+def port():
+    env = environ.get('PORT')
+    if env:
+        return int(env)
+    return RunServer.default_port
+
+def configuration():
+    file = Path(__file__)
+    base_dir = file.parent
+    static_root = base_dir.joinpath('static')
+    static_url = f'{static_root.name}/'
+    return {
+        'ALLOWED_HOSTS': [
+            '*'
+        ],
+        'BASE_DIR': f'{base_dir}',
+        'DEBUG': debug(),
+        'MIDDLEWARE': [
+            'src.utils.historyManager.CorsHeaderMiddleware'
+        ],
+        'ROOT_URLCONF': __name__,
+        'SECRET_KEY': uuid1(),
+        'STATIC_ROOT': f'{static_root}',
+        'STATIC_URL': static_url,
+        'TEMPLATES': [
+            {
+                'BACKEND': 'django.template.backends.django.DjangoTemplates',
+                'DIRS': [
+                    'templates'
+                ]
+            }
+        ]
+    }
+
+def routers():
+    main = [
+        path('', index.default),
+        path('convert', actions.convert),
+        path('create', actions.createNew),
+        path('csv', actions.csv),
+        path('download', actions.download),
+        path('downloadhistory', actions.downloadhistory),
+        path('edit', actions.edit),
+        path('files', actions.files),
+        path('formats-convertible', actions.formats_convertible),
+        path('reference', actions.reference),
+        path('remove', actions.remove),
+        path('rename', actions.rename),
+        path('restore', actions.restore),
+        path('saveas', actions.saveAs),
+        path('track', actions.track),
+        path('upload', actions.upload)
+    ]
+    main += static(
+        settings.STATIC_URL,
+        document_root=settings.STATIC_ROOT
+    )
+    return main
+
+settings.configure(**configuration())
+urlpatterns = routers()
+RunServer.default_addr = address()
+RunServer.default_port = port()
+setup()
 
 if __name__ == '__main__':
-    main()
+    execute_from_command_line(argv)

web/documentserver-example/python/proxy/nginx.conf

@@ -0,0 +1,38 @@
+worker_processes auto;
+
+events {
+	worker_connections 512;
+}
+
+http {
+	include /etc/nginx/mime.types;
+
+	server {
+		listen 80;
+		server_name localhost;
+
+		location / {
+			proxy_http_version 1.1;
+			proxy_pass http://example;
+		}
+	}
+
+	# server {
+	# 	listen 8080;
+	# 	server_name localhost;
+
+	# 	location / {
+	# 		client_max_body_size 100m;
+	# 		proxy_http_version 1.1;
+	# 		proxy_pass http://document-server;
+	# 		proxy_redirect off;
+	# 		proxy_set_header Connection "upgrade";
+	# 		proxy_set_header Host $http_host;
+	# 		proxy_set_header Upgrade $http_upgrade;
+	# 		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+	# 		proxy_set_header X-Forwarded-Host $http_x_forwarded_host;
+	# 		proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+	# 		proxy_set_header X-Real-IP $remote_addr;
+	# 	}
+	# }
+}

web/documentserver-example/python/pyproject.toml

@@ -33,3 +33,6 @@ development = [
 plugins = [
 	"mypy_django_plugin.main"
 ]
+
+[tool.django-stubs]
+django_settings_module = "manage"

web/documentserver-example/python/src/codable/__init__.py

@@ -0,0 +1,35 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+'''
+The Codable module provides the ability to decode a string JSON into a class
+instance and encode it back. It also provides the ability to remap JSON keys and
+work with nested Codable instances.
+
+```python
+from dataclasses import dataclass
+from src.codable import Codable, CodingKey
+
+@dataclass
+class Fruit(Codable):
+    class CodingKeys(CodingKey):
+        native_for_python: 'foreignForPython'
+
+    native_for_python: str
+```
+'''
+
+from .codable import Codable, CodingKey

web/documentserver-example/python/src/codable/codable.py

@@ -0,0 +1,189 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from __future__ import annotations
+from copy import deepcopy
+from enum import StrEnum
+from json import JSONDecoder, JSONEncoder
+from typing import Any, Optional, Self, Type, get_args, get_origin, get_type_hints
+
+class Monkey():
+    key: str
+
+    def __init__(self, key: str = '_slugs'):
+        self.key = key
+
+    def patch(self, obj: dict[str, Any]) -> dict[str, Any]:
+        def inner(slug: list[str], value: Any):
+            if isinstance(value, dict):
+                value[self.key] = slug
+
+                for child_slug, child_value in value.items():
+                    inner(slug + [child_slug], child_value)
+
+                return
+
+            if isinstance(value, list):
+                for child_value in value:
+                    inner(slug, child_value)
+
+        copied = deepcopy(obj)
+        inner([], copied)
+        return copied
+
+    def slugs(self, obj: dict[str, Any]) -> list[str]:
+        return obj[self.key]
+
+    def clean(self, obj: dict[str, Any]) -> dict[str, Any]:
+        copied = deepcopy(obj)
+        del copied[self.key]
+        return copied
+
+class CodingKey(StrEnum):
+    @classmethod
+    def keywords(cls, obj: dict[str, Any]) -> dict[str, Any]:
+        words = {}
+
+        for pair in list(cls):
+            # Errors are false positives.
+            native = pair.name # type: ignore
+            foreign = pair.value # type: ignore
+            value = obj.get(foreign)
+            words[native] = value
+
+        return words
+
+class Codable():
+    __decoder = JSONDecoder()
+    __encoder = JSONEncoder()
+    __monkey = Monkey()
+
+    class CodingKeys(CodingKey):
+        pass
+
+    @classmethod
+    def decode(cls, content: str) -> Self:
+        decoded = cls.__decoder.decode(content)
+        patched = cls.__monkey.patch(decoded)
+        encoded = cls.__encoder.encode(patched)
+        decoder = Decoder(
+            monkey=cls.__monkey,
+            cls=cls
+        )
+        return decoder.decode(encoded)
+
+    def encode(self) -> str:
+        cls = type(self)
+        encoder = Encoder(
+            decoder=self.__decoder,
+            cls=cls
+        )
+        return encoder.encode(self)
+
+class Decoder(JSONDecoder):
+    monkey: Monkey
+    cls: Type[Codable]
+
+    def __init__(
+        self,
+        monkey: Monkey,
+        cls: Type[Codable],
+        **kwargs
+    ):
+        self.monkey = monkey
+        self.cls = cls
+        kwargs['object_hook'] = self.__object_hook
+        super().__init__(**kwargs)
+
+    def __object_hook(self, obj):
+        cls = self.cls
+
+        for foreign in self.monkey.slugs(obj):
+            native = cls.CodingKeys(foreign).name
+
+            if native is None:
+                return self.monkey.clean(obj)
+
+            types = get_type_hints(cls)
+            cls = self.__find_codable(types[native])
+
+            if cls is None:
+                return self.monkey.clean(obj)
+
+        cleaned = self.monkey.clean(obj)
+        return self.__init_codable(cls, cleaned)
+
+    def __find_codable(self, cls: Type) -> Optional[Type[Codable]]:
+        if issubclass(cls, Codable):
+            return cls
+
+        if get_origin(cls) is list:
+            item = get_args(cls)[0]
+            return self.__find_codable(item)
+
+        return None
+
+    def __init_codable(self, cls: Type[Codable], obj: dict[str, Any]) -> Codable:
+        keywords = cls.CodingKeys.keywords(obj)
+        return cls(**keywords)
+
+class Encoder(JSONEncoder):
+    decoder: JSONDecoder
+    cls: Type[Codable]
+
+    def __init__(
+        self,
+        decoder: JSONDecoder,
+        cls: Type[Codable],
+        indent: int = 2,
+        **kwargs
+    ):
+        self.decoder = decoder
+        self.cls = cls
+        kwargs['indent'] = indent
+        super().__init__(**kwargs)
+
+    def default(self, o):
+        obj = {}
+
+        for pair in list(self.cls.CodingKeys):
+            native = pair.name
+            foreign = pair.value
+
+            if not hasattr(o, native):
+                continue
+
+            value = getattr(o, native)
+            obj[foreign] = self.__prepare_value(value)
+
+        return obj
+
+    def __prepare_value(self, value: Any) -> Any:
+        if isinstance(value, Codable):
+            return self.__prepare_codable(value)
+
+        if isinstance(value, list):
+            return self.__prepare_list(value)
+
+        return value
+
+    def __prepare_codable(self, value: Codable) -> Any:
+        content = value.encode()
+        return self.decoder.decode(content)
+
+    def __prepare_list(self, value: list[Any]) -> list[Any]:
+        mapped = map(self.__prepare_value, value)
+        return list(mapped)

web/documentserver-example/python/src/codable/codable_tests.py

@@ -0,0 +1,154 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from __future__ import annotations
+from dataclasses import dataclass
+from textwrap import dedent
+from typing import Optional
+from unittest import TestCase
+from . import Codable, CodingKey
+
+@dataclass
+class Fruit(Codable):
+    class CodingKeys(CodingKey):
+        name = 'fruit_name'
+        weight = 'fruitWeight'
+        texture = 'fruit_texture'
+        vitamins = 'fruitVitamins'
+        organic = 'fruit_organic'
+
+    name: str
+    weight: int
+    texture: Optional[str]
+    vitamins: list[str]
+    organic: bool
+
+class CodablePlainTests(TestCase):
+    json = (
+        dedent(
+            '''
+            {
+              "fruit_name": "kiwi",
+              "fruitWeight": 100,
+              "fruit_texture": null,
+              "fruitVitamins": [
+                "Vitamin C",
+                "Vitamin K"
+              ],
+              "fruit_organic": true
+            }
+            '''
+        )
+            .strip()
+    )
+
+    def test_decodes(self):
+        fruit = Fruit.decode(self.json)
+        self.assertEqual(fruit.name, 'kiwi')
+        self.assertEqual(fruit.weight, 100)
+        self.assertIsNone(fruit.texture)
+        self.assertEqual(fruit.vitamins, ['Vitamin C', 'Vitamin K'])
+        self.assertTrue(fruit.organic)
+
+    def test_encodes(self):
+        fruit = Fruit(
+            name='kiwi',
+            weight=100,
+            texture=None,
+            vitamins=['Vitamin C', 'Vitamin K'],
+            organic=True
+        )
+        content = fruit.encode()
+        self.assertEqual(content, self.json)
+
+@dataclass
+class Smoothie(Codable):
+    class CodingKeys(CodingKey):
+        recipe = 'recipe'
+
+    recipe: Recipe
+
+@dataclass
+class Recipe(Codable):
+    class CodingKeys(CodingKey):
+        ingredients = 'ingredients'
+
+    ingredients: list[Ingredient]
+
+@dataclass
+class Ingredient(Codable):
+    class CodingKeys(CodingKey):
+        name = 'name'
+
+    name: str
+
+class CodableNestedTests(TestCase):
+    json = (
+        dedent(
+            '''
+            {
+              "recipe": {
+                "ingredients": [
+                  {
+                    "name": "kiwi"
+                  }
+                ]
+              }
+            }
+            '''
+        )
+            .strip()
+    )
+
+    def test_decodes(self):
+        smoothie = Smoothie.decode(self.json)
+        self.assertEqual(smoothie.recipe.ingredients[0].name, 'kiwi')
+
+    def test_encodes(self):
+        ingredient = Ingredient(name='kiwi')
+        recipe = Recipe(ingredients=[ingredient])
+        smoothie = Smoothie(recipe=recipe)
+        content = smoothie.encode()
+        self.assertEqual(content, self.json)
+
+@dataclass
+class Vegetable(Codable):
+    class CodingKeys(CodingKey):
+        name = 'name'
+
+    name: Optional[str]
+
+class CodableMissedTests(TestCase):
+    source_json = '{}'
+    distribute_json = (
+        dedent(
+            '''
+            {
+              "name": null
+            }
+            '''
+        )
+            .strip()
+    )
+
+    def test_decodes(self):
+        vegetable = Vegetable.decode(self.source_json)
+        self.assertIsNone(vegetable.name)
+
+    def test_encodes(self):
+        vegetable = Vegetable(name=None)
+        content = vegetable.encode()
+        self.assertEqual(content, self.distribute_json)

web/documentserver-example/python/src/common/__init__.py

@@ -0,0 +1,23 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+'''
+The common module is a collection of small, generic functions that are
+independent of business logic.
+'''
+
+from . import http
+from . import string

web/documentserver-example/python/src/common/http.py

@@ -0,0 +1,49 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# TODO: add types for parameters.
+# https://github.com/python/typing/discussions/946r
+
+from http import HTTPStatus, HTTPMethod
+from django.http import HttpRequest, HttpResponse
+
+def GET():
+    return method(HTTPMethod.GET)
+
+def POST():
+    return method(HTTPMethod.POST)
+
+def PUT():
+    return method(HTTPMethod.PUT)
+
+def method(meth: HTTPMethod):
+    def wrapper(func):
+        def inner(request: HttpRequest, *args, **kwargs):
+            if request.method is None:
+                return HttpResponse(
+                    status=HTTPStatus.METHOD_NOT_ALLOWED
+                )
+
+            if request.method.upper() != meth.name:
+                return HttpResponse(
+                    status=HTTPStatus.METHOD_NOT_ALLOWED
+                )
+
+            return func(request, *args, **kwargs)
+
+        return inner
+
+    return wrapper

web/documentserver-example/python/src/common/http_tests.py

@@ -0,0 +1,41 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from http import HTTPMethod, HTTPStatus
+from unittest import TestCase
+from django.conf import settings
+from django.http import HttpRequest, HttpResponse
+from . import http
+
+# Under the hood, HttpRequest uses a settings object.
+settings.configure()
+
+@http.GET()
+def endpoint(_: HttpRequest) -> HttpResponse:
+    return HttpResponse()
+
+class HTTPMethodTests(TestCase):
+    def test_returns_a_response_from_the_endpoint(self):
+        request = HttpRequest()
+        request.method = HTTPMethod.GET
+        response = endpoint(request)
+        self.assertEqual(response.status_code, HTTPStatus.OK)
+
+    def test_returns_an_error_response(self):
+        request = HttpRequest()
+        request.method = HTTPMethod.POST
+        response = endpoint(request)
+        self.assertEqual(response.status_code, HTTPStatus.METHOD_NOT_ALLOWED)

web/documentserver-example/python/src/common/string.py

@@ -0,0 +1,40 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from typing import Optional
+
+def boolean(string: Optional[str], default: bool = False) -> bool:
+    '''
+    Converts a string that represents a boolean value to its corresponding
+    boolean value. It supports case-insensitive `true`, `t`, `yes`, `y`, and `1`
+    for the positive value, and `false`, `f`, `no`, `n`, and `0` for the
+    negative value. If the string doesn't match any of these values, returns the
+    default value.
+    '''
+    if string is None:
+        return default
+
+    lower = string.lower()
+
+    positive = lower in ["true", "t", "yes", "y", "1"]
+    if positive:
+        return True
+
+    negative = lower in ["false", "f", "no", "n", "0"]
+    if negative:
+        return False
+
+    return default

web/documentserver-example/python/src/common/string_tests.py

@@ -0,0 +1,56 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from unittest import TestCase
+from .string import boolean
+
+class BooleanDefaultTests(TestCase):
+    def test_converts_to_the_default_value(self):
+        value = boolean("unknown")
+        self.assertFalse(value)
+
+    def test_converts_to_the_negative_value_by_default(self):
+        value = boolean("unknown", False)
+        self.assertFalse(value)
+
+    def test_converts_to_the_positive_value_by_default(self):
+        value = boolean("unknown", True)
+        self.assertTrue(value)
+
+class BooleanOptionalTests(TestCase):
+    def test_converts_to_the_default_value(self):
+        value = boolean(None)
+        self.assertFalse(value)
+
+    def test_converts_to_the_negative_value_by_default(self):
+        value = boolean(None, False)
+        self.assertFalse(value)
+
+    def test_converts_to_the_positive_value_by_default(self):
+        value = boolean(None, True)
+        self.assertTrue(value)
+
+class BooleanNegativeTests(TestCase):
+    def test_converts_a_negative_string_to_the_negative_value(self):
+        for string in ["false", "f", "no", "n", "0"]:
+            value = boolean(string)
+            self.assertFalse(value)
+
+class BooleanPositiveTests(TestCase):
+    def test_converts_a_positive_string_to_the_positive_value(self):
+        for string in ["true", "t", "yes", "y", "1"]:
+            value = boolean(string)
+            self.assertTrue(value)

web/documentserver-example/python/src/configuration/__init__.py

@@ -0,0 +1,17 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from .configuration import *

web/documentserver-example/python/src/configuration/configuration.py

@@ -0,0 +1,162 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from os import environ
+from pathlib import Path
+from typing import Optional
+from urllib.parse import ParseResult, urlparse, urljoin
+from src.common import string
+
+class ConfigurationManager:
+    version = '1.6.0'
+
+    def example_url(self) -> Optional[ParseResult]:
+        url = environ.get('EXAMPLE_URL')
+        if not url:
+            return None
+        return urlparse(url)
+
+    def document_server_public_url(self) -> ParseResult:
+        url = (
+            environ.get('DOCUMENT_SERVER_PUBLIC_URL') or
+            'http://document-server'
+        )
+        return urlparse(url)
+
+    def document_server_private_url(self) -> ParseResult:
+        url = environ.get('DOCUMENT_SERVER_PRIVATE_URL')
+        if not url:
+            return self.document_server_public_url()
+        return urlparse(url)
+
+    def document_server_api_url(self) -> ParseResult:
+        server_url = self.document_server_public_url()
+        base_url = server_url.geturl()
+        path = (
+            environ.get('DOCUMENT_SERVER_API_PATH') or
+            '/web-apps/apps/api/documents/api.js'
+        )
+        url = urljoin(base_url, path)
+        return urlparse(url)
+
+    def document_server_preloader_url(self) -> ParseResult:
+        server_url = self.document_server_public_url()
+        base_url = server_url.geturl()
+        path = (
+            environ.get('DOCUMENT_SERVER_PRELOADER_PATH') or
+            '/web-apps/apps/api/documents/cache-scripts.html'
+        )
+        url = urljoin(base_url, path)
+        return urlparse(url)
+
+    def document_server_command_url(self) -> ParseResult:
+        server_url = self.document_server_private_url()
+        base_url = server_url.geturl()
+        path = (
+            environ.get('DOCUMENT_SERVER_COMMAND_PATH') or
+            '/coauthoring/CommandService.ashx'
+        )
+        url = urljoin(base_url, path)
+        return urlparse(url)
+
+    def document_server_converter_url(self) -> ParseResult:
+        server_url = self.document_server_private_url()
+        base_url = server_url.geturl()
+        path = (
+            environ.get('DOCUMENT_SERVER_CONVERTER_PATH') or
+            '/ConvertService.ashx'
+        )
+        url = urljoin(base_url, path)
+        return urlparse(url)
+
+    def jwt_secret(self) -> str:
+        return environ.get('JWT_SECRET') or ''
+
+    def jwt_header(self) -> str:
+        return environ.get('JWT_HEADER') or 'Authorization'
+
+    def jwt_use_for_request(self) -> bool:
+        use = environ.get('JWT_USE_FOR_REQUEST')
+        return string.boolean(use, True)
+
+    def ssl_verify_peer_mode_enabled(self) -> bool:
+        enabled = environ.get('SSL_VERIFY_PEER_MODE_ENABLED')
+        return string.boolean(enabled, False)
+
+    def storage_path(self) -> Path:
+        storage_path = environ.get('STORAGE_PATH') or 'storage'
+        storage_directory = Path(storage_path)
+        if storage_directory.is_absolute():
+            return storage_directory
+        file = Path(__file__)
+        directory = file.parent.joinpath('../..', storage_directory)
+        return directory.resolve()
+
+    def maximum_file_size(self) -> int:
+        size = environ.get('MAXIMUM_FILE_SIZE')
+        if size:
+            return int(size)
+        return 5 * 1024 * 1024
+
+    def conversion_timeout(self) -> int:
+        timeout = environ.get('CONVERSION_TIMEOUT')
+        if timeout:
+            return int(timeout)
+        return 120 * 1000
+
+    def languages(self) -> dict[str, str]:
+        return {
+            'en': 'English',
+            'hy': 'Armenian',
+            'az': 'Azerbaijani',
+            'eu': 'Basque',
+            'be': 'Belarusian',
+            'bg': 'Bulgarian',
+            'ca': 'Catalan',
+            'zh': 'Chinese (Simplified)',
+            'zh-TW': 'Chinese (Traditional)',
+            'cs': 'Czech',
+            'da': 'Danish',
+            'nl': 'Dutch',
+            'fi': 'Finnish',
+            'fr': 'French',
+            'gl': 'Galego',
+            'de': 'German',
+            'el': 'Greek',
+            'hu': 'Hungarian',
+            'id': 'Indonesian',
+            'it': 'Italian',
+            'ja': 'Japanese',
+            'ko': 'Korean',
+            'lo': 'Lao',
+            'lv': 'Latvian',
+            'ms': 'Malay (Malaysia)',
+            'no': 'Norwegian',
+            'pl': 'Polish',
+            'pt': 'Portuguese (Brazil)',
+            'pt-PT': 'Portuguese (Portugal)',
+            'ro': 'Romanian',
+            'ru': 'Russian',
+            'si': 'Sinhala (Sri Lanka)',
+            'sk': 'Slovak',
+            'sl': 'Slovenian',
+            'es': 'Spanish',
+            'sv': 'Swedish',
+            'tr': 'Turkish',
+            'uk': 'Ukrainian',
+            'vi': 'Vietnamese',
+            'aa-AA': 'Test Language'
+        }

web/documentserver-example/python/src/configuration/configuration_tests.py

@@ -0,0 +1,296 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from os import environ
+from unittest import TestCase
+from unittest.mock import patch
+from urllib.parse import urlparse
+from . import ConfigurationManager
+
+class ConfigurationManagerTests(TestCase):
+    def test_corresponds_the_latest_version(self):
+        config_manager = ConfigurationManager()
+        self.assertEqual(config_manager.version, '1.6.0')
+
+class ConfigurationManagerExampleURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.example_url()
+        self.assertIsNone(url)
+
+    @patch.dict(environ, {
+        'EXAMPLE_URL': 'http://localhost'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.example_url()
+        self.assertEqual(url.geturl(), 'http://localhost')
+
+class ConfigurationManagerDocumentServerPublicURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_public_url()
+        self.assertEqual(url.geturl(), 'http://document-server')
+
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_PUBLIC_URL': 'http://localhost'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_public_url()
+        self.assertEqual(url.geturl(), 'http://localhost')
+
+class ConfigurationManagerDocumentServerPrivateURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_private_url()
+        self.assertEqual(url.geturl(), 'http://document-server')
+
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_PRIVATE_URL': 'http://localhost'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_private_url()
+        self.assertEqual(url.geturl(), 'http://localhost')
+
+class ConfigurationManagerDocumentServerAPIURLTests(TestCase):
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    def test_assigns_a_default_value(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_api_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/web-apps/apps/api/documents/api.js'
+        )
+
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_API_PATH': '/api'
+    })
+    def test_assigns_a_value_from_the_environment(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_api_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/api'
+        )
+
+class ConfigurationManagerDocumentServerPreloaderURLTests(TestCase):
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    def test_assigns_a_default_value(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_preloader_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/web-apps/apps/api/documents/cache-scripts.html'
+        )
+
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_PRELOADER_PATH': '/preloader'
+    })
+    def test_assigns_a_value_from_the_environment(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_preloader_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/preloader'
+        )
+
+class ConfigurationManagerDocumentServerCommandURLTests(TestCase):
+    @patch.object(
+        ConfigurationManager,
+        'document_server_private_url',
+        return_value=urlparse('http://localhost')
+    )
+    def test_assigns_a_default_value(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_command_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/coauthoring/CommandService.ashx'
+        )
+
+    @patch.object(
+        ConfigurationManager,
+        'document_server_private_url',
+        return_value=urlparse('http://localhost')
+    )
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_COMMAND_PATH': '/command'
+    })
+    def test_assigns_a_value_from_the_environment(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_command_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/command'
+        )
+
+class ConfigurationManagerDocumentServerConverterURLTests(TestCase):
+    @patch.object(
+        ConfigurationManager,
+        'document_server_private_url',
+        return_value=urlparse('http://localhost')
+    )
+    def test_assigns_a_default_value(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_converter_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/ConvertService.ashx'
+        )
+
+    @patch.object(
+        ConfigurationManager,
+        'document_server_private_url',
+        return_value=urlparse('http://localhost')
+    )
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_CONVERTER_PATH': '/converter'
+    })
+    def test_assigns_a_value_from_the_environment(self, _):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_converter_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://localhost/converter'
+        )
+
+class ConfigurationManagerJWTSecretTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        secret = config_manager.jwt_secret()
+        self.assertEqual(secret, '')
+
+    @patch.dict(environ, {
+        'JWT_SECRET': 'your-256-bit-secret'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        secret = config_manager.jwt_secret()
+        self.assertEqual(secret, 'your-256-bit-secret')
+
+class ConfigurationManagerJWTHeaderTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        header = config_manager.jwt_header()
+        self.assertEqual(header, 'Authorization')
+
+    @patch.dict(environ, {
+        'JWT_HEADER': 'Proxy-Authorization'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        header = config_manager.jwt_header()
+        self.assertEqual(header, 'Proxy-Authorization')
+
+class ConfigurationManagerJWTUseForRequest(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        use = config_manager.jwt_use_for_request()
+        self.assertTrue(use)
+
+    @patch.dict(environ, {
+        'JWT_USE_FOR_REQUEST': 'false'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        use = config_manager.jwt_use_for_request()
+        self.assertFalse(use)
+
+class ConfigurationManagerSSLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        enabled = config_manager.ssl_verify_peer_mode_enabled()
+        self.assertFalse(enabled)
+
+    @patch.dict(environ, {
+        'SSL_VERIFY_PEER_MODE_ENABLED': 'true'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        enabled = config_manager.ssl_verify_peer_mode_enabled()
+        self.assertTrue(enabled)
+
+class ConfigurationManagerStoragePathTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        path = config_manager.storage_path()
+        self.assertTrue(path.is_absolute())
+        self.assertEqual(path.name, 'storage')
+
+    @patch.dict(environ, {
+        'STORAGE_PATH': 'directory'
+    })
+    def test_assigns_a_relative_path_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        path = config_manager.storage_path()
+        self.assertTrue(path.is_absolute())
+        self.assertEqual(path.name, 'directory')
+
+    @patch.dict(environ, {
+        'STORAGE_PATH': '/directory'
+    })
+    def test_assigns_an_absolute_path_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        path = config_manager.storage_path()
+        self.assertEqual(f'{path}', '/directory')
+
+class ConfigurationManagerMaximumFileSizeTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        size = config_manager.maximum_file_size()
+        self.assertEqual(size, 5_242_880)
+
+    @patch.dict(environ, {
+        'MAXIMUM_FILE_SIZE': '10'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        size = config_manager.maximum_file_size()
+        self.assertEqual(size, 10)
+
+class ConfigurationManagerConversionTimeoutTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        timeout = config_manager.conversion_timeout()
+        self.assertEqual(timeout, 120_000)
+
+    @patch.dict(environ, {
+        'CONVERSION_TIMEOUT': '10'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        timeout = config_manager.conversion_timeout()
+        self.assertEqual(timeout, 10)

web/documentserver-example/python/src/format/__init__.py

@@ -0,0 +1,17 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from .format import *

web/documentserver-example/python/src/format/format.py

@@ -0,0 +1,177 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from dataclasses import dataclass
+from json import dumps, loads
+from pathlib import Path
+from src.codable import Codable, CodingKey
+
+@dataclass
+class Format(Codable):
+    class CodingKeys(CodingKey):
+        name = 'name'
+        type = 'type'
+        actions = 'actions'
+        convert = 'convert'
+        mime = 'mime'
+
+    name: str
+    type: str
+    actions: list[str]
+    convert: list[str]
+    mime: list[str]
+
+    def extension(self) -> str:
+        return f'.{self.name}'
+
+class FormatManager():
+    def spreadsheet_extensions(self) -> list[str]:
+        formats = self.spreadsheets()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def spreadsheets(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(lambda format: format.type == 'cell', formats)
+        return list(mapped)
+
+    def presentation_extensions(self) -> list[str]:
+        formats = self.presentations()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def presentations(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(lambda format: format.type == 'slide', formats)
+        return list(mapped)
+
+    def document_extensions(self) -> list[str]:
+        formats = self.documents()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def documents(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(lambda format: format.type == 'word', formats)
+        return list(mapped)
+
+    def fillable_extensions(self) -> list[str]:
+        formats = self.fillable()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def fillable(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(lambda format: 'fill' in format.actions, formats)
+        return list(mapped)
+
+    def viewable_extensions(self) -> list[str]:
+        formats = self.viewable()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def viewable(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(lambda format: 'view' in format.actions, formats)
+        return list(mapped)
+
+    def editable_extensions(self) -> list[str]:
+        formats = self.editable()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def editable(self) -> list[Format]:
+        formats = self.all()
+        mapped = filter(
+            lambda format: (
+                'edit' in format.actions or
+                'lossy-edit' in format.actions
+            ),
+            formats
+        )
+        return list(mapped)
+
+    def convertible_to_names(self, extension) -> list[str]:
+        formats = self.convertible_to(extension)
+        mapped = map(lambda format: format.name, formats)
+        return list(mapped)
+
+    def convertible_to(self, extension) -> list[Format]:
+        formats = self.all()
+        filtered: list[Format] = []
+        names: list[str] = []
+
+        for format in formats:
+            if format.extension() == extension:
+                names = format.convert
+                break
+
+        for name in names:
+            for format in formats:
+                if format.name == name:
+                    filtered.append(format)
+                    break
+
+        return list(filtered)
+
+    def convertible_extensions(self) -> list[str]:
+        formats = self.convertible()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def convertible(self) -> list[Format]:
+        formats = self.all()
+        filtered = filter(
+            lambda format: (
+                format.type == 'cell' and 'xlsx' in format.convert or
+                format.type == 'slide' and 'pptx' in format.convert or
+                format.type == 'word' and 'docx' in format.convert
+            ),
+            formats
+        )
+        return list(filtered)
+
+    def all_extensions(self) -> list[str]:
+        formats = self.all()
+        mapped = map(lambda format: format.extension(), formats)
+        return list(mapped)
+
+    def all(self) -> list[Format]:
+        path = self.__file()
+        formats: list[Format] = []
+        with open(path, 'r', encoding='utf-8') as file:
+            content = file.read()
+            array = loads(content)
+            for obj in array:
+                raw = dumps(obj)
+                decoded = Format.decode(raw)
+                formats.append(decoded)
+        return formats
+
+    def __file(self) -> Path:
+        directory = self.__directory()
+        return directory.joinpath('onlyoffice-docs-formats.json')
+
+    def __directory(self) -> Path:
+        current_file = Path(__file__)
+        directory = current_file.joinpath(
+            '..',
+            '..',
+            '..',
+            'assets',
+            'document-formats'
+        )
+        return directory.resolve()

web/documentserver-example/python/src/format/format_tests.py

@@ -0,0 +1,104 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from __future__ import annotations
+from unittest import TestCase
+from . import Format, FormatManager
+
+class FormatTests(TestCase):
+    json = \
+        '''
+        {
+          "name": "djvu",
+          "type": "word",
+          "actions": ["view"],
+          "convert": ["bmp", "gif", "jpg", "pdf", "pdfa", "png"],
+          "mime": ["image/vnd.djvu"]
+        }
+        '''
+
+    def test_generates_extension(self):
+        form = Format.decode(self.json)
+        self.assertEqual(form.extension(), '.djvu')
+
+class FormatManagerAllTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.all()
+        empty = len(formats) == 0
+        self.assertFalse(empty)
+
+class FormatManagerDocumentsTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.documents()
+        mapped = map(lambda format: format.type == 'word', formats)
+        self.assertTrue(all(mapped))
+
+class FormatManagerPresentationsTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.presentations()
+        mapped = map(lambda format: format.type == 'slide', formats)
+        self.assertTrue(all(mapped))
+
+class FormatManagerSpreadsheetsTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.spreadsheets()
+        mapped = map(lambda format: format.type == 'cell', formats)
+        self.assertTrue(all(mapped))
+
+class FormatManagerConvertibleTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.convertible()
+        mapped = map(
+            lambda format: (
+                format.type == 'cell' and 'xlsx' in format.actions or
+                format.type == 'slide' and 'pptx' in format.actions or
+                format.type == 'word' and 'docx' in format.actions
+            ),
+            formats
+        )
+        self.assertTrue(all(mapped))
+
+class FormatManagerEditableTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.editable()
+        mapped = map(
+            lambda format: (
+                'edit' in format.actions or
+                'lossy-edit' in format.actions
+            ),
+            formats
+        )
+        self.assertTrue(all(mapped))
+
+class FormatManagerViewableTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.viewable()
+        mapped = map(lambda format: 'view' in format.actions, formats)
+        self.assertTrue(all(mapped))
+
+class FormatManagerFillableTests(TestCase):
+    def test_loads(self):
+        format_manager = FormatManager()
+        formats = format_manager.fillable()
+        mapped = map(lambda format: 'fill' in format.actions, formats)
+        self.assertTrue(all(mapped))

web/documentserver-example/python/src/proxy/__init__.py

@@ -0,0 +1,17 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from .proxy import *

web/documentserver-example/python/src/proxy/proxy.py

@@ -0,0 +1,48 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from urllib.parse import ParseResult
+from src.configuration import ConfigurationManager
+
+class ProxyManager():
+    config_manager: ConfigurationManager
+
+    def __init__(self, config_manager: ConfigurationManager):
+        self.config_manager = config_manager
+
+    def resolve_url(self, url: ParseResult) -> ParseResult:
+        if not self.__refer_public_url(url):
+            return url
+        return self.__redirect_public_url(url)
+
+    def __refer_public_url(self, url: ParseResult) -> bool:
+        public_url = self.config_manager.document_server_public_url()
+        return (
+            url.scheme == public_url.scheme and
+            url.hostname == public_url.hostname and
+            url.port == public_url.port
+        )
+
+    def __redirect_public_url(self, url: ParseResult) -> ParseResult:
+        private_url = self.config_manager.document_server_private_url()
+        return ParseResult(
+            scheme=private_url.scheme,
+            netloc=private_url.netloc,
+            path=url.path,
+            params=url.params,
+            query=url.query,
+            fragment=url.fragment
+        )

web/documentserver-example/python/src/proxy/proxy_tests.py

@@ -0,0 +1,63 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from unittest import TestCase
+from unittest.mock import patch
+from urllib.parse import urlparse
+from src.configuration import ConfigurationManager
+from . import ProxyManager
+
+class ProxyManagerTests(TestCase):
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    @patch.object(
+        ConfigurationManager,
+        'document_server_private_url',
+        return_value=urlparse('http://proxy')
+    )
+    def test_resolves_a_url_that_refers_to_the_public_url(self, *_):
+        config_manager = ConfigurationManager()
+        proxy_manager = ProxyManager(config_manager)
+
+        raw_url = 'http://localhost/endpoint?query=string'
+        url = urlparse(raw_url)
+        resolved_url = proxy_manager.resolve_url(url)
+
+        self.assertEqual(
+            resolved_url.geturl(),
+            'http://proxy/endpoint?query=string'
+        )
+
+    @patch.object(
+        ConfigurationManager,
+        'document_server_public_url',
+        return_value=urlparse('http://localhost')
+    )
+    def test_resolves_a_url_that_does_not_refers_to_the_public_url(self, *_):
+        config_manager = ConfigurationManager()
+        proxy_manager = ProxyManager(config_manager)
+
+        raw_url = 'http://proxy/endpoint?query=string'
+        url = urlparse(raw_url)
+        resolved_url = proxy_manager.resolve_url(url)
+
+        self.assertEqual(
+            resolved_url.geturl(),
+            'http://proxy/endpoint?query=string'
+        )

web/documentserver-example/python/src/response/__init__.py

@@ -0,0 +1,17 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from .response import *

web/documentserver-example/python/src/response/response.py

@@ -0,0 +1,32 @@
+#
+# (c) Copyright Ascensio System SIA 2023
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from http import HTTPStatus
+from json import dumps
+from django.http import HttpResponse
+
+class ErrorResponse(HttpResponse):
+    def __init__(self, message: str, status: HTTPStatus):
+        payload = {
+            'error': message,
+            'success': False
+        }
+        content = dumps(payload)
+        super().__init__(
+            content,
+            content_type='application/json',
+            status=status
+        )

web/documentserver-example/python/src/settings.py

@@ -1,103 +0,0 @@
-"""
-Django settings for example project.
-
-Generated by 'django-admin startproject' using Django 2.2.6.
-
-For more information on this file, see
-https://docs.djangoproject.com/en/3.1/topics/settings/
-
-For the full list of settings and their values, see
-https://docs.djangoproject.com/en/3.1/ref/settings/
-"""
-
-import os
-import config
-import mimetypes
-
-# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-
-
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = '7a5qnm_bv)iskjhx%4cbwwdmjev03%zewm=3@4s*uz)el#ds5o'
-
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
-
-ALLOWED_HOSTS = [
-    '*'
-]
-
-X_FRAME_OPTIONS = 'ALLOWALL'
-XS_SHARING_ALLOWED_METHODS = ['GET']
-
-# Application definition
-
-INSTALLED_APPS = [
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-]
-
-MIDDLEWARE = [
-    'src.utils.historyManager.CorsHeaderMiddleware',
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
-]
-
-ROOT_URLCONF = 'src.urls'
-
-TEMPLATES = [
-    {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [ 'templates' ],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-            ],
-        },
-    },
-]
-
-WSGI_APPLICATION = 'src.wsgi.application'
-
-
-# Database
-# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
-
-DATABASES = {}
-
-
-# Password validation
-# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators
-
-AUTH_PASSWORD_VALIDATORS = []
-
-
-# Internationalization
-# https://docs.djangoproject.com/en/3.1/topics/i18n/
-
-LANGUAGE_CODE = 'en-us'
-
-TIME_ZONE = 'UTC'
-
-USE_I18N = True
-
-USE_L10N = True
-
-USE_TZ = True
-
-
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/3.1/howto/static-files/
-
-mimetypes.add_type("text/javascript", ".js", True)
-STATIC_ROOT = ''
-STATIC_URL = '/static/'
-STATICFILES_DIRS = ( os.path.join('static'), os.path.join(config.STORAGE_PATH),  os.path.join('assets/sample'))

web/documentserver-example/python/src/urls.py

@@ -1,41 +0,0 @@
-"""
-
- (c) Copyright Ascensio System SIA 2023
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
-"""
-
-from django.urls import path, re_path
-
-from src.views import index, actions
-from django.contrib.staticfiles.urls import staticfiles_urlpatterns
-
-urlpatterns = [
-    path('', index.default),
-    path('upload', actions.upload),
-    path('download', actions.download),
-    path('downloadhistory', actions.downloadhistory),
-    path('convert', actions.convert),
-    path('create', actions.createNew),
-    path('edit', actions.edit),
-    path('track', actions.track),
-    path('remove', actions.remove),
-    path('csv', actions.csv),
-    path('files', actions.files),
-    path('saveas', actions.saveAs),
-    path('rename', actions.rename),
-    path('reference', actions.reference)
-]
-
-urlpatterns += staticfiles_urlpatterns()