Merge pull request #422 from ONLYOFFICE/feature/php-normalize-dependencies

php: pin and normalize existing dependencies, add new ones

.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

@@ -1,15 +1,7 @@
-[submodule "web/documentserver-example/nodejs/public/assets"]
-	path = web/documentserver-example/nodejs/public/assets
-	url = https://github.com/ONLYOFFICE/document-templates
-	branch = main/en
 [submodule "web/documentserver-example/java/src/main/resources/assets"]
 	path = web/documentserver-example/java/src/main/resources/assets
 	url = https://github.com/ONLYOFFICE/document-templates
 	branch = main/en
-[submodule "web/documentserver-example/php/assets"]
-	path = web/documentserver-example/php/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
@@ -30,3 +22,19 @@
 	path = web/documentserver-example/java-spring/src/main/resources/assets
 	url = https://github.com/ONLYOFFICE/document-templates
 	branch = main/en
+[submodule "web/documentserver-example/nodejs/public/assets/document-templates"]
+	path = web/documentserver-example/nodejs/public/assets/document-templates
+	url = https://github.com/ONLYOFFICE/document-templates
+	branch = main/en
+[submodule "web/documentserver-example/nodejs/public/assets/document-formats"]
+	path = web/documentserver-example/nodejs/public/assets/document-formats
+	url = https://github.com/ONLYOFFICE/document-formats
+	branch = master
+[submodule "web/documentserver-example/php/assets/document-templates"]
+	path = web/documentserver-example/php/assets/document-templates
+	url = https://github.com/ONLYOFFICE/document-templates
+	branch = main/en
+[submodule "web/documentserver-example/php/assets/document-formats"]
+	path = web/documentserver-example/php/assets/document-formats
+	url = https://github.com/ONLYOFFICE/document-formats
+	branch = master

3rd-Party.license

@@ -3,10 +3,6 @@ Document Server integration example uses code from the following 3rd party proje
 
 web/documentserver-example/csharp
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -19,14 +15,26 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+JWT           - JWT (JSON Web Token) Implementation for .NET (Public Domain) (https://github.com/jwt-dotnet/jwt/)
+License:        MIT
+License File:   JWT.license
+
+Newtonsoft.Json - Json.NET is a popular high-performance JSON framework for .NET (https://github.com/JamesNK/Newtonsoft.Json)
+License:        MIT
+License File:   Newtonsoft.Json.license
+
 
 web/documentserver-example/csharp-mvc
 
@@ -34,10 +42,6 @@ Entity Framework - Entity Framework is an object-relational mapper that enables
 License:        MICROSOFT SOFTWARE SUPPLEMENTAL TERMS, MICROSOFT SOFTWARE LICENSE TERMS
 License File:   EntityFramework.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -50,19 +54,27 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+JWT           - JWT (JSON Web Token) Implementation for .NET (Public Domain) (https://github.com/jwt-dotnet/jwt/)
+License:        MIT
+License File:   JWT.license
+
 Microsoft.Web.Infrastructure - This package contains the Microsoft.Web.Infrastructure assembly that lets you dynamically register HTTP modules at run time. (https://www.microsoft.com/web/webpi/eula/aspnetmvc3update-eula.htm)
 License:        MS-EULA License
 License File:   Microsoft.Web.Infrastructure.license
 
-Newtonsoft.Json - Json.NET is a popular high-performance JSON framework for .NET (https://licenses.nuget.org/MIT)
+Newtonsoft.Json - Json.NET is a popular high-performance JSON framework for .NET (https://github.com/JamesNK/Newtonsoft.Json)
 License:        MIT
 License File:   Newtonsoft.Json.license
 
@@ -73,10 +85,6 @@ License File:   WebGrease.license
 
 web/documentserver-example/java
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -89,9 +97,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -104,9 +116,17 @@ License File:   prime-jwt.license
 
 web/documentserver-example/java-spring
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
+Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   gson.license
+
+H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
+License:        MPL 2.0 or EPL 1.0
+License File:   h2database.license
+
+Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   jackson-databind.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -120,14 +140,30 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
+License:        Apache 2.0
+License File:   JSON.simple.license
+
+Project Lombok - Project Lombok is a java library that automatically plugs into your editor and build tools. (https://mvnrepository.com/artifact/org.projectlombok/lombok).
+License:        MIT
+License File    lombok.license
+
+ModelMapper   - ModelMapper is an intelligent object mapping library that automatically maps objects to each other. (https://github.com/modelmapper/modelmapper)
+License:        Apache 2.0
+License File    modelmapper.license
+
 Prime JWT     - is intended to be fast and easy to use. Prime JWT has a single external dependency on Jackson. (https://github.com/ws-apps/prime-jwt/blob/master/LICENSE)
 License:        Apache 2.0
 License File:   prime-jwt.license
@@ -148,22 +184,6 @@ Spring Data JPA - Persist data in SQL stores with Java Persistence API using Spr
 License:        Apache 2.0
 License File:   spring-data-jpa.license
 
-H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
-License:        MPL 2.0 or EPL 1.0
-License File:   h2database.license
-
-JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
-License:        Apache 2.0
-License File:   JSON.simple.license
-
-Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   gson.license
-
-Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   jackson-databind.license
-
 
 web/documentserver-example/nodejs
 
@@ -199,10 +219,6 @@ he            - a robust HTML entity encoder/decoder written in JavaScript. (htt
 License:        MIT
 License File:   he.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -215,9 +231,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -248,11 +268,8 @@ License:        MIT
 License File:   urllib.license
 
 
-web/documentserver-example/php
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
+web/documentserver-example/php
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -266,9 +283,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -282,16 +303,24 @@ 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
 
+django-stubs  - PEP-484 stubs for Django. (https://github.com/typeddjango/django-stubs/blob/master/LICENSE.md)
+License:        MIT
+License File:   django-stubs.license
+
 Django        - Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out. (https://github.com/django/django/blob/main/LICENSE)
 License:        BSD-3-Clause
 License File:   Django.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+flake8        - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code. (https://github.com/PyCQA/flake8/blob/main/LICENSE)
 License:        MIT
-License File:   jQuery.license
+License File:   flake8.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -305,57 +334,22 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
-jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
-
-jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.UI.license
-
-PyJWT         - A Python implementation of RFC 7519. (https://github.com/jpadilla/pyjwt/blob/master/LICENSE)
-License:        MIT
-License File:   PyJWT.license
-
-python-magic  - python-magic is a Python interface to the libmagic file type identification library. (https://github.com/ahupp/python-magic/blob/master/LICENSE)
-License:        MIT
-License File:   python-magic.license
-
-requests      - Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your PUT & POST data — but nowadays, just use the json method! (https://github.com/psf/requests/blob/main/LICENSE)
-License:        Apache 2.0
-License File:   requests.license
-
-
-web/documentserver-example/python
-
-Django        - Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out. (https://github.com/django/django/blob/main/LICENSE)
-License:        BSD-3-Clause
-License File:   Django.license
-
 jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.license
 
-jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
-License:        MIT, GPL
-License File:   jQuery.BlockUI.license
-
-jQuery.FileUpload - File Upload widget with multiple file selection, drag&drop support, progress bar, validation and preview images, audio and video for jQuery. Supports cross-domain, chunked and resumable file uploads. Works with any server-side platform (Google App Engine, PHP, Python, Ruby on Rails, Java, etc.) that supports standard HTML form file uploads. (https://github.com/blueimp/jQuery-File-Upload/blob/master/LICENSE.txt)
-License:        MIT
-License File:   jQuery.FileUpload.license
-
-jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https://github.com/blueimp/jQuery-File-Upload/blob/master/LICENSE.txt)
-License:        MIT
-License File:   jQuery.iframe-transport.license
-
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+mypy          - Optional static typing for Python. (https://github.com/python/mypy/blob/master/LICENSE)
+License:        MIT
+License File:   mypy.license
+
 PyJWT         - A Python implementation of RFC 7519. (https://github.com/jpadilla/pyjwt/blob/master/LICENSE)
 License:        MIT
 License File:   PyJWT.license
@@ -368,6 +362,10 @@ requests      - Requests allows you to send HTTP/1.1 requests extremely easily.
 License:        Apache 2.0
 License File:   requests.license
 
+typeshed      - Collection of library stubs for Python, with static types. (https://github.com/python/typeshed/blob/main/LICENSE)
+License:        Apache 2.0
+License File:   typeshed.license
+
 
 web/documentserver-example/ruby
 
@@ -379,14 +377,14 @@ coffee-rails  - CoffeeScript adapter for the Rails asset pipeline. (https://gith
 License:        MIT
 License File:   coffee-rails.license
 
+dalli         - High performance memcached client for Ruby. (https://github.com/petergoldstein/dalli/blob/v3.2.0/LICENSE)
+License:        MIT
+License File:   dalli.license
+
 jbuilder      - Create JSON structures via a Builder-style DSL (https://github.com/rails/jbuilder/blob/master/MIT-LICENSE)
 License:        MIT
 License File:   jbuilder.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -399,9 +397,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -411,10 +413,18 @@ jquery-rails  - This gem provides jQuery and the jQuery-ujs driver for your Rail
 License:        MIT
 License File:   jquery-rails.license
 
+mimemagic     - А library to detect the mime type of a file by extension or by content. (https://github.com/mimemagicrb/mimemagic/blob/master/LICENSE)
+License:        MIT
+License File:   mimemagic.license
+
 rails         - Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern. (https://github.com/rails/rails/blob/v6.0.3.2/MIT-LICENSE)
 License:        MIT
 License File:   rails.license
 
+rubocop       - A Ruby static code analyzer and formatter, based on the community Ruby style guide. (https://github.com/rubocop/rubocop/blob/v1.52.0/LICENSE.txt)
+License:        MIT
+License File:   rubocop.license
+
 sass-rails    - This gem provides official integration for Ruby on Rails projects with the Sass stylesheet language. (https://github.com/rails/sass-rails/blob/master/MIT-LICENSE)
 License:        MIT
 License File:   sass-rails.license
@@ -423,9 +433,13 @@ sdoc          - rdoc generator html with javascript search index. (https://githu
 License:        MIT
 License File:   sdoc.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
+sorbet        - A fast, powerful type checker designed for Ruby. (https://github.com/sorbet/sorbet/blob/0.5.10871.20230607144259-d9000e2ba/LICENSE)
+License:        Apache License 2.0
+License File:   sorbet.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
 
 turbolinks    - Rails engine for Turbolinks 5 support (https://github.com/turbolinks/turbolinks-rails/blob/master/LICENSE)
 License:        MIT

CHANGELOG.md

@@ -1,8 +1,16 @@
 # Change Log
 
+- nodejs: change reference source
+- php: using a repo with a list of formats
+- nodejs: using a repo with a list of formats
 - 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
 - si skin languages
 - fix "no" skin languages

web/documentserver-example/csharp-mvc/3rd-Party.license

@@ -4,10 +4,6 @@ Entity Framework - Entity Framework is an object-relational mapper that enables
 License:        MICROSOFT SOFTWARE SUPPLEMENTAL TERMS, MICROSOFT SOFTWARE LICENSE TERMS
 License File:   EntityFramework.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -20,9 +16,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/csharp-mvc/Helpers/DocManagerHelper.cs

@@ -220,6 +220,7 @@ namespace OnlineEditorsExampleMVC.Helpers
             var fileName = GetCorrectName(demoName);  // get a file name with an index if the file with such a name already exists
 
             File.Copy(HttpRuntime.AppDomainAppPath + demoPath + demoName, StoragePath(fileName));  // copy file to the storage directory
+            File.SetLastWriteTime(StoragePath(fileName), DateTime.Now);
 
             return fileName;
         }

web/documentserver-example/csharp-mvc/Scripts/jscript.js

@@ -236,6 +236,7 @@ if (typeof jQuery != "undefined") {
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
+        document.location.reload();
     });
 
     jq(document).on("click", "#beginView:not(.disable)", function () {
@@ -244,6 +245,7 @@ if (typeof jQuery != "undefined") {
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
+        document.location.reload();
     });
 
     jq(document).on("click", "#beginEmbedded:not(.disable)", function () {

web/documentserver-example/csharp-mvc/WebEditor.ashx.cs

@@ -249,14 +249,14 @@ namespace OnlineEditorsExampleMVC
                     // get the url and file type of the converted file
                     Dictionary<string, string> newFileData;
                     var result = ServiceConverter.GetConvertedData(downloadUri.ToString(), extension, internalExtension, key, true, out newFileData, filePass, lang);
-                    var newFileUri = newFileData["fileUrl"];
-                    var newFileType = "." + newFileData["fileType"];
                     if (result != 100)
                     {
                         context.Response.Write("{ \"step\" : \"" + result + "\", \"filename\" : \"" + fileName + "\"}");
                         return;
                     }
 
+                    var newFileUri = newFileData["fileUrl"];
+                    var newFileType = "." + newFileData["fileType"];
                     // get a file name of an internal file extension with an index if the file with such a name already exists
                     var correctName = DocManagerHelper.GetCorrectName(Path.GetFileNameWithoutExtension(fileName) + newFileType);
 
@@ -659,10 +659,12 @@ namespace OnlineEditorsExampleMVC
                 return;
             }
 
+            var directUrl = (bool)body["directUrl"];
+
             var data = new Dictionary<string, object>() {
-            { "fileType", (Path.GetExtension(fileName) ?? "").ToLower() },
+            { "fileType", (Path.GetExtension(fileName) ?? "").ToLower().Trim('.') },
             { "url",  DocManagerHelper.GetDownloadUrl(fileName)},
-            { "directUrl",  DocManagerHelper.GetDownloadUrl(fileName) },
+            { "directUrl", directUrl ? DocManagerHelper.GetDownloadUrl(fileName, false) : null },
             { "referenceData", new Dictionary<string, string>()
                 {
                     { "fileKey", jss.Serialize(new Dictionary<string, object>{
@@ -670,7 +672,7 @@ namespace OnlineEditorsExampleMVC
                             {"userAddress", HttpUtility.UrlEncode(DocManagerHelper.CurUserHostAddress(HttpContext.Current.Request.UserHostAddress))}
                     })
                     },
-                    {"instanceId", DocManagerHelper.GetServerUrl(false) }
+                    { "instanceId", DocManagerHelper.GetServerUrl(false) }
                 }
             },
             { "path", fileName }

web/documentserver-example/csharp-mvc/licenses/3rd-Party.license

@@ -4,10 +4,6 @@ Entity Framework - Entity Framework is an object-relational mapper that enables
 License:        MICROSOFT SOFTWARE SUPPLEMENTAL TERMS, MICROSOFT SOFTWARE LICENSE TERMS
 License File:   EntityFramework.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -20,9 +16,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/csharp-mvc/web.appsettings.config

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <appSettings>
   <clear />
-  <add key="version" value="1.5.1"/>
+  <add key="version" value="1.6.0"/>
 
   <add key="filesize-max" value="52428800"/>
   <add key="storage-path" value=""/>

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/csharp/Default.aspx.cs

@@ -489,13 +489,13 @@ namespace OnlineEditorsExample
                 // get the url and file type of the converted file
                 Dictionary<string, string> newFileData;
                 var result = ServiceConverter.GetConvertedData(fileUrl.ToString() , extension, internalExtension, key, true, out newFileData, filePass, lang);
-                var newFileUri = newFileData["fileUrl"];
-                var newFileType = "." + newFileData["fileType"];
                 if (result != 100)
                 {
                     return "{ \"step\" : \"" + result + "\", \"filename\" : \"" + _fileName + "\"}";
                 }
 
+                var newFileUri = newFileData["fileUrl"];
+                var newFileType = "." + newFileData["fileType"];
                 // get a file name of an internal file extension with an index if the file with such a name already exists
                 var fileName = GetCorrectName(Path.GetFileNameWithoutExtension(_fileName) + newFileType);
 

web/documentserver-example/csharp/DocEditor.aspx.cs

@@ -632,6 +632,7 @@ namespace OnlineEditorsExample
 
             var filePath = _Default.StoragePath(FileName, null);
             File.Copy(HttpRuntime.AppDomainAppPath + demoPath + demoName, filePath);  // copy this file to the storage directory
+            File.SetLastWriteTime(filePath, DateTime.Now);
 
             // create a json file with file meta data
             var id = request.Cookies.GetOrDefault("uid", null);

web/documentserver-example/csharp/WebEditor.ashx.cs

@@ -477,10 +477,12 @@ namespace OnlineEditorsExample
                 return;
             }
 
+            var directUrl = (bool) body["directUrl"];
+
             var data = new Dictionary<string, object>() {
-            { "fileType", (Path.GetExtension(fileName) ?? "").ToLower() },
+            { "fileType", (Path.GetExtension(fileName) ?? "").ToLower().Trim('.') },
             { "url",  DocEditor.getDownloadUrl(fileName)},
-            { "directUrl",  DocEditor.getDownloadUrl(fileName) },
+            { "directUrl", directUrl ? DocEditor.getDownloadUrl(fileName, false) : null},
             { "referenceData", new Dictionary<string, string>()
                 {
                     { "fileKey", jss.Serialize(new Dictionary<string, object>{

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/csharp/script/jscript.js

@@ -236,6 +236,7 @@ if (typeof jQuery != "undefined") {
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
+        document.location.reload();
     });
 
     jq(document).on("click", "#beginView:not(.disable)", function () {
@@ -244,6 +245,7 @@ if (typeof jQuery != "undefined") {
         window.open(url, "_blank");
         jq('#hiddenFileName').val("");
         jq.unblockUI();
+        document.location.reload();
     });
 
     jq(document).on("click", "#beginEmbedded:not(.disable)", function () {

web/documentserver-example/csharp/settings.config

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <appSettings>
   <clear />
-  <add key="version" value="1.5.1"/>
+  <add key="version" value="1.6.0"/>
 
   <add key="filesize-max" value="52428800"/>
   <add key="storage-path" value=""/>

web/documentserver-example/java-spring/3rd-Party.license

@@ -1,8 +1,17 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
+
+Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   gson.license
+
+H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
+License:        MPL 2.0 or EPL 1.0
+License File:   h2database.license
+
+Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   jackson-databind.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -16,14 +25,30 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
+License:        Apache 2.0
+License File:   JSON.simple.license
+
+Project Lombok - Project Lombok is a java library that automatically plugs into your editor and build tools. (https://mvnrepository.com/artifact/org.projectlombok/lombok).
+License:        MIT
+License File    lombok.license
+
+ModelMapper   - ModelMapper is an intelligent object mapping library that automatically maps objects to each other. (https://github.com/modelmapper/modelmapper)
+License:        Apache 2.0
+License File    modelmapper.license
+
 Prime JWT     - is intended to be fast and easy to use. Prime JWT has a single external dependency on Jackson. (https://github.com/ws-apps/prime-jwt/blob/master/LICENSE)
 License:        Apache 2.0
 License File:   prime-jwt.license
@@ -43,27 +68,3 @@ License File:   spring-boot.license
 Spring Data JPA - Persist data in SQL stores with Java Persistence API using Spring Data and Hibernate. (https://github.com/spring-projects/spring-data-jpa/blob/main/LICENSE.txt)
 License:        Apache 2.0
 License File:   spring-data-jpa.license
-
-H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
-License:        MPL 2.0 or EPL 1.0
-License File:   h2database.license
-
-JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
-License:        Apache 2.0
-License File:   JSON.simple.license
-
-Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   gson.license
-
-Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   jackson-databind.license
-
-ModelMapper   - ModelMapper is an intelligent object mapping library that automatically maps objects to each other. (https://github.com/modelmapper/modelmapper)
-License:        Apache 2.0
-License File    modelmapper.license
-
-Project Lombok - Project Lombok is a java library that automatically plugs into your editor and build tools. (https://mvnrepository.com/artifact/org.projectlombok/lombok).
-License:        MIT
-License File    lombok.license

web/documentserver-example/java-spring/licenses/3rd-Party.license

@@ -1,8 +1,17 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
+
+Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   gson.license
+
+H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
+License:        MPL 2.0 or EPL 1.0
+License File:   h2database.license
+
+Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
+License:        Apache 2.0
+License File:   jackson-databind.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -16,14 +25,30 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
+License:        Apache 2.0
+License File:   JSON.simple.license
+
+Project Lombok - Project Lombok is a java library that automatically plugs into your editor and build tools. (https://mvnrepository.com/artifact/org.projectlombok/lombok).
+License:        MIT
+License File    lombok.license
+
+ModelMapper   - ModelMapper is an intelligent object mapping library that automatically maps objects to each other. (https://github.com/modelmapper/modelmapper)
+License:        Apache 2.0
+License File    modelmapper.license
+
 Prime JWT     - is intended to be fast and easy to use. Prime JWT has a single external dependency on Jackson. (https://github.com/ws-apps/prime-jwt/blob/master/LICENSE)
 License:        Apache 2.0
 License File:   prime-jwt.license
@@ -43,19 +68,3 @@ License File:   spring-boot.license
 Spring Data JPA - Persist data in SQL stores with Java Persistence API using Spring Data and Hibernate. (https://github.com/spring-projects/spring-data-jpa/blob/main/LICENSE.txt)
 License:        Apache 2.0
 License File:   spring-data-jpa.license
-
-H2 Database Engine - This software contains unmodified binary redistributions for H2 database engine. H2 is a relational DBMS that can be embedded in java applications. (https://h2database.com/html/license.html)
-License:        MPL 2.0 or EPL 1.0
-License File:   h2database.license
-
-JSON.simple   - JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. (https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt)
-License:        Apache 2.0
-License File:   JSON.simple.license
-
-Gson          - Gson is a Java library that can be used to convert Java Objects into their JSON representation. (https://github.com/google/gson/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   gson.license
-
-Jackson Databind - General-purpose data-binding functionality and tree-model for Jackson Data Processor. (https://github.com/FasterXML/jackson-databind/blob/master/LICENSE)
-License:        Apache 2.0
-License File:   jackson-databind.license

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/controllers/FileController.java

@@ -36,6 +36,7 @@ import com.onlyoffice.integration.documentserver.util.service.ServiceConverter;
 import com.onlyoffice.integration.documentserver.managers.document.DocumentManager;
 import com.onlyoffice.integration.documentserver.managers.callback.CallbackManager;
 import org.json.simple.JSONObject;
+import org.json.simple.parser.JSONParser;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.io.Resource;
@@ -64,6 +65,7 @@ import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Optional;
 
@@ -234,6 +236,9 @@ public class FileController {
                     throw new RuntimeException("Input stream is null");
                 }
 
+                // remove source file
+                storageMutator.deleteFile(fileName);
+
                 // create the converted file with input stream
                 storageMutator.createFile(Path.of(storagePathBuilder.getFileLocation(correctedName)), stream);
                 fileName = correctedName;
@@ -459,18 +464,18 @@ public class FileController {
     @ResponseBody
     public String reference(@RequestBody final JSONObject body) {
         try {
-
+            JSONParser parser = new JSONParser();
             Gson gson = new GsonBuilder().disableHtmlEscaping().create();
 
             String userAddress = "";
             String fileName = "";
 
             if (body.containsKey("referenceData")) {
-                JSONObject referenceDataObj = (JSONObject) body.get("referenceData");
+                LinkedHashMap referenceDataObj = (LinkedHashMap) body.get("referenceData");
                 String instanceId = (String) referenceDataObj.get("instanceId");
 
                 if (instanceId.equals(storagePathBuilder.getServerUrl(false))) {
-                    JSONObject fileKey = (JSONObject) referenceDataObj.get("fileKey");
+                    JSONObject fileKey = (JSONObject) parser.parse((String) referenceDataObj.get("fileKey"));
                     userAddress = (String) fileKey.get("userAddress");
                     if (userAddress.equals(InetAddress.getLocalHost().getHostAddress())) {
                         fileName = (String) fileKey.get("fileName");
@@ -496,18 +501,20 @@ public class FileController {
                 return "{ \"error\": \"File not found\"}";
             }
 
+            boolean directUrl = (boolean) body.get("directUrl");
+
             HashMap<String, Object> fileKey = new HashMap<>();
             fileKey.put("fileName", fileName);
             fileKey.put("userAddress", InetAddress.getLocalHost().getHostAddress());
 
             HashMap<String, Object> referenceData = new HashMap<>();
             referenceData.put("instanceId", storagePathBuilder.getServerUrl(true));
-            referenceData.put("fileKey", fileKey);
+            referenceData.put("fileKey", gson.toJson(fileKey));
 
             HashMap<String, Object> data = new HashMap<>();
-            data.put("fileType", fileUtility.getFileExtension(fileName));
+            data.put("fileType", fileUtility.getFileExtension(fileName).replace(".", ""));
             data.put("url", documentManager.getDownloadUrl(fileName, true));
-            data.put("directUrl", documentManager.getDownloadUrl(fileName, true));
+            data.put("directUrl", directUrl ? documentManager.getDownloadUrl(fileName, false) : null);
             data.put("referenceData", referenceData);
             data.put("path", fileName);
 

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/util/service/DefaultServiceConverter.java

@@ -106,17 +106,17 @@ public class DefaultServiceConverter implements ServiceConverter {
 
             connection.connect();
 
+            try (OutputStream os = connection.getOutputStream()) {
+                os.write(bodyByte);  // write bytes to the output stream
+                os.flush();  // force write data to the output stream that can be cached in the current thread
+            }
+
             int statusCode = connection.getResponseCode();
             if (statusCode != HttpStatus.OK.value()) {  // checking status code
                 connection.disconnect();
                 throw new RuntimeException("Convertation service returned status: " + statusCode);
             }
 
-            try (OutputStream os = connection.getOutputStream()) {
-                os.write(bodyByte);  // write bytes to the output stream
-                os.flush();  // force write data to the output stream that can be cached in the current thread
-            }
-
             response = connection.getInputStream();  // get the input stream
             jsonString = convertStreamToString(response);  // convert the response stream into a string
         } finally {

web/documentserver-example/java-spring/src/main/resources/application.properties

@@ -1,4 +1,4 @@
-server.version=1.5.1
+server.version=1.6.0
 
 server.address=
 server.port=4000
@@ -38,6 +38,8 @@ spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
 hibernate.ddl-auto
 spring.h2.console.enabled=true
 spring.h2.console.path=/h2
+spring.servlet.multipart.max-file-size=5MB
+spring.servlet.multipart.max-request-size=5MB
 
 url.index=/
 url.converter=/converter

web/documentserver-example/java-spring/src/main/resources/templates/editor.html

@@ -52,7 +52,7 @@
 
                 // the user is trying to switch the document from the viewing into the editing mode
                 var onRequestEditRights = function () {
-                    location.href = location.href.replace(RegExp("\&?action=view\&?", "i"), "");
+                    location.href = location.href.replace(RegExp("\&?action=view", "i"), "");
                 };
 
                 // an error or some other specific event occurs

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/java/src/main/java/controllers/IndexServlet.java

@@ -78,6 +78,11 @@ public class IndexServlet extends HttpServlet {
             return;
         }
 
+        // charset for response headers if upload or convert
+        if (action.matches("upload|convert")) {
+           response.setCharacterEncoding("UTF-8");
+        }
+
         DocumentManager.init(request, response);
 
         // create a variable to display information about the application and error messages
@@ -310,9 +315,9 @@ public class IndexServlet extends HttpServlet {
 
                 connection.disconnect();
 
-                // remove source file ?
-                // File sourceFile = new File(DocumentManager.StoragePath(fileName, null));
-                // sourceFile.delete();
+                // remove source file
+                File sourceFile = new File(DocumentManager.storagePath(fileName, null));
+                sourceFile.delete();
 
                 fileName = correctName;
 
@@ -695,6 +700,8 @@ public class IndexServlet extends HttpServlet {
                 return;
             }
 
+            boolean directUrl = (boolean) body.get("directUrl");
+
             HashMap<String, Object> fileKey = new HashMap<>();
             fileKey.put("fileName", fileName);
             fileKey.put("userAddress", DocumentManager.curUserHostAddress(null));
@@ -704,9 +711,9 @@ public class IndexServlet extends HttpServlet {
             referenceData.put("fileKey", gson.toJson(fileKey));
 
             HashMap<String, Object> data = new HashMap<>();
-            data.put("fileType", FileUtility.getFileExtension(fileName));
+            data.put("fileType", FileUtility.getFileExtension(fileName).replace(".", ""));
             data.put("url", DocumentManager.getDownloadUrl(fileName, true));
-            data.put("directUrl", DocumentManager.getDownloadUrl(fileName, true));
+            data.put("directUrl", directUrl ? DocumentManager.getDownloadUrl(fileName, false) : null);
             data.put("referenceData", referenceData);
             data.put("path", fileName);
 

web/documentserver-example/java/src/main/java/helpers/ServiceConverter.java

@@ -213,14 +213,15 @@ public final class ServiceConverter {
 
         connection.connect();
 
+
+        try (OutputStream os = connection.getOutputStream()) {
+            os.write(bodyByte);
+        }
         int statusCode = connection.getResponseCode();
         if (statusCode != HttpServletResponse.SC_OK) {  // checking status code
             connection.disconnect();
             throw new Exception("Conversion service returned status: " + statusCode);
         }
-        try (OutputStream os = connection.getOutputStream()) {
-            os.write(bodyByte);
-        }
 
         InputStream stream = connection.getInputStream();
 

web/documentserver-example/java/src/main/java/helpers/Users.java

@@ -86,11 +86,11 @@ public final class Users {
                 true, new ArrayList<String>(), descriptionUserSecond, false));
         add(new User("uid-3", "Hamish Mitchell", "mitchell@example.com",
                 "group-3", Arrays.asList("group-2"), new CommentGroups(Arrays.asList("group-3", "group-2"),
-                Arrays.asList("group-2"), new ArrayList<String>()), Arrays.asList("group-2"),
+                Arrays.asList("group-2"), null), Arrays.asList("group-2"),
                 false, Arrays.asList("copy", "download", "print"),
                 descriptionUserThird, false));
         add(new User("uid-0", null, null,
-                "", null, new CommentGroups(), new ArrayList<String>(),
+                "", null, null, null,
                 null, Arrays.asList("protect"), descriptionUserZero, false));
     }};
 

web/documentserver-example/java/src/main/resources/settings.properties

@@ -1,4 +1,4 @@
-version=1.5.1
+version=1.6.0
 
 filesize-max=5242880
 storage-folder=app_data

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

@@ -32,10 +32,6 @@ he            - a robust HTML entity encoder/decoder written in JavaScript. (htt
 License:        MIT
 License File:   he.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -48,9 +44,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/nodejs/app.js

@@ -100,9 +100,9 @@ app.get('/', (req, res) => { // define a handler for default page
 
     res.render('index', { // render index template with the parameters specified
       preloaderUrl: siteUrl + configServer.get('preloaderUrl'),
-      convertExts: configServer.get('convertedDocs'),
-      editedExts: configServer.get('editedDocs'),
-      fillExts: configServer.get('fillDocs'),
+      convertExts: fileUtility.getConvertExtensions(),
+      editedExts: fileUtility.getEditExtensions(),
+      fillExts: fileUtility.getFillExtensions(),
       storedFiles: req.DocManager.getStoredFiles(),
       params: req.DocManager.getCustomParams(),
       users,
@@ -239,13 +239,8 @@ app.post('/upload', (req, res) => { // define a handler for uploading files
       return;
     }
 
-    const exts = [].concat(
-      configServer.get('viewedDocs'),
-      configServer.get('editedDocs'),
-      configServer.get('convertedDocs'),
-      configServer.get('fillDocs'),
-    ); // all the supported file extensions
-    const curExt = fileUtility.getFileExtension(file.name);
+    const exts = fileUtility.getSuppotredExtensions(); // all the supported file extensions
+    const curExt = fileUtility.getFileExtension(file.name, true);
     const documentType = fileUtility.getFileType(file.name);
 
     if (exts.indexOf(curExt) === -1) { // check if the file extension is supported
@@ -296,13 +291,8 @@ app.post('/create', (req, res) => {
         return;
       }
 
-      const exts = [].concat(
-        configServer.get('viewedDocs'),
-        configServer.get('editedDocs'),
-        configServer.get('convertedDocs'),
-        configServer.get('fillDocs'),
-      ); // all the supported file extensions
-      const curExt = fileUtility.getFileExtension(fileName);
+      const exts = fileUtility.getSuppotredExtensions(); // all the supported file extensions
+      const curExt = fileUtility.getFileExtension(fileName, true);
 
       if (exts.indexOf(curExt) === -1) { // check if the file extension is supported
         // and write the error status and message to the response
@@ -335,7 +325,7 @@ app.post('/convert', (req, res) => { // define a handler for converting files
   const filePass = req.body.filePass ? req.body.filePass : null;
   const lang = req.body.lang ? req.body.lang : null;
   const fileUri = req.DocManager.getDownloadUrl(fileName, true);
-  const fileExt = fileUtility.getFileExtension(fileName);
+  const fileExt = fileUtility.getFileExtension(fileName, true);
   const internalFileExt = 'ooxml';
   const response = res;
 
@@ -408,7 +398,7 @@ app.post('/convert', (req, res) => { // define a handler for converting files
 
   try {
     // check if the file with such an extension can be converted
-    if (configServer.get('convertedDocs').indexOf(fileExt) !== -1) {
+    if (fileUtility.getConvertExtensions().indexOf(fileExt) !== -1) {
       const storagePath = req.DocManager.storagePath(fileName);
       const stat = fileSystem.statSync(storagePath);
       let key = fileUri + stat.mtime.getTime();
@@ -478,7 +468,7 @@ app.delete('/file', (req, res) => { // define a handler for removing file
 
 app.get('/csv', (req, res) => { // define a handler for downloading csv files
   const fileName = 'csv.csv';
-  const csvPath = path.join(__dirname, 'public', 'assets', 'sample', fileName);
+  const csvPath = path.join(__dirname, 'public', 'assets', 'document-templates', 'sample', fileName);
 
   // add headers to the response to specify the page parameters
   res.setHeader('Content-Length', fileSystem.statSync(csvPath).size);
@@ -948,9 +938,9 @@ app.get('/editor', (req, res) => { // define a handler for editing document
     const directUrl = req.DocManager.getDownloadUrl(fileName);
     let mode = req.query.mode || 'edit'; // mode: view/edit/review/comment/fillForms/embedded
 
-    let canEdit = configServer.get('editedDocs').indexOf(fileExt) !== -1; // check if this file can be edited
+    let canEdit = fileUtility.getEditExtensions().indexOf(fileExt.slice(1)) !== -1; // check if this file can be edited
     if (((!canEdit && mode === 'edit') || mode === 'fillForms')
-      && configServer.get('fillDocs').indexOf(fileExt) !== -1) {
+      && fileUtility.getFillExtensions().indexOf(fileExt.slice(1)) !== -1) {
       mode = 'fillForms';
       canEdit = true;
     }
@@ -1017,8 +1007,10 @@ app.get('/editor', (req, res) => { // define a handler for editing document
       },
       dataCompareFile: {
         fileType: 'docx',
-        url: `${req.DocManager.getServerUrl(true)}/assets/sample/sample.docx`,
-        directUrl: !userDirectUrl ? null : `${req.DocManager.getServerUrl()}/assets/sample/sample.docx`,
+        url: `${req.DocManager.getServerUrl(true)}/assets/document-templates/sample/sample.docx`,
+        directUrl: !userDirectUrl
+          ? null
+          : `${req.DocManager.getServerUrl()}/assets/document-templates/sample/sample.docx`,
       },
       dataMailMergeRecipients: {
         fileType: 'csv',

web/documentserver-example/nodejs/config/default.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.1",
+  "version": "1.6.0",
   "log": {
     "appenders": [
       {
@@ -22,10 +22,6 @@
     "apiUrl": "web-apps/apps/api/documents/api.js",
     "preloaderUrl": "web-apps/apps/api/documents/cache-scripts.html",
     "exampleUrl": null,
-    "viewedDocs": [".djvu", ".oxps", ".pdf", ".xps"],
-    "editedDocs": [".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"],
-    "fillDocs": [".docx", ".oform"],
-    "convertedDocs": [".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"],
     "storageFolder": "./files",
     "storagePath": "/files",
     "maxFileSize": 1073741824,

web/documentserver-example/nodejs/helpers/docManager.js

@@ -135,7 +135,7 @@ DocManager.prototype.createDemo = function createDemo(isSample, fileExt, userid,
   const fileName = this.getCorrectName(demoName); // get the correct file name if such a name already exists
 
   // copy sample document of a necessary extension to the storage path
-  this.copyFile(path.join(__dirname, '..', 'public', 'assets', isSample
+  this.copyFile(path.join(__dirname, '..', 'public', 'assets', 'document-templates', isSample
     ? 'sample' : 'new', demoName), this.storagePath(fileName));
 
   this.saveFileData(fileName, userid, username); // save file data to the file
@@ -328,7 +328,7 @@ DocManager.prototype.getStoredFiles = function getStoredFiles() {
         time,
         name: storedFiles[i],
         documentType: fileUtility.getFileType(storedFiles[i]),
-        canEdit: configServer.get('editedDocs').indexOf(fileUtility.getFileExtension(storedFiles[i])) !== -1,
+        canEdit: fileUtility.getEditExtensions().indexOf(fileUtility.getFileExtension(storedFiles[i], true)) !== -1,
         version: version + 1,
       };
 

web/documentserver-example/nodejs/helpers/fileUtility.js

@@ -16,6 +16,8 @@
  *
  */
 
+const supportedFormats = require('../public/assets/document-formats/onlyoffice-docs-formats.json'); // eslint-disable-line
+
 const fileUtility = {};
 
 // get file name from the given url
@@ -49,14 +51,11 @@ fileUtility.getFileExtension = function getFileExtension(url, withoutDot) {
 
 // get file type from the given url
 fileUtility.getFileType = function getFileType(url) {
-  const ext = fileUtility.getFileExtension(url); // get the file extension from the given url
+  const ext = fileUtility.getFileExtension(url, true); // get the file extension from the given url
 
-  // word type for document extensions
-  if (fileUtility.documentExts.indexOf(ext) !== -1) return fileUtility.fileType.word;
-  // cell type for spreadsheet extensions
-  if (fileUtility.spreadsheetExts.indexOf(ext) !== -1) return fileUtility.fileType.cell;
-  // slide type for presentation extensions
-  if (fileUtility.presentationExts.indexOf(ext) !== -1) return fileUtility.fileType.slide;
+  for (let i = 0; i < supportedFormats.length; i++) {
+    if (supportedFormats[i].name === ext) return supportedFormats[i].type;
+  }
 
   return fileUtility.fileType.word; // the default file type is word
 };
@@ -67,17 +66,35 @@ fileUtility.fileType = {
   slide: 'slide',
 };
 
-// the document extension list
-fileUtility.documentExts = ['.doc', '.docx', '.oform', '.docm', '.dot', '.dotx', '.dotm', '.odt',
-  '.fodt', '.ott', '.rtf', '.txt', '.html', '.htm', '.mht', '.xml', '.pdf', '.djvu', '.fb2', '.epub', '.xps', '.oxps'];
+fileUtility.getSuppotredExtensions = function getSuppotredExtensions() {
+  return supportedFormats.reduce((extensions, format) => [...extensions, format.name], []);
+};
 
-// the spreadsheet extension list
-fileUtility.spreadsheetExts = ['.xls', '.xlsx', '.xlsm', '.xlsb', '.xlt',
-  '.xltx', '.xltm', '.ods', '.fods', '.ots', '.csv'];
+fileUtility.getViewExtensions = function getViewExtensions() {
+  return supportedFormats.filter(
+    (format) => format.actions.includes('view'),
+  ).reduce((extensions, format) => [...extensions, format.name], []);
+};
 
-// the presentation extension list
-fileUtility.presentationExts = ['.pps', '.ppsx', '.ppsm', '.ppt', '.pptx', '.pptm', '.pot',
-  '.potx', '.potm', '.odp', '.fodp', '.otp'];
+fileUtility.getEditExtensions = function getEditExtensions() {
+  return supportedFormats.filter(
+    (format) => format.actions.includes('edit') || format.actions.includes('lossy-edit'),
+  ).reduce((extensions, format) => [...extensions, format.name], []);
+};
+
+fileUtility.getFillExtensions = function getFillExtensions() {
+  return supportedFormats.filter(
+    (format) => format.actions.includes('fill'),
+  ).reduce((extensions, format) => [...extensions, format.name], []);
+};
+
+fileUtility.getConvertExtensions = function getConvertExtensions() {
+  return supportedFormats.filter(
+    (format) => (format.type === 'word' && format.convert.includes('docx'))
+            || (format.type === 'cell' && format.convert.includes('xlsx'))
+            || (format.type === 'slide' && format.convert.includes('pptx')),
+  ).reduce((extensions, format) => [...extensions, format.name], []);
+};
 
 // get url parameters
 // eslint-disable-next-line no-unused-vars

web/documentserver-example/nodejs/helpers/wopi/wopiRouting.js

@@ -57,8 +57,8 @@ exports.registerRoutes = function registerRoutes(app) {
     });
 
     // Checking supported extensions
-    const editedExts = configServer.get('editedDocs').filter((i) => docsExtEdit.includes(i));
-    const fillExts = configServer.get('fillDocs').filter((i) => docsExtEdit.includes(i));
+    const editedExts = fileUtility.getEditExtensions().filter((i) => docsExtEdit.includes(i));
+    const fillExts = fileUtility.getFillExtensions().filter((i) => docsExtEdit.includes(i));
 
     try {
       // get all the stored files
@@ -81,7 +81,7 @@ exports.registerRoutes = function registerRoutes(app) {
         params: req.DocManager.getCustomParams(),
         users,
         preloaderUrl: siteUrl + configServer.get('preloaderUrl'),
-        convertExts: configServer.get('convertedDocs'),
+        convertExts: fileUtility.getConvertExtensions(),
         editedExts,
         fillExts,
         languages: configServer.get('languages'),
@@ -89,7 +89,8 @@ exports.registerRoutes = function registerRoutes(app) {
     } catch (ex) {
       console.log(ex); // display error message in the console
       res.status(500); // write status parameter to the response
-      res.render('error', { message: 'Server error' }); // render error template with the message parameter specified
+      // render error template with the message parameter specified
+      res.render('error', { message: 'Server error' });
     }
   });
   // define a handler for creating a new wopi editing session

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

@@ -20,13 +20,17 @@ express       - Fast, unopinionated, minimalist web framework for node. (https:/
 License:        MIT
 License File:   express.license
 
+fast-xml-parser - Validate XML, Parse XML to JS/JSON and vice versa, or parse XML to Nimn rapidly without C/C++ based libraries and no callback. (https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/LICENSE)
+License:        MIT
+License File:   fast-xml-parser.license
+
 formidable    - A Node.js module for parsing form data, especially file uploads. (https://github.com/node-formidable/formidable/blob/master/LICENSE)
 License:        MIT
 License File:   formidable.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+he            - a robust HTML entity encoder/decoder written in JavaScript. (https://github.com/mathiasbynens/he/blob/master/LICENSE-MIT.txt)
 License:        MIT
-License File:   jQuery.license
+License File:   he.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -40,9 +44,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT

web/documentserver-example/nodejs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "OnlineEditorsExampleNodeJS",
-  "version": "4.1.0",
+  "version": "1.6.0",
   "private": false,
   "scripts": {
     "start": "node ./bin/www",

web/documentserver-example/nodejs/public/javascripts/jscript.js

@@ -113,7 +113,7 @@ if (typeof jQuery != "undefined") {
         jq("#filePass").val("");
 
         var fileName = jq("#hiddenFileName").val();
-        var posExt = fileName.lastIndexOf('.');
+        var posExt = fileName.lastIndexOf('.') + 1;
         posExt = 0 <= posExt ? fileName.substring(posExt).trim().toLowerCase() : '';
 
         if (ConverExtList.indexOf(posExt) == -1) {
@@ -194,7 +194,7 @@ if (typeof jQuery != "undefined") {
         jq("#beginView, #beginEmbedded").removeClass("disable");
 
         var fileName = jq("#hiddenFileName").val();
-        var posExt = fileName.lastIndexOf('.');
+        var posExt = fileName.lastIndexOf('.') + 1;
         posExt = 0 <= posExt ? fileName.substring(posExt).trim().toLowerCase() : '';
 
         var checkEdited = EditedExtList.split(",").filter(function(ext) { return ext == posExt;});

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

@@ -227,6 +227,52 @@
             }
         };
 
+        var onRequestReferenceSource = function (event) {
+          innerAlert("onRequestReferenceSource");
+          let xhr = new XMLHttpRequest();
+          xhr.open("GET", "files");
+          xhr.setRequestHeader("Content-Type", "application/json");
+          xhr.send();
+          xhr.onload = function () {
+            if (xhr.status === 200) {
+              innerAlert(JSON.parse(xhr.responseText));
+              let fileList = JSON.parse(xhr.responseText);
+              let firstXlsxName;
+              let file;
+              for (file of fileList) {
+                if (file["title"]) {
+                  if (getFileExt(file["title"]) === "xlsx")
+                  {
+                    firstXlsxName = file["title"];
+                    break;
+                  }
+                }
+              }
+              if (firstXlsxName) {
+                let data = {
+                  directUrl : "<%- file.directUrl %>" || false,
+                  path : firstXlsxName
+                };
+                let xhr = new XMLHttpRequest();
+                xhr.open("POST", "reference");
+                xhr.setRequestHeader("Content-Type", "application/json");
+                xhr.send(JSON.stringify(data));
+                xhr.onload = function () {
+                  if (xhr.status === 200) {
+                    docEditor.setReferenceSource(JSON.parse(xhr.responseText));
+                  } else {
+                    innerAlert("/reference - bad status");
+                  }
+                }
+              } else {
+                innerAlert("No *.xlsx files");
+              }
+            } else {
+              innerAlert("/files - bad status");
+            }
+          }
+        };
+
         var onRequestSaveAs = function (event) {  //  the user is trying to save file by clicking Save Copy as... button
             var title = event.data.title;
             var url = event.data.url;
@@ -287,6 +333,7 @@
             config.events.onRequestUsers = onRequestUsers;
             config.events.onRequestSendNotify = onRequestSendNotify;
             config.events.onRequestReferenceData = onRequestReferenceData;
+            config.events.onRequestReferenceSource = onRequestReferenceSource;
         }
 
         if (config.editorConfig.createUrl) {
@@ -326,6 +373,13 @@
             }
         };
 
+        const getFileExt = function (fileName) {
+          if (fileName.indexOf(".")) {
+            return fileName.split('.').reverse()[0];
+          }
+          return false;
+        };
+
         if (window.addEventListener) {
             window.addEventListener("load", connectEditor);
             window.addEventListener("resize", fixSize);

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

@@ -189,7 +189,7 @@
                                                         <% if (storedFiles[i].documentType !== "word" && storedFiles[i].documentType !== "cell") {%>
                                                             <td class="contentCells contentCells-icon "></td>
                                                         <% } %>
-                                                        <% if (fillExts.indexOf(storedFiles[i].name.substring(storedFiles[i].name.lastIndexOf('.')).trim().toLowerCase()) !== -1) { %>
+                                                        <% if (fillExts.indexOf(storedFiles[i].name.substring(storedFiles[i].name.lastIndexOf('.') + 1).trim().toLowerCase()) !== -1) { %>
                                                             <td class="contentCells contentCells-icon">
                                                                 <a class="action-link" href="editor?type=desktop&mode=fillForms&fileName=<%= encodeURIComponent(storedFiles[i].name) %>" target="_blank">
                                                                     <img src="images/fill-forms.svg" alt="Open in editor for filling in forms" title="Open in editor for filling in forms" /></a>
@@ -201,7 +201,7 @@
                                                             <a class="action-link" href="editor?type=mobile&mode=edit&fileName=<%= encodeURIComponent(storedFiles[i].name) %>" target="_blank">
                                                                 <img src="images/mobile.svg" alt="Open in editor for mobile devices" title="Open in editor for mobile devices" /></a>
                                                         </td>
-                                                    <% } else if (fillExts.indexOf(storedFiles[i].name.substring(storedFiles[i].name.lastIndexOf('.')).trim().toLowerCase()) !== -1) { %>
+                                                    <% } else if (fillExts.indexOf(storedFiles[i].name.substring(storedFiles[i].name.lastIndexOf('.') + 1).trim().toLowerCase()) !== -1) { %>
                                                         <td class="contentCells contentCells-icon "></td>
                                                         <td class="contentCells contentCells-icon "></td>
                                                         <td class="contentCells contentCells-icon "></td>

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -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,22 @@
+.DEFAULT_GOAL := help
+
+.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
+
+.PHONY: lint
+lint: #  Lint the source code for the style.
+	@./vendor/bin/phpcs .
+
+.PHONY: test
+test: #  Run tests recursively.
+	@./vendor/bin/phpunit ./**/*Tests.php

web/documentserver-example/php/ajax.php

@@ -18,6 +18,7 @@
 namespace OnlineEditorsExamplePhp;
 
 use Exception;
+use OnlineEditorsExamplePhp\Common\Path;
 use OnlineEditorsExamplePhp\Helpers\ConfigManager;
 use OnlineEditorsExamplePhp\Helpers\ExampleUsers;
 use OnlineEditorsExamplePhp\Helpers\JwtManager;
@@ -95,15 +96,10 @@ function saveas()
         $title = $post["title"];
         $extension = mb_strtolower(pathinfo($title, PATHINFO_EXTENSION));
         $configManager = new ConfigManager();
-        $allexts = array_merge(
-            $configManager->getConfig("docServConvert"),
-            $configManager->getConfig("docServEdited"),
-            $configManager->getConfig("docServViewd"),
-            $configManager->getConfig("docServFillforms")
-        );
+        $allexts = $configManager->getSuppotredExtensions();
         $filename = GetCorrectName($title);
 
-        if (!in_array("." . $extension, $allexts)) {
+        if (!in_array($extension, $allexts)) {
             $result["error"] = "File type is not supported";
             return $result;
         }
@@ -156,7 +152,7 @@ function upload()
     // check if the file was uploaded using HTTP POST
     if (is_uploaded_file($tmp)) {
         $filesize = $_FILES['files']['size'];  // get the file size
-        $ext = mb_strtolower('.' . pathinfo($_FILES['files']['name'], PATHINFO_EXTENSION));  // get file extension
+        $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")) {
@@ -165,7 +161,7 @@ function upload()
         }
 
         // check if the file extension is supported by the editor
-        if (!in_array($ext, getFileExts())) {
+        if (!in_array($ext, $configManager->getSuppotredExtensions())) {
             $result["error"] = 'File type is not supported';  // if not, then an error occurs
             return $result;
         }
@@ -250,13 +246,13 @@ function convert()
     $post = json_decode(file_get_contents('php://input'), true);
     $fileName = basename($post["filename"]);
     $filePass = $post["filePass"];
-    $lang = $_COOKIE["ulang"];
+    $lang = $_COOKIE["ulang"] ?? "";
     $extension = mb_strtolower(pathinfo($fileName, PATHINFO_EXTENSION));
     $internalExtension = "ooxml";
     $configManager = new ConfigManager();
 
     // check if the file with such an extension can be converted
-    if (in_array("." . $extension, $configManager->getConfig("docServConvert")) &&
+    if (in_array($extension, $configManager->getConvertExtensions()) &&
         $internalExtension != "") {
         $fileUri = $post["fileUri"];
         if ($fileUri == null || $fileUri == "") {
@@ -369,7 +365,8 @@ function assets()
 {
     $fileName = basename($_GET["name"]);
     $filePath = dirname(__FILE__) .
-        DIRECTORY_SEPARATOR . "assets" . DIRECTORY_SEPARATOR . "sample" . DIRECTORY_SEPARATOR . $fileName;
+        DIRECTORY_SEPARATOR . "assets" . DIRECTORY_SEPARATOR . "document-templates"
+        . DIRECTORY_SEPARATOR . "sample" . DIRECTORY_SEPARATOR . $fileName;
     downloadFile($filePath);
 }
 
@@ -382,7 +379,8 @@ function csv()
 {
     $fileName = "csv.csv";
     $filePath = dirname(__FILE__) .
-        DIRECTORY_SEPARATOR . "assets" . DIRECTORY_SEPARATOR . "sample" . DIRECTORY_SEPARATOR . $fileName;
+        DIRECTORY_SEPARATOR . "assets" . DIRECTORY_SEPARATOR . "document-templates"
+        . DIRECTORY_SEPARATOR . "sample" . DIRECTORY_SEPARATOR . $fileName;
     downloadFile($filePath);
 }
 
@@ -445,8 +443,8 @@ function download()
         $fileName = realpath($configManager->getConfig("storagePath"))
         === $configManager->getConfig("storagePath") ?
             $_GET["fileName"] : basename($_GET["fileName"]);  // get the file name
-        $userAddress = $_GET["userAddress"];
-        $isEmbedded = $_GET["&dmode"];
+        $userAddress = $_GET["userAddress"] ?? null;
+        $isEmbedded = $_GET["&dmode"] ?? null;
         $jwtManager = new JwtManager();
 
         if ($jwtManager->isJwtEnabled() && $isEmbedded == null && $userAddress) {
@@ -491,8 +489,9 @@ function downloadFile($filePath)
 
         // write headers to the response object
         @header('Content-Length: ' . filesize($filePath));
-        @header('Content-Disposition: attachment; filename*=UTF-8\'\'' . urldecode(basename($filePath)));
+        @header('Content-Disposition: attachment; filename*=UTF-8\'\'' . str_replace("+", "%20", urlencode(basename($filePath))));
         @header('Content-Type: ' . mime_content_type($filePath));
+        @header('Access-Control-Allow-Origin: *');
 
         if ($fd = fopen($filePath, 'rb')) {
             while (!feof($fd)) {
@@ -588,9 +587,9 @@ function reference()
     }
 
     $data = [
-        "fileType" => getInternalExtension($fileName),
+        "fileType" => trim(getInternalExtension($fileName), '.'),
         "url" => getDownloadUrl($fileName),
-        "directUrl" => $post["directUrl"] ? getDownloadUrl($fileName) : getDownloadUrl($fileName, false),
+        "directUrl" => $post["directUrl"] ? getDownloadUrl($fileName, false) : null,
         "referenceData" => [
             "fileKey" => json_encode([
                 "fileName" => $fileName,
@@ -607,3 +606,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('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('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($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($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/Path.php

@@ -0,0 +1,103 @@
+<?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 {
+    public string $separator;
+    public ?string $dirname;
+    public ?string $basename;
+    public ?string $extension;
+    public ?string $filename;
+
+    public function __construct(
+        string $path,
+        string $separator = DIRECTORY_SEPARATOR
+    ) {
+        $parsed_path = pathinfo($path);
+        $this->separator = $separator;
+        $this->dirname = self::dirname($parsed_path);
+        $this->basename = self::basename($parsed_path);
+        $this->extension = self::extension($parsed_path);
+        $this->filename = self::filename($parsed_path);
+    }
+
+    private static function dirname(array $path): ?string {
+        return isset($path['dirname'])
+            ? $path['dirname']
+            : null;
+    }
+
+    private static function basename(array $path): ?string {
+        return isset($path['basename'])
+            ? $path['basename']
+            : null;
+    }
+
+    private static function extension(array $path): ?string {
+        return isset($path['extension'])
+            ? $path['extension']
+            : null;
+    }
+
+    private static function filename(array $path): ?string {
+        return isset($path['filename'])
+            ? $path['filename']
+            : null;
+    }
+
+    public function string(): string {
+        $parts = array();
+        if (!$this->dirname && !$this->basename) {
+            return '.';
+        }
+        if ($this->dirname === $this->separator && $this->basename) {
+            return "{$this->dirname}{$this->basename}";
+        }
+        if ($this->dirname !== '.') {
+            $parts[] = $this->dirname;
+        }
+        if ($this->basename) {
+            $parts[] = $this->basename;
+        }
+        return implode($this->separator, $parts);
+    }
+
+    public function join(string ...$paths): self {
+        if (!isset($paths[0])) {
+            return $this;
+        }
+
+        $next_paths = array_slice($paths, 1);
+        if ($paths[0] == '' || $paths[0] == '.') {
+            return $this->join(...$next_paths);
+        }
+
+        $sub = new Path($paths[0], $this->separator);
+        $sub_string = $sub->string();
+
+        $string = $this->string();
+        $separator = str_starts_with($sub_string, $this->separator)
+            ? ''
+            : $this->separator;
+
+        $joined_string = "{$string}{$separator}{$sub_string}";
+        $joined = new Path($joined_string, $this->separator);
+
+        return $joined->join(...$next_paths);
+    }
+}

web/documentserver-example/php/composer.json

@@ -1,26 +1,18 @@
 {
+    "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\\Helpers\\" : "helpers/",
-            "OnlineEditorsExamplePhp\\Views\\" : "views/",
-            "Firebase\\JWT\\" : "lib/jwt/"
+            "OnlineEditorsExamplePhp\\Views\\" : "views/"
         }
     }
 }

web/documentserver-example/php/config.json

@@ -1,20 +1,10 @@
 {
-  "version": "1.5.1",
+  "version": "1.6.0",
 
   "fileSizeMax": 5242880,
   "storagePath": "",
   "alone": false,
 
-  "docServFillforms": [".docx", ".oform"],
-  "docServViewd": [".djvu", ".oxps", ".pdf", ".xps"],
-  "docServEdited": [".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"],
-  "docServConvert": [".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"],
-
   "docServTimeout": "120000",
   "docServSiteUrl": "https://documentserver/",
 
@@ -31,18 +21,6 @@
 
   "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",
-  "extsSpreadsheet": [".xls", ".xlsx", ".xlsm", ".xlsb",
-    ".xlt", ".xltx", ".xltm",
-    ".ods", ".fods", ".ots", ".csv"],
-  "extsPresentation": [".pps", ".ppsx", ".ppsm",
-    ".ppt", ".pptx", ".pptm",
-    ".pot", ".potx", ".potm",
-    ".odp", ".fodp", ".otp"],
-  "extsDocument": [".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",

web/documentserver-example/php/functions.php

@@ -130,18 +130,24 @@ function getCurUserHostAddress($userAddress = null)
  */
 function getInternalExtension($filename)
 {
-    $ext = mb_strtolower('.' . pathinfo($filename, PATHINFO_EXTENSION));
+    $ext = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
 
     $configManager = new ConfigManager();
-    if (in_array($ext, $configManager->getConfig("extsDocument"))) {
-        return ".docx";
-    }  // .docx for text document extensions
-    if (in_array($ext, $configManager->getConfig("extsSpreadsheet"))) {
-        return ".xlsx";
-    }  // .xlsx for spreadsheet extensions
-    if (in_array($ext, $configManager->getConfig("extsPresentation"))) {
-        return ".pptx";
-    }  // .pptx for presentation extensions
+
+    foreach ($configManager->getSuppotredFormats() as $format) {
+        if ($format->name === $ext) {
+            if ($format->type === "word") {
+                return ".docx";
+            }
+            if ($format->type === "cell") {
+                return ".xlsx";
+            }
+            if ($format->type === "slide") {
+                return ".pptx";
+            }
+        }
+    }
+
     return "";
 }
 
@@ -154,19 +160,24 @@ function getInternalExtension($filename)
  */
 function getTemplateImageUrl($filename)
 {
-    $ext = mb_strtolower('.' . pathinfo($filename, PATHINFO_EXTENSION));
+    $ext = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
     $path = serverPath(true) . "/css/images/";
 
     $configManager = new ConfigManager();
-    if (in_array($ext, $configManager->getConfig("extsDocument"))) {
-        return $path . "file_docx.svg";
-    }  // for text document extensions
-    if (in_array($ext, $configManager->getConfig("extsSpreadsheet"))) {
-        return $path . "file_xlsx.svg";
-    }  // for spreadsheet extensions
-    if (in_array($ext, $configManager->getConfig("extsPresentation"))) {
-        return $path . "file_pptx.svg";
-    }  // for presentation extensions
+    foreach ($configManager->getSuppotredFormats() as $format) {
+        if ($format->name === $ext) {
+            if ($format->type === "word") {
+                return $path . "file_docx.svg";
+            }
+            if ($format->type === "cell") {
+                return $path . "file_xlsx.svg";
+            }
+            if ($format->type === "slide") {
+                return $path . "file_pptx.svg";
+            }
+        }
+    }
+
     return $path . "file_docx.svg";
 }
 
@@ -179,18 +190,15 @@ function getTemplateImageUrl($filename)
  */
 function getDocumentType($filename)
 {
-    $ext = mb_strtolower('.' . pathinfo($filename, PATHINFO_EXTENSION));
+    $ext = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
 
     $configManager = new ConfigManager();
-    if (in_array($ext, $configManager->getConfig("extsDocument"))) {
-        return "word";
-    }  // word for text document extensions
-    if (in_array($ext, $configManager->getConfig("extsSpreadsheet"))) {
-        return "cell";
-    }  // cell for spreadsheet extensions
-    if (in_array($ext, $configManager->getConfig("extsPresentation"))) {
-        return "slide";
-    }  // slide for presentation extensions
+    foreach ($configManager->getSuppotredFormats() as $format) {
+        if ($format->name === $ext) {
+            return $format->type;
+        }
+    }
+
     return "word";
 }
 
@@ -400,13 +408,13 @@ function getStoredFiles()
     foreach ($cdir as $key => $fileName) {  // run through all the file and folder names
         if (!in_array($fileName, [".", ".."])) {
             if (!is_dir($directory . DIRECTORY_SEPARATOR . $fileName)) {  // if an element isn't a directory
-                $ext = mb_strtolower('.' . pathinfo($fileName, PATHINFO_EXTENSION));
+                $ext = mb_strtolower(pathinfo($fileName, PATHINFO_EXTENSION));
                 $dat = filemtime($directory . DIRECTORY_SEPARATOR . $fileName);  // get the time of element modification
                 $result[$dat] = (object) [  // and write the file to the result
                     "name" => $fileName,
                     "documentType" => getDocumentType($fileName),
-                    "canEdit" => in_array($ext, $configManager->getConfig("docServEdited")),
-                    "isFillFormDoc" => in_array($ext, $configManager->getConfig("docServFillforms")),
+                    "canEdit" => in_array($ext, $configManager->getEditExtensions()),
+                    "isFillFormDoc" => in_array($ext, $configManager->getFillExtensions()),
                 ];
             }
         }
@@ -521,22 +529,6 @@ function getFileInfo($fileId)
     return $result;
 }
 
-/**
- * Get all the supported file extensions
- *
- * @return array
- */
-function getFileExts()
-{
-    $configManager = new ConfigManager();
-    return array_merge(
-        $configManager->getConfig("docServViewd"),
-        $configManager->getConfig("docServEdited"),
-        $configManager->getConfig("docServConvert"),
-        $configManager->getConfig("docServFillforms")
-    );
-}
-
 /**
  * Get the correct file name if such a name already exists
  *
@@ -590,10 +582,11 @@ function getDocEditorKey($fileName)
 function doUpload($fileUri)
 {
     $_fileName = GetCorrectName($fileUri);
+    $configManager = new ConfigManager();
 
     // check if file extension is supported by the editor
-    $ext = mb_strtolower('.' . pathinfo($_fileName, PATHINFO_EXTENSION));
-    if (!in_array($ext, getFileExts())) {
+    $ext = mb_strtolower(pathinfo($_fileName, PATHINFO_EXTENSION));
+    if (!in_array($ext, $configManager->getSuppotredExtensions())) {
         throw new Exception("File type is not supported");
     }
 
@@ -895,8 +888,12 @@ function getResponseUri($document_response, &$response_uri)
  */
 function tryGetDefaultByType($createExt, $user)
 {
-    $demoName = (isset($_GET["sample"]) ? "sample." : "new.") . $createExt;
-    $demoPath = "assets" . DIRECTORY_SEPARATOR . (isset($_GET["sample"]) ? "sample" : "new") . DIRECTORY_SEPARATOR;
+    $sample = isset($_GET["sample"]) && $_GET["sample"];
+    $demoName = ($sample ? "sample." : "new.") . $createExt;
+    $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))) {

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

@@ -21,10 +21,12 @@ 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
@@ -32,6 +34,13 @@ final class ConfigManager
         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")
+            ? file_get_contents("./assets/document-formats/onlyoffice-docs-formats.json")
+            : false;
+    }
+
     /**
      * @param string|null $configName
      * @return mixed
@@ -43,4 +52,74 @@ final class ConfigManager
         }
         return $this->config;
     }
+
+    public function getSuppotredFormats(): mixed
+    {
+        return $this->configFormats;
+    }
+
+    public function getSuppotredExtensions(): mixed
+    {
+        return array_reduce(
+            $this->configFormats,
+            function ($extensions, $format) {
+                $extensions[] = $format->name;
+                return $extensions;
+            }
+        );
+    }
+
+    public function getViewExtensions(): mixed
+    {
+        return array_reduce(
+            $this->configFormats,
+            function ($extensions, $format) {
+                if (in_array("view", $format->actions)) {
+                    $extensions[] = $format->name;
+                }
+                return $extensions;
+            }
+        );
+    }
+
+    public function getEditExtensions(): mixed
+    {
+        return array_reduce(
+            $this->configFormats,
+            function ($extensions, $format) {
+                if (in_array("edit", $format->actions) || in_array("lossy-edit", $format->actions)) {
+                    $extensions[] = $format->name;
+                }
+                return $extensions;
+            }
+        );
+    }
+
+    public function getFillExtensions(): mixed
+    {
+        return array_reduce(
+            $this->configFormats,
+            function ($extensions, $format) {
+                if (in_array("fill", $format->actions)) {
+                    $extensions[] = $format->name;
+                }
+                return $extensions;
+            }
+        );
+    }
+
+    public function getConvertExtensions(): mixed
+    {
+        return array_reduce(
+            $this->configFormats,
+            function ($extensions, $format) {
+                if ($format->type === "word" && in_array("docx", $format->convert)
+                    || $format->type === "cell" && in_array("xlsx", $format->convert)
+                    || $format->type === "slide" && in_array("pptx", $format->convert)) {
+                        $extensions[] = $format->name;
+                }
+                return $extensions;
+            }
+        );
+    }
 }

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

@@ -18,6 +18,9 @@ namespace OnlineEditorsExamplePhp\Helpers;
  * limitations under the License.
  */
 
+use Firebase\JWT\JWT;
+use Firebase\JWT\Key;
+
 final class JwtManager
 {
     /**
@@ -52,7 +55,7 @@ final class JwtManager
     public function jwtEncode($payload)
     {
         $configManager = new ConfigManager();
-        return \Firebase\JWT\JWT::encode($payload, $configManager->getConfig("docServJwtSecret"));
+        return JWT::encode($payload, $configManager->getConfig("docServJwtSecret"), 'HS256');
     }
 
     /**
@@ -66,10 +69,9 @@ final class JwtManager
     {
         $configManager = new ConfigManager();
         try {
-            $payload = \Firebase\JWT\JWT::decode(
+            $payload = JWT::decode(
                 $token,
-                $configManager->getConfig("docServJwtSecret"),
-                ["HS256"]
+                new Key($configManager->getConfig("docServJwtSecret"), 'HS256')
             );
         } catch (\UnexpectedValueException $e) {
             $payload = "";

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

@@ -1,9 +1,5 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
-License:        MIT
-License File:   jQuery.license
-
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
 License File:   jQuery.BlockUI.license
@@ -16,9 +12,13 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
@@ -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/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

@@ -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", '/webeditor-ajax.php?type=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

@@ -212,7 +212,7 @@
 <script type="text/javascript" src="js/jquery.dropdownToggle.js"></script>
 <script type="text/javascript" src="js/jscript.js"></script>
 <script type="text/javascript">
-    var FillFormsExtList = '{docServFillforms}';
+    var FillFormsExtList = '{fillFormsExtList}';
     var ConverExtList = '{converExtList}';
     var EditedExtList = '{editedExtList}';
 </script>

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

@@ -43,13 +43,14 @@ final class DocEditorView extends View
         $confgManager = new ConfigManager();
         $jwtManager = new JwtManager();
         $userList = new ExampleUsers();
+        $fileId = $request["fileID"] ?? "";
         $user = $userList->getUser($request["user"]);
         $isEnableDirectUrl = isset($request["directUrl"]) ? filter_var($request["directUrl"], FILTER_VALIDATE_BOOLEAN)
             : false;
         if (!empty($externalUrl)) {
             $filename = doUpload($externalUrl);
         } else { // if the file url doesn't exist, get file name and file extension
-            $filename = basename($request["fileID"] ?? "");
+            $filename = basename($fileId);
         }
         $createExt = $request["fileExt"] ?? "";
 
@@ -71,12 +72,12 @@ final class DocEditorView extends View
         $docKey = getDocEditorKey($filename);
         $filetype = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
 
-        $ext = mb_strtolower('.' . pathinfo($filename, PATHINFO_EXTENSION));
+        $ext = mb_strtolower(pathinfo($filename, PATHINFO_EXTENSION));
         $editorsMode = empty($request["action"]) ? "edit" : $request["action"];  // get the editors mode
-        $canEdit = in_array($ext, $confgManager->getConfig("docServEdited"));  // check if the file can be edited
+        $canEdit = in_array($ext, $confgManager->getEditExtensions());  // check if the file can be edited
         if ((!$canEdit && $editorsMode == "edit"
                 || $editorsMode == "fillForms")
-            && in_array($ext, $confgManager->getConfig("docServFillforms"))
+            && in_array($ext, $confgManager->getFillExtensions())
         ) {
             $editorsMode = "fillForms";
             $canEdit = true;

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

@@ -41,9 +41,9 @@ final class IndexView extends View
             "editButton" => $this->getEditButton(),
             "dataDocs" => $this->getPreloaderUrl(),
             "date" => date("Y"),
-            "fillFormsExtList" => implode(",", $configManager->getConfig("docServFillforms")),
-            "converExtList" => implode(",", $configManager->getConfig("docServConvert")),
-            "editedExtList" => implode(",", $configManager->getConfig("docServEdited")),
+            "fillFormsExtList" => implode(",", $configManager->getFillExtensions()),
+            "converExtList" => implode(",", $configManager->getConvertExtensions()),
+            "editedExtList" => implode(",", $configManager->getEditExtensions()),
         ];
     }
 

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

@@ -112,6 +112,9 @@ if (isset($_GET["type"]) && !empty($_GET["type"])) {
         case "rename":
             $response_array = renamefile();
             die(json_encode($response_array));
+        case 'restore':
+            $response_array = restore();
+            die(json_encode($response_array));
         default:
             $response_array['status'] = 'error';
             $response_array['error'] = '404 Method not found';

web/documentserver-example/python/.gitignore

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

web/documentserver-example/python/.python-version

@@ -0,0 +1 @@
+3.11

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

@@ -1,12 +1,16 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
+django-stubs  - PEP-484 stubs for Django. (https://github.com/typeddjango/django-stubs/blob/master/LICENSE.md)
+License:        MIT
+License File:   django-stubs.license
+
 Django        - Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out. (https://github.com/django/django/blob/main/LICENSE)
 License:        BSD-3-Clause
 License File:   Django.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+flake8        - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code. (https://github.com/PyCQA/flake8/blob/main/LICENSE)
 License:        MIT
-License File:   jQuery.license
+License File:   flake8.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -20,14 +24,22 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+mypy          - Optional static typing for Python. (https://github.com/python/mypy/blob/master/LICENSE)
+License:        MIT
+License File:   mypy.license
+
 PyJWT         - A Python implementation of RFC 7519. (https://github.com/jpadilla/pyjwt/blob/master/LICENSE)
 License:        MIT
 License File:   PyJWT.license
@@ -39,3 +51,7 @@ License File:   python-magic.license
 requests      - Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your PUT & POST data — but nowadays, just use the json method! (https://github.com/psf/requests/blob/main/LICENSE)
 License:        Apache 2.0
 License File:   requests.license
+
+typeshed      - Collection of library stubs for Python, with static types. (https://github.com/python/typeshed/blob/main/LICENSE)
+License:        Apache 2.0
+License File:   typeshed.license

web/documentserver-example/python/Makefile

@@ -0,0 +1,34 @@
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help: #         Show help message for each of the Makefile recipes.
+	@grep -E "^[a-z-]+: #" $(MAKEFILE_LIST) | \
+		sort | \
+		awk 'BEGIN {FS = ": # "}; {printf "%s: %s\n", $$1, $$2}'
+
+.PHONY: dev
+dev: #          Install development dependencies.
+	@pip install --editable .[development]
+
+.PHONY: lint
+lint: #         Lint the source code for style and check for types.
+	@flake8
+	@mypy .
+
+.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: test
+test: #         Recursively run the tests.
+	@python -m unittest ./src/**/*_tests.py

web/documentserver-example/python/config.py

@@ -1,108 +0,0 @@
-import os
-
-VERSION = '1.5.1'
-
-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/licenses/3rd-Party.license

@@ -1,12 +1,16 @@
 ONLYOFFICE Applications example uses code from the following 3rd party projects:
 
+django-stubs  - PEP-484 stubs for Django. (https://github.com/typeddjango/django-stubs/blob/master/LICENSE.md)
+License:        MIT
+License File:   django-stubs.license
+
 Django        - Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out. (https://github.com/django/django/blob/main/LICENSE)
 License:        BSD-3-Clause
 License File:   Django.license
 
-jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+flake8        - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code. (https://github.com/PyCQA/flake8/blob/main/LICENSE)
 License:        MIT
-License File:   jQuery.license
+License File:   flake8.license
 
 jQuery.BlockUI - The jQuery BlockUI Plugin lets you simulate synchronous behavior when using AJAX, without locking the browser. (https://github.com/malsup/blockui/)
 License:        MIT, GPL
@@ -20,14 +24,22 @@ jQuery.iframe-transport - jQuery Iframe Transport Plugin for File Upload (https:
 License:        MIT
 License File:   jQuery.iframe-transport.license
 
+jQuery        - jQuery is a new kind of JavaScript Library.        jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript.        NOTE: This package is maintained on behalf of the library owners by the NuGet Community Packages project at https://nugetpackages.codeplex.com/ (https://jquery.org/license/)
+License:        MIT
+License File:   jQuery.license
+
 jQuery.Migrate - Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used. (https://github.com/jquery/jquery-migrate/blob/main/LICENSE.txt)
-License:         OpenJS
-License File:    jQuery.Migrate.license
+License:        OpenJS
+License File:   jQuery.Migrate.license
 
 jQuery.UI     - jQuery UI is an open source library of interface components — interactions, full-featured widgets, and animation effects — based on the stellar jQuery javascript library . Each component is built according to jQuery's event-driven architecture (find something, manipulate it) and is themeable, making it easy for developers of any skill level to integrate and extend into their own code. (https://jquery.org/license/)
 License:        MIT
 License File:   jQuery.UI.license
 
+mypy          - Optional static typing for Python. (https://github.com/python/mypy/blob/master/LICENSE)
+License:        MIT
+License File:   mypy.license
+
 PyJWT         - A Python implementation of RFC 7519. (https://github.com/jpadilla/pyjwt/blob/master/LICENSE)
 License:        MIT
 License File:   PyJWT.license
@@ -39,3 +51,7 @@ License File:   python-magic.license
 requests      - Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your PUT & POST data — but nowadays, just use the json method! (https://github.com/psf/requests/blob/main/LICENSE)
 License:        Apache 2.0
 License File:   requests.license
+
+typeshed      - Collection of library stubs for Python, with static types. (https://github.com/python/typeshed/blob/main/LICENSE)
+License:        Apache 2.0
+License File:   typeshed.license

web/documentserver-example/python/licenses/django-stubs.license

@@ -0,0 +1,8 @@
+Copyright (c) Maxim Kurnikov.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

web/documentserver-example/python/licenses/flake8.license

@@ -0,0 +1,22 @@
+== Flake8 License (MIT) ==
+
+Copyright (C) 2011-2013 Tarek Ziade <tarek@ziade.org>
+Copyright (C) 2012-2016 Ian Cordasco <graffatcolmingov@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

web/documentserver-example/python/licenses/mypy.license

@@ -0,0 +1,229 @@
+Mypy (and mypyc) are licensed under the terms of the MIT license, reproduced below.
+
+= = = = =
+
+The MIT License
+
+Copyright (c) 2012-2022 Jukka Lehtosalo and contributors
+Copyright (c) 2015-2022 Dropbox, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+= = = = =
+
+Portions of mypy and mypyc are licensed under different licenses.
+The files
+mypyc/lib-rt/pythonsupport.h, mypyc/lib-rt/getargs.c and
+mypyc/lib-rt/getargsfast.c are licensed under the PSF 2 License, reproduced
+below.
+
+= = = = =
+
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF hereby
+grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+analyze, test, perform and/or display publicly, prepare derivative works,
+distribute, and otherwise use Python alone or in any derivative version,
+provided, however, that PSF's License Agreement and PSF's notice of copyright,
+i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+2011, 2012 Python Software Foundation; All Rights Reserved" are retained in Python
+alone or in any derivative version prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
+
+BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
+-------------------------------------------
+
+BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
+
+1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
+office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
+Individual or Organization ("Licensee") accessing and otherwise using
+this software in source or binary form and its associated
+documentation ("the Software").
+
+2. Subject to the terms and conditions of this BeOpen Python License
+Agreement, BeOpen hereby grants Licensee a non-exclusive,
+royalty-free, world-wide license to reproduce, analyze, test, perform
+and/or display publicly, prepare derivative works, distribute, and
+otherwise use the Software alone or in any derivative version,
+provided, however, that the BeOpen Python License is retained in the
+Software, alone or in any derivative version prepared by Licensee.
+
+3. BeOpen is making the Software available to Licensee on an "AS IS"
+basis.  BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
+SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
+AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
+DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+5. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+6. This License Agreement shall be governed by and interpreted in all
+respects by the law of the State of California, excluding conflict of
+law provisions.  Nothing in this License Agreement shall be deemed to
+create any relationship of agency, partnership, or joint venture
+between BeOpen and Licensee.  This License Agreement does not grant
+permission to use BeOpen trademarks or trade names in a trademark
+sense to endorse or promote products or services of Licensee, or any
+third party.  As an exception, the "BeOpen Python" logos available at
+http://www.pythonlabs.com/logos.html may be used according to the
+permissions granted on that web page.
+
+7. By copying, installing or otherwise using the software, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
+
+CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
+---------------------------------------
+
+1. This LICENSE AGREEMENT is between the Corporation for National
+Research Initiatives, having an office at 1895 Preston White Drive,
+Reston, VA 20191 ("CNRI"), and the Individual or Organization
+("Licensee") accessing and otherwise using Python 1.6.1 software in
+source or binary form and its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, CNRI
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
+license to reproduce, analyze, test, perform and/or display publicly,
+prepare derivative works, distribute, and otherwise use Python 1.6.1
+alone or in any derivative version, provided, however, that CNRI's
+License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
+1995-2001 Corporation for National Research Initiatives; All Rights
+Reserved" are retained in Python 1.6.1 alone or in any derivative
+version prepared by Licensee.  Alternately, in lieu of CNRI's License
+Agreement, Licensee may substitute the following text (omitting the
+quotes): "Python 1.6.1 is made available subject to the terms and
+conditions in CNRI's License Agreement.  This Agreement together with
+Python 1.6.1 may be located on the Internet using the following
+unique, persistent identifier (known as a handle): 1895.22/1013.  This
+Agreement may also be obtained from a proxy server on the Internet
+using the following URL: http://hdl.handle.net/1895.22/1013".
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python 1.6.1 or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python 1.6.1.
+
+4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
+basis.  CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. This License Agreement shall be governed by the federal
+intellectual property law of the United States, including without
+limitation the federal copyright law, and, to the extent such
+U.S. federal law does not apply, by the law of the Commonwealth of
+Virginia, excluding Virginia's conflict of law provisions.
+Notwithstanding the foregoing, with regard to derivative works based
+on Python 1.6.1 that incorporate non-separable material that was
+previously distributed under the GNU General Public License (GPL), the
+law of the Commonwealth of Virginia shall govern this License
+Agreement only as to issues arising under or with respect to
+Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in this
+License Agreement shall be deemed to create any relationship of
+agency, partnership, or joint venture between CNRI and Licensee.  This
+License Agreement does not grant permission to use CNRI trademarks or
+trade name in a trademark sense to endorse or promote products or
+services of Licensee, or any third party.
+
+8. By clicking on the "ACCEPT" button where indicated, or by copying,
+installing or otherwise using Python 1.6.1, Licensee agrees to be
+bound by the terms and conditions of this License Agreement.
+
+        ACCEPT
+
+
+CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
+--------------------------------------------------
+
+Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
+The Netherlands.  All rights reserved.
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation, and that the name of Stichting Mathematisch
+Centrum or CWI not be used in advertising or publicity pertaining to
+distribution of the software without specific, written prior
+permission.
+
+STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
+THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
+FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

web/documentserver-example/python/licenses/typeshed.license

@@ -0,0 +1,237 @@
+The "typeshed" project is licensed under the terms of the Apache license, as
+reproduced below.
+
+= = = = =
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.
+
+= = = = =
+
+Parts of typeshed are licensed under different licenses (like the MIT
+license), reproduced below.
+
+= = = = =
+
+The MIT License
+
+Copyright (c) 2015 Jukka Lehtosalo and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+= = = = =

web/documentserver-example/python/manage.py

@@ -1,21 +1,88 @@
-#!/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():
+    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('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/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = [
+	"setuptools>=67.6.0"
+]
+
+[project]
+name = "online-editor-example"
+version = "1.6.0"
+requires-python = ">=3.11"
+dependencies = [
+	"django>=3.1.3",
+	"django-stubs>=4.2.3",
+	"pyjwt>=2.6.0",
+	"python-magic>=0.4.27",
+	"requests>=2.25.0"
+]
+
+[project.license]
+text = "Apache-2.0"
+
+[[project.authors]]
+name = "ONLYOFFICE"
+email = "support@onlyoffice.com"
+
+[project.optional-dependencies]
+development = [
+	"flake8>=6.0.0",
+	"mypy>=1.4.1",
+	"types-requests>=2.31.0"
+]
+
+[tool.mypy]
+plugins = [
+	"mypy_django_plugin.main"
+]
+
+[tool.django-stubs]
+django_settings_module = "manage"

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,228 @@
+#
+# (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_url(self) -> ParseResult:
+        url = (
+            environ.get('DOCUMENT_SERVER_URL') or
+            'http://document-server'
+        )
+        return urlparse(url)
+
+    def document_server_api_url(self) -> ParseResult:
+        server_url = self.document_server_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_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_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_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 fillable_file_extensions(self) -> list[str]:
+        return [
+            '.docx',
+            '.oform'
+        ]
+
+    def viewable_file_extensions(self) -> list[str]:
+        return [
+            '.djvu',
+            '.oxps',
+            '.pdf',
+            '.xps'
+        ]
+
+    def editable_file_extensions(self) -> list[str]:
+        return [
+            '.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'
+        ]
+
+    def convertible_file_extensions(self) -> list[str]:
+        return [
+            '.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'
+        ]
+
+    def spreadsheet_file_extensions(self) -> list[str]:
+        return [
+            '.xls',  '.xlsx',
+            '.xlsm', '.xlsb',
+            '.xlt',  '.xltx',
+            '.xltm', '.ods',
+            '.fods', '.ots',
+            '.csv'
+        ]
+
+    def presentation_file_extensions(self) -> list[str]:
+        return [
+            '.pps',  '.ppsx',
+            '.ppsm', '.ppt',
+            '.pptx', '.pptm',
+            '.pot',  '.potx',
+            '.potm', '.odp',
+            '.fodp', '.otp'
+        ]
+
+    def document_file_extensions(self) -> list[str]:
+        return [
+            '.doc',   '.docx', '.docm',
+            '.dot',   '.dotx', '.dotm',
+            '.odt',   '.fodt', '.ott',
+            '.rtf',   '.txt',  '.html',
+            '.htm',   '.mht',  '.xml',
+            '.pdf',   '.djvu', '.fb2',
+            '.epub',  '.xps',  '.oxps',
+            '.oform'
+        ]
+
+    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,241 @@
+#
+# (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 . 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 ConfigurationManagerDocumentServerURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_url()
+        self.assertEqual(url.geturl(), 'http://document-server')
+
+    @patch.dict(environ, {
+        'DOCUMENT_SERVER_URL': 'http://localhost'
+    })
+    def test_assigns_a_value_from_the_environment(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_url()
+        self.assertEqual(url.geturl(), 'http://localhost')
+
+class ConfigurationManagerDocumentServerAPIURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_api_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://document-server/web-apps/apps/api/documents/api.js'
+        )
+
+    @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://document-server/api'
+        )
+
+class ConfigurationManagerDocumentServerPreloaderURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_preloader_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://document-server/web-apps/apps/api/documents/cache-scripts.html'
+        )
+
+    @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://document-server/preloader'
+        )
+
+class ConfigurationManagerDocumentServerCommandURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_command_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://document-server/coauthoring/CommandService.ashx'
+        )
+
+    @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://document-server/command'
+        )
+
+class ConfigurationManagerDocumentServerConverterURLTests(TestCase):
+    def test_assigns_a_default_value(self):
+        config_manager = ConfigurationManager()
+        url = config_manager.document_server_converter_url()
+        self.assertEqual(
+            url.geturl(),
+            'http://document-server/ConvertService.ashx'
+        )
+
+    @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://document-server/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/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()

web/documentserver-example/python/src/utils/docManager.py

@@ -17,7 +17,6 @@
 """
 
 
-import config
 import os
 import shutil
 import io
@@ -27,24 +26,27 @@ import time
 import urllib.parse
 import magic
 
+from django.conf import settings
 from django.http import HttpResponse, HttpResponseRedirect, FileResponse
-from src import settings
+from src.configuration import ConfigurationManager
 from . import fileUtils, historyManager
 
+config_manager = ConfigurationManager()
+
 def isCanFillForms(ext):
-    return ext in config.DOC_SERV_FILLFORMS
+    return ext in config_manager.fillable_file_extensions()
 
 # check if the file extension can be viewed
 def isCanView(ext):
-    return ext in config.DOC_SERV_VIEWED
+    return ext in config_manager.viewable_file_extensions()
 
 # check if the file extension can be edited
 def isCanEdit(ext):
-    return ext in config.DOC_SERV_EDITED
+    return ext in config_manager.editable_file_extensions()
 
 # check if the file extension can be converted
 def isCanConvert(ext):
-    return ext in config.DOC_SERV_CONVERT
+    return ext in config_manager.convertible_file_extensions()
 
 # check if the file extension is supported by the editor (it can be viewed or edited or converted)
 def isSupportedExt(ext):
@@ -87,8 +89,9 @@ def getCorrectName(filename, req):
 
 # get server url
 def getServerUrl (forDocumentServer, req):
-    if (forDocumentServer and config.EXAMPLE_DOMAIN is not None):
-        return  config.EXAMPLE_DOMAIN 
+    example_url = config_manager.example_url()
+    if (forDocumentServer and example_url is not None):
+        return example_url.geturl()
     else:
         return req.headers.get("x-forwarded-proto") or req.scheme + "://" + req.get_host()
 
@@ -122,7 +125,8 @@ def getRootFolder(req):
     else:
         curAdr = req.META['REMOTE_ADDR']
 
-    directory = config.STORAGE_PATH if os.path.isabs(config.STORAGE_PATH) else os.path.join(config.STORAGE_PATH, curAdr)
+    storage_directory = config_manager.storage_path()
+    directory = storage_directory.joinpath(curAdr)
 
     if not os.path.exists(directory): # if such a directory does not exist, make it
         os.makedirs(directory)
@@ -136,7 +140,8 @@ def getHistoryPath(filename, file, version, req):
     else:
         curAdr = req.META['REMOTE_ADDR']
 
-    directory = os.path.join(config.STORAGE_PATH, curAdr)
+    storage_directory = config_manager.storage_path()
+    directory = storage_directory.joinpath(curAdr)
     if not os.path.exists(directory): # the directory with host address doesn't exist
         filePath = os.path.join(getRootFolder(req), f'{filename}-hist', version, file)
     else:
@@ -157,7 +162,8 @@ def getForcesavePath(filename, req, create):
     else:
         curAdr = req.META['REMOTE_ADDR']
 
-    directory = os.path.join(config.STORAGE_PATH, curAdr)
+    storage_directory = config_manager.storage_path()
+    directory = storage_directory.joinpath(curAdr)
     if not os.path.exists(directory): # the directory with host address doesn't exist
         return ""
  
@@ -210,7 +216,7 @@ def saveFile(response, path):
 
 # download file from the given url 
 def downloadFileFromUri(uri, path = None, withSave = False):
-    resp = requests.get(uri, stream=True, verify = config.DOC_SERV_VERIFY_PEER, timeout=5)
+    resp = requests.get(uri, stream=True, verify = config_manager.ssl_verify_peer_mode_enabled(), timeout=5)
     status_code = resp.status_code
     if status_code != 200:  # checking status code
         raise RuntimeError('Document editing service returned status: %s' % status_code)
@@ -293,6 +299,7 @@ def getFilesInfo(req):
 def download(filePath):
     response = FileResponse(open(filePath, 'rb'), True) # write headers to the response object
     response['Content-Length'] =  os.path.getsize(filePath)
-    response['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + urllib.parse.unquote(os.path.basename(filePath))
+    response['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + urllib.parse.quote_plus(os.path.basename(filePath))
     response['Content-Type'] = magic.from_file(filePath, mime=True)
+    response['Access-Control-Allow-Origin'] = "*"
     return response

web/documentserver-example/python/src/utils/fileUtils.py

@@ -16,7 +16,9 @@
 
 """
 
-import config
+from src.configuration import ConfigurationManager
+
+config_manager = ConfigurationManager()
 
 # get file name from the document url
 def getFileName(str):
@@ -38,11 +40,11 @@ def getFileExt(str):
 # get file type
 def getFileType(str):
     ext = getFileExt(str)
-    if ext in config.EXT_DOCUMENT:
+    if ext in config_manager.document_file_extensions():
         return 'word'
-    if ext in config.EXT_SPREADSHEET:
+    if ext in config_manager.spreadsheet_file_extensions():
         return 'cell'
-    if ext in config.EXT_PRESENTATION:
+    if ext in config_manager.presentation_file_extensions():
         return 'slide'
 
     return 'word' # default file type is word

web/documentserver-example/python/src/utils/historyManager.py

@@ -19,14 +19,15 @@
 import os
 import io
 import json
-import config
 
 from . import users, fileUtils
 from datetime import datetime
-from src import settings
+from src.configuration import ConfigurationManager
 from src.utils import docManager
 from src.utils import jwtManager
     
+config_manager = ConfigurationManager()
+
 # get the path to the history direction
 def getHistoryDir(storagePath):
     return f'{storagePath}-hist'
@@ -226,5 +227,5 @@ class CorsHeaderMiddleware:
     def __call__(self, request):
         resp = self.get_response(request)
         if request.path == '/downloadhistory':
-            resp['Access-Control-Allow-Origin'] = config.DOC_SERV_SITE_URL[0:-1]
+            resp['Access-Control-Allow-Origin'] = config_manager.document_server_url().geturl()
         return resp

web/documentserver-example/python/src/utils/jwtManager.py

@@ -16,21 +16,23 @@
 
 """
 
-import config
 import jwt
+from src.configuration import ConfigurationManager
+
+config_manager = ConfigurationManager()
 
 # check if a secret key to generate token exists or not
 def isEnabled():
-    return bool(config.DOC_SERV_JWT_SECRET)
+    return bool(config_manager.jwt_secret())
 
 # check if a secret key to generate token exists or not
 def useForRequest():
-    return bool(config.DOC_SERV_JWT_USE_FOR_REQUEST)
+    return config_manager.jwt_use_for_request()
 
 # encode a payload object into a token using a secret key and decodes it into the utf-8 format
 def encode(payload):
-    return jwt.encode(payload, config.DOC_SERV_JWT_SECRET, algorithm='HS256')
+    return jwt.encode(payload, config_manager.jwt_secret(), algorithm='HS256')
 
 # decode a token into a payload object using a secret key
 def decode(string):
-    return jwt.decode(string, config.DOC_SERV_JWT_SECRET, algorithms=['HS256'])
+    return jwt.decode(string, config_manager.jwt_secret(), algorithms=['HS256'])

web/documentserver-example/python/src/utils/serviceConverter.py

@@ -18,10 +18,12 @@
 
 import json
 import requests
-import config
 
+from src.configuration import ConfigurationManager
 from . import fileUtils, jwtManager
 
+config_manager = ConfigurationManager()
+
 # convert file and give url to a new file
 def getConvertedData(docUri, fromExt, toExt, docKey, isAsync, filePass = None, lang = None):
     if not fromExt: # check if the extension from the request matches the real file extension
@@ -45,12 +47,11 @@ def getConvertedData(docUri, fromExt, toExt, docKey, isAsync, filePass = None, l
         payload.setdefault('async', True) # and write this information to the payload object
 
     if (jwtManager.isEnabled() and jwtManager.useForRequest()): # check if a secret key to generate token exists or not
-        jwtHeader = 'Authorization' if config.DOC_SERV_JWT_HEADER is None or config.DOC_SERV_JWT_HEADER == '' else config.DOC_SERV_JWT_HEADER # get jwt header
         headerToken = jwtManager.encode({'payload': payload}) # encode a payload object into a header token
         payload['token'] = jwtManager.encode(payload) # encode a payload object into a body token
-        headers[jwtHeader] = f'Bearer {headerToken}' # add a header Authorization with a header token with Authorization prefix in it
+        headers[config_manager.jwt_header()] = f'Bearer {headerToken}' # add a header Authorization with a header token with Authorization prefix in it
 
-    response = requests.post(config.DOC_SERV_SITE_URL + config.DOC_SERV_CONVERTER_URL, json=payload, headers=headers, verify = config.DOC_SERV_VERIFY_PEER, timeout=5) # send the headers and body values to the converter and write the result to the response
+    response = requests.post(config_manager.document_server_converter_url().geturl(), json=payload, headers=headers, verify = config_manager.ssl_verify_peer_mode_enabled(), timeout=5) # send the headers and body values to the converter and write the result to the response
     status_code = response.status_code
     if status_code != 200:  # checking status code
         raise RuntimeError('Convertation service returned status: %s' % status_code)

web/documentserver-example/python/src/utils/trackManager.py

@@ -17,12 +17,14 @@
 """
 
 
-import config
 import requests
 import os
 import json
+from src.configuration import ConfigurationManager
 from . import jwtManager, docManager, historyManager, fileUtils, serviceConverter
 
+config_manager = ConfigurationManager()
+
 # read request body
 def readBody(request):
     body = json.loads(request.body)
@@ -30,8 +32,7 @@ def readBody(request):
         token = body.get('token') # get the document token
 
         if (not token): # if JSON web token is not received
-            jwtHeader = 'Authorization' if config.DOC_SERV_JWT_HEADER is None or config.DOC_SERV_JWT_HEADER == '' else config.DOC_SERV_JWT_HEADER
-            token = request.headers.get(jwtHeader) # get it from the Authorization header
+            token = request.headers.get(config_manager.jwt_header()) # get it from the Authorization header
             if token:
                 token = token[len('Bearer '):] # and save it without Authorization prefix
 
@@ -152,8 +153,6 @@ def processForceSave(body, filename, usAddr):
 
 # create a command request
 def commandRequest(method, key, meta = None):
-    documentCommandUrl = config.DOC_SERV_SITE_URL + config.DOC_SERV_COMMAND_URL
-
     payload = {
         'c': method,
         'key': key
@@ -166,12 +165,11 @@ def commandRequest(method, key, meta = None):
     headers={'accept': 'application/json'}
 
     if (jwtManager.isEnabled() and jwtManager.useForRequest()): # check if a secret key to generate token exists or not
-        jwtHeader = 'Authorization' if config.DOC_SERV_JWT_HEADER is None or config.DOC_SERV_JWT_HEADER == '' else config.DOC_SERV_JWT_HEADER # get jwt header
         headerToken = jwtManager.encode({'payload': payload}) # encode a payload object into a header token
-        headers[jwtHeader] = f'Bearer {headerToken}' # add a header Authorization with a header token with Authorization prefix in it
+        headers[config_manager.jwt_header()] = f'Bearer {headerToken}' # add a header Authorization with a header token with Authorization prefix in it
 
         payload['token'] = jwtManager.encode(payload) # encode a payload object into a body token
-    response = requests.post(documentCommandUrl, json=payload, headers=headers, verify = config.DOC_SERV_VERIFY_PEER)
+    response = requests.post(config_manager.document_server_command_url().geturl(), json=payload, headers=headers, verify = config_manager.ssl_verify_peer_mode_enabled())
 
     if (meta): 
         return response