From ce9d62ad7daf9385938ce029dc071fb1e07b85d0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 12:31:56 +0300 Subject: [PATCH 001/176] ruby: Layout/EmptyLineAfterGuardClause correct --- .../ruby/app/configuration/configuration.rb | 6 ++++++ web/documentserver-example/ruby/app/format/format.rb | 1 + .../ruby/app/models/document_helper.rb | 1 + web/documentserver-example/ruby/app/models/track_helper.rb | 2 ++ web/documentserver-example/ruby/app/proxy/proxy.rb | 1 + 5 files changed, 11 insertions(+) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index 5803b11e..c2c1846f 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -37,6 +37,7 @@ class ConfigurationManager def example_uri url = ENV['EXAMPLE_URL'] return nil if url.nil? + URI(url) end @@ -50,6 +51,7 @@ class ConfigurationManager def document_server_private_uri url = ENV['DOCUMENT_SERVER_PRIVATE_URL'] return URI(url) if url + document_server_public_uri end @@ -99,6 +101,7 @@ class ConfigurationManager def jwt_use_for_request env = ENV['JWT_USE_FOR_REQUEST'] return ActiveModel::Type::Boolean.new.cast(env) if env + true end @@ -106,6 +109,7 @@ class ConfigurationManager def ssl_verify_peer_mode_enabled env = ENV['SSL_VERIFY_PEER_MODE_ENABLED'] return ActiveModel::Type::Boolean.new.cast(env) if env + false end @@ -114,6 +118,7 @@ class ConfigurationManager storage_path = ENV['STORAGE_PATH'] || 'storage' storage_directory = Pathname(storage_path) return storage_directory if storage_directory.absolute? + current_directory = Pathname(File.expand_path(__dir__)) directory = current_directory.join('..', '..', storage_directory) directory.cleanpath @@ -123,6 +128,7 @@ class ConfigurationManager def maximum_file_size env = ENV['MAXIMUM_FILE_SIZE'] return env.to_i if env + 5 * 1024 * 1024 end diff --git a/web/documentserver-example/ruby/app/format/format.rb b/web/documentserver-example/ruby/app/format/format.rb index 130210fa..0cca61d8 100644 --- a/web/documentserver-example/ruby/app/format/format.rb +++ b/web/documentserver-example/ruby/app/format/format.rb @@ -136,6 +136,7 @@ class FormatManager sig { returns(T::Array[Format]) } def all return @all if defined?(@all) + content = file.read hash = JSON.parse(content) @all ||= hash.map do |item| diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 2bb9b9f0..47d5dce3 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -139,6 +139,7 @@ class DocumentHelper Dir.foreach(hist_dir) {|e| # run through all the file versions next if e.eql?(".") next if e.eql?("..") + if File.directory?(File.join(hist_dir, e)) ver += 1 # and count them end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 844e9193..92f30685 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -303,11 +303,13 @@ class TrackHelper if status_code != '200' # checking status code raise "Document editing service returned status: #{status_code}" end + data = res.body # and take its body if data == nil raise 'stream is null' end + data end diff --git a/web/documentserver-example/ruby/app/proxy/proxy.rb b/web/documentserver-example/ruby/app/proxy/proxy.rb index fa1c66b4..fd5a364c 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy.rb @@ -32,6 +32,7 @@ class ProxyManager sig { params(uri: URI::Generic).returns(URI::Generic) } def resolve_uri(uri) return uri unless refer_public_url(uri) + redirect_public_url(uri) end From 266e249b125aaec2d96896f36d3bfe0ff97314b8 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 12:37:38 +0300 Subject: [PATCH 002/176] ruby: Layout/TrailingEmptyLines correct --- .../ruby/app/controllers/application_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- web/documentserver-example/ruby/app/models/jwt_helper.rb | 2 +- web/documentserver-example/ruby/app/models/service_converter.rb | 2 +- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 1 - 7 files changed, 6 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/application_controller.rb b/web/documentserver-example/ruby/app/controllers/application_controller.rb index 92474a5f..32ce5cfd 100644 --- a/web/documentserver-example/ruby/app/controllers/application_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/application_controller.rb @@ -15,4 +15,4 @@ # class ApplicationController < ActionController::Base -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 47d5dce3..ab7f5d44 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -341,4 +341,4 @@ class DocumentHelper end end -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index da63a1aa..43ea40dc 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -386,4 +386,4 @@ class FileModel return @direct_url != nil && @direct_url == "true" end -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 838659bd..4101c144 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -50,4 +50,4 @@ class JwtHelper return decoded[0].to_json # get json payload end end -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index f4d4e86c..aa951621 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -184,4 +184,4 @@ class ServiceConverter end -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 92f30685..a3250eac 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -319,4 +319,4 @@ class TrackHelper end end end -end \ No newline at end of file +end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index bf0faabf..fe827482 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -145,4 +145,3 @@ class Users end end - From e9e6586d6d9110f59e2c65e65369a45de9813545 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 12:43:19 +0300 Subject: [PATCH 003/176] ruby: Layout/EmptyLinesAroundMethodBody correct --- .../ruby/app/controllers/home_controller.rb | 8 -------- .../ruby/app/models/document_helper.rb | 7 ------- web/documentserver-example/ruby/app/models/file_model.rb | 1 - .../ruby/app/models/service_converter.rb | 6 ------ 4 files changed, 22 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 8b6a0f71..c47353ba 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -30,26 +30,21 @@ class HomeController < ApplicationController end def editor - DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) @file = FileModel.new(:file_name => File.basename(params[:fileName]), :mode => params[:editorsMode], :type => params[:editorsType], :user_ip => request.remote_ip, :lang => cookies[:ulang], :user => user, :action_data => params[:actionLink], :direct_url => params[:directUrl]) - end # creating a sample document def sample - DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) file_name = DocumentHelper.create_demo(params[:fileExt], params[:sample], user) redirect_to :controller => 'home', :action => 'editor', :fileName => file_name, :userId => user.id - end # uploading a file def upload - DocumentHelper.init(request.remote_ip, request.base_url) begin @@ -87,12 +82,10 @@ class HomeController < ApplicationController rescue => ex render plain: '{ "error": "' + ex.message + '"}' # write an error message to the response end - end # converting a file def convert - begin file_data = request.body.read if file_data == nil || file_data.empty? @@ -154,7 +147,6 @@ class HomeController < ApplicationController rescue => ex render plain: '{ "error": "' + ex.message + '"}' end - end # downloading a history file from public diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index ab7f5d44..dff8bd61 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -244,29 +244,22 @@ class DocumentHelper # get callback url def get_callback(file_name) - get_server_url(true) + '/track?fileName=' + ERB::Util.url_encode(file_name) + '&userAddress=' + cur_user_host_address(nil) - end # get url to the created file def get_create_url(document_type) - get_server_url(false) + '/sample?fileExt=' + get_internal_extension(document_type).delete('.') - end # get url to download a file def get_download_url(file_name, is_serverUrl=true) - user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host - end # get internal file extension by its type def get_internal_extension(file_type) - case file_type when 'word' # .docx for word type ext = '.docx' diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 43ea40dc..15a7d355 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -289,7 +289,6 @@ class FileModel end return nil - end # get image information diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index aa951621..b7268f01 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -30,7 +30,6 @@ class ServiceConverter # get the url of the converted file def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) - from_ext = from_ext == nil ? File.extname(document_uri).downcase : from_ext # get the current document extension # get the current document name or uuid @@ -93,7 +92,6 @@ class ServiceConverter # generate the document key value def generate_revision_id(expected_key) - require 'zlib' if expected_key.length > 20 # check if the expected key length is greater than 20 @@ -102,12 +100,10 @@ class ServiceConverter key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') key[(key.length - [key.length, 20].min)..key.length] # the resulting key is of the length 20 or less - end # create an error message for the error code def process_convert_service_responce_error(error_code) - error_message = 'unknown error' # add an error message to the error message template depending on the error code @@ -135,12 +131,10 @@ class ServiceConverter end raise error_message - end # get the response url def get_response_data(json_data) - file_result = json_data error_element = file_result['error'] From 1b91592a9a90cd36fb91b829aa36aa7e207222cf Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:10:31 +0300 Subject: [PATCH 004/176] ruby: Layout/ExtraSpacing correct --- .../ruby/app/controllers/home_controller.rb | 68 +++++----- .../ruby/app/models/document_helper.rb | 56 ++++---- .../ruby/app/models/file_model.rb | 120 +++++++++--------- .../ruby/app/models/service_converter.rb | 54 ++++---- .../ruby/app/models/track_helper.rb | 86 ++++++------- .../ruby/app/models/users.rb | 6 +- 6 files changed, 195 insertions(+), 195 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index c47353ba..f4218dbd 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -78,9 +78,9 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) - render plain: '{ "filename": "' + file_name + '", "documentType": "' + document_type + '"}' # write a new file name to the response + render plain: '{ "filename": "' + file_name + '", "documentType": "' + document_type + '"}' # write a new file name to the response rescue => ex - render plain: '{ "error": "' + ex.message + '"}' # write an error message to the response + render plain: '{ "error": "' + ex.message + '"}' # write an error message to the response end end @@ -101,9 +101,9 @@ class HomeController < ApplicationController extension = File.extname(file_name).downcase internal_extension = 'ooxml' - if DocumentHelper.convert_exts.include? (extension) # check if the file with such an extension can be converted - key = ServiceConverter.generate_revision_id(file_uri) # generate document key - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(file_uri, extension.delete('.'), internal_extension.delete('.'), key, true, file_pass, lang) # get the url and file type of the converted file and the conversion percentage + if DocumentHelper.convert_exts.include? (extension) # check if the file with such an extension can be converted + key = ServiceConverter.generate_revision_id(file_uri) # generate document key + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(file_uri, extension.delete('.'), internal_extension.delete('.'), key, true, file_pass, lang) # get the url and file type of the converted file and the conversion percentage # if the conversion isn't completed, write file name and step values to the response if percent != 100 @@ -114,12 +114,12 @@ class HomeController < ApplicationController # get the correct file name if such a name already exists correct_name = DocumentHelper.get_correct_name(File.basename(file_name, extension) + "." + new_file_type, nil) - uri = URI.parse(new_file_uri) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(new_file_uri) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server DocumentHelper.verify_ssl(new_file_uri, http) - req = Net::HTTP::Get.new(uri.request_uri) # create the get requets + req = Net::HTTP::Get.new(uri.request_uri) # create the get requets res = http.request(req) data = res.body @@ -140,7 +140,7 @@ class HomeController < ApplicationController file_name = correct_name user = Users.get_user(params[:userId]) - DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file + DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file end render plain: '{ "filename" : "' + file_name + '"}' @@ -190,9 +190,9 @@ class HomeController < ApplicationController # tracking file changes def track - file_data = TrackHelper.read_body(request) # read the request body + file_data = TrackHelper.read_body(request) # read the request body if file_data == nil || file_data.empty? - render plain: '{"error":1}' # an error occurs if the file is empty + render plain: '{"error":1}' # an error occurs if the file is empty return end @@ -201,23 +201,23 @@ class HomeController < ApplicationController user_address = params[:userAddress] file_name = File.basename(params[:fileName]) - if status == 1 # editing - if file_data['actions'][0]['type'] == 0 # finished edit - user = file_data['actions'][0]['userid'] # get the user id + if status == 1 # editing + if file_data['actions'][0]['type'] == 0 # finished edit + user = file_data['actions'][0]['userid'] # get the user id if !file_data['users'].index(user) - json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command + json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command end end end - if status == 2 || status == 3 # MustSave, Corrupted - saved = TrackHelper.process_save(file_data, file_name, user_address) # save file + if status == 2 || status == 3 # MustSave, Corrupted + saved = TrackHelper.process_save(file_data, file_name, user_address) # save file render plain: '{"error":' + saved.to_s + '}' return end - if status == 6 || status == 7 # MustForceave, CorruptedForcesave - saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file + if status == 6 || status == 7 # MustForceave, CorruptedForcesave + saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file render plain: '{"error":' + saved.to_s + '}' return end @@ -228,9 +228,9 @@ class HomeController < ApplicationController # removing a file def remove - file_name = File.basename(params[:filename]) # get the file name - if !file_name # if it doesn't exist - render plain: '{"success":false}' # report that the operation is unsuccessful + file_name = File.basename(params[:filename]) # get the file name + if !file_name # if it doesn't exist + render plain: '{"success":false}' # report that the operation is unsuccessful return end @@ -238,22 +238,22 @@ class HomeController < ApplicationController storage_path = DocumentHelper.storage_path(file_name, nil) hist_dir = DocumentHelper.history_dir(storage_path) - if File.exist?(storage_path) # if the file exists - File.delete(storage_path) # delete it from the storage path + if File.exist?(storage_path) # if the file exists + File.delete(storage_path) # delete it from the storage path end - if Dir.exist?(hist_dir) # if the history directory of this file exists - FileUtils.remove_entry_secure(hist_dir) # delete it + if Dir.exist?(hist_dir) # if the history directory of this file exists + FileUtils.remove_entry_secure(hist_dir) # delete it end - render plain: '{"success":true}' # report that the operation is successful + render plain: '{"success":true}' # report that the operation is successful return end # getting files information def files file_id = params[:fileId] - filesInfo = DocumentHelper.get_files_info(file_id) # get the information about the file specified by a file id + filesInfo = DocumentHelper.get_files_info(file_id) # get the information about the file specified by a file id render json: filesInfo end @@ -290,9 +290,9 @@ class HomeController < ApplicationController end end - file_path = DocumentHelper.forcesave_path(file_name, user_address, false) # get the path to the force saved document version + file_path = DocumentHelper.forcesave_path(file_name, user_address, false) # get the path to the force saved document version if file_path.eql?("") - file_path = DocumentHelper.storage_path(file_name, user_address) # or to the original document + file_path = DocumentHelper.storage_path(file_name, user_address) # or to the original document end # add headers to the response to specify the page parameters @@ -321,12 +321,12 @@ class HomeController < ApplicationController return end - uri = URI.parse(file_url) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(file_url) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server DocumentHelper.verify_ssl(file_url, http) - req = Net::HTTP::Get.new(uri.request_uri) # create the get requets + req = Net::HTTP::Get.new(uri.request_uri) # create the get requets res = http.request(req) data = res.body @@ -339,7 +339,7 @@ class HomeController < ApplicationController file.write(data) end user = Users.get_user(params[:userId]) - DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file + DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file render plain: '{"file" : "' + file_name + '"}' return diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index dff8bd61..ab6be3bd 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -93,16 +93,16 @@ class DocumentHelper return "" end - directory = File.join(directory,"#{File.basename(file_name)}-hist") # get the path to the history of the given file + directory = File.join(directory,"#{File.basename(file_name)}-hist") # get the path to the history of the given file unless File.directory?(directory) if create - FileUtils.mkdir_p(directory) # create history directory if it doesn't exist + FileUtils.mkdir_p(directory) # create history directory if it doesn't exist else - return "" # the history directory doesn't exist and we are not supposed to create it + return "" # the history directory doesn't exist and we are not supposed to create it end end - directory = File.join(directory, File.basename(file_name)) # get the path to the given file + directory = File.join(directory, File.basename(file_name)) # get the path to the given file unless File.file?(directory) if !create return "" @@ -136,12 +136,12 @@ class DocumentHelper end ver = 1 - Dir.foreach(hist_dir) {|e| # run through all the file versions + Dir.foreach(hist_dir) {|e| # run through all the file versions next if e.eql?(".") next if e.eql?("..") if File.directory?(File.join(hist_dir, e)) - ver += 1 # and count them + ver += 1 # and count them end } @@ -151,14 +151,14 @@ class DocumentHelper # get the correct file name if such a name already exists def get_correct_name(file_name, user_address) maxName = 50 - ext = File.extname(file_name) # get file extension + ext = File.extname(file_name) # get file extension # get file name without extension base_name = File.basename(file_name, ext)[0...maxName] + (file_name.length > maxName ? '[...]' : '') - name = base_name + ext.downcase # get full file name + name = base_name + ext.downcase # get full file name index = 1 - while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory - name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name + while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory + name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name index = index + 1 end @@ -172,12 +172,12 @@ class DocumentHelper arr = []; if Dir.exist?(directory) - Dir.foreach(directory) {|e| # run through all the elements from the folder + Dir.foreach(directory) {|e| # run through all the elements from the folder next if e.eql?(".") next if e.eql?("..") - next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it + next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it - arr.push(e) # push the file to the array + arr.push(e) # push the file to the array } end @@ -186,7 +186,7 @@ class DocumentHelper # create file meta information def create_meta(file_name, uid, uname, user_address) - hist_dir = history_dir(storage_path(file_name, user_address)) # get the path to the file history + hist_dir = history_dir(storage_path(file_name, user_address)) # get the path to the file history # write user name, user uid and the creation time to the json object json = { @@ -204,9 +204,9 @@ class DocumentHelper # create demo document def create_demo(file_ext, sample, user) demo_name = (sample == 'true' ? 'sample.' : 'new.') + file_ext - file_name = get_correct_name(demo_name, nil) # get the correct file name if such a name already exists + file_name = get_correct_name(demo_name, nil) # get the correct file name if such a name already exists - src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) # save sample document of a necessary extension to the storage directory + src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) # save sample document of a necessary extension to the storage directory dest = storage_path file_name, nil FileUtils.cp src, dest @@ -244,7 +244,7 @@ class DocumentHelper # get callback url def get_callback(file_name) - get_server_url(true) + '/track?fileName=' + ERB::Util.url_encode(file_name) + '&userAddress=' + cur_user_host_address(nil) + get_server_url(true) + '/track?fileName=' + ERB::Util.url_encode(file_name) + '&userAddress=' + cur_user_host_address(nil) end # get url to the created file @@ -255,7 +255,7 @@ class DocumentHelper # get url to download a file def get_download_url(file_name, is_serverUrl=true) user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" - get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host + get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host end # get internal file extension by its type @@ -265,10 +265,10 @@ class DocumentHelper ext = '.docx' when 'cell' # .xlsx for cell type ext = '.xlsx' - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type ext = '.pptx' else - ext = '.docx' # the default value is .docx + ext = '.docx' # the default value is .docx end ext @@ -282,10 +282,10 @@ class DocumentHelper full_path = path + 'file_docx.svg' when 'cell' # .xlsx for cell type full_path = path + 'file_xlsx.svg' - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type full_path = path + 'file_pptx.svg' else - full_path = path + 'file_docx.svg' # the default value is .docx + full_path = path + 'file_docx.svg' # the default value is .docx end full_path @@ -295,7 +295,7 @@ class DocumentHelper def get_files_info(file_id) result = []; - for fileName in get_stored_files(nil) # run through all the stored files from the folder + for fileName in get_stored_files(nil) # run through all the stored files from the folder directory = storage_path(fileName, nil) uri = cur_user_host_address(nil) + '/' + fileName @@ -309,11 +309,11 @@ class DocumentHelper "updated" => File.mtime(directory) } - if file_id == nil # if file id is undefined - result.push(info) # push info object to the response array - else # if file id is defined - if file_id.eql?(info["id"]) # and it is equal to the document key value - result.push(info) # response object will be equal to the info object + if file_id == nil # if file id is undefined + result.push(info) # push info object to the response array + else # if file id is defined + if file_id.eql?(info["id"]) # and it is equal to the document key value + result.push(info) # response object will be equal to the info object return result end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 15a7d355..8f2fb2c8 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -35,7 +35,7 @@ class FileModel end def type - @type ? @type : "desktop" # the default platform type is desktop + @type ? @type : "desktop" # the default platform type is desktop end # get file extension from its name @@ -60,8 +60,8 @@ class FileModel # generate the document key value def key - uri = DocumentHelper.cur_user_host_address(nil) + '/' + @file_name # get current user host address - stat = File.mtime(DocumentHelper.storage_path(@file_name, nil)) # get the modification time of the given file + uri = DocumentHelper.cur_user_host_address(nil) + '/' + @file_name # get current user host address + stat = File.mtime(DocumentHelper.storage_path(@file_name, nil)) # get the modification time of the given file return ServiceConverter.generate_revision_id("#{uri}.#{stat.to_s}") end @@ -87,13 +87,13 @@ class FileModel # get config parameters def get_config - editorsmode = @mode ? @mode : "edit" # mode: view/edit/review/comment/fillForms/embedded - canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited + editorsmode = @mode ? @mode : "edit" # mode: view/edit/review/comment/fillForms/embedded + canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited if (!canEdit && editorsmode.eql?("edit") || editorsmode.eql?("fillForms")) && DocumentHelper.fill_forms_exts.include?(file_ext) editorsmode = "fillForms" canEdit = true end - submitForm = editorsmode.eql?("fillForms") && @user.id.eql?("uid-1") && false # the Submit form button state + submitForm = editorsmode.eql?("fillForms") && @user.id.eql?("uid-1") && false # the Submit form button state mode = canEdit && !editorsmode.eql?("view") ? "edit" : "view" templatesImageUrl = DocumentHelper.get_template_image_url(document_type) # templates image url in the "From Template" section templates = [ @@ -123,11 +123,11 @@ class FileModel :uploaded => Time.now.to_s, :favorite => @user.favorite }, - :permissions => { # the permission for the document to be edited and downloaded or not + :permissions => { # the permission for the document to be edited and downloaded or not :comment => !editorsmode.eql?("view") && !editorsmode.eql?("fillForms") && !editorsmode.eql?("embedded") && !editorsmode.eql?("blockcontent"), :copy => !@user.deniedPermissions.include?("copy"), :download => !@user.deniedPermissions.include?("download"), - :edit => canEdit && (editorsmode.eql?("edit") || editorsmode.eql?("view") || editorsmode.eql?("filter") || editorsmode.eql?("blockcontent")), + :edit => canEdit && (editorsmode.eql?("edit") || editorsmode.eql?("view") || editorsmode.eql?("filter") || editorsmode.eql?("blockcontent")), :print => !@user.deniedPermissions.include?("print"), :fillForms => !editorsmode.eql?("view") && !editorsmode.eql?("comment") && !editorsmode.eql?("embedded") && !editorsmode.eql?("blockcontent"), :modifyFilter => !editorsmode.eql?("filter"), @@ -148,31 +148,31 @@ class FileModel :actionLink => @action_data ? JSON.parse(@action_data) : nil, :mode => mode, :lang => @lang ? @lang : "en", - :callbackUrl => callback_url, # absolute URL to the document storage service + :callbackUrl => callback_url, # absolute URL to the document storage service :coEditing => editorsmode.eql?("view") && @user.id.eql?("uid-0") ? { :mode => "strict", :change => false } : nil, :createUrl => !@user.id.eql?("uid-0") ? create_url : nil, :templates => @user.templates ? templates : nil, - :user => { # the user currently viewing or editing the document + :user => { # the user currently viewing or editing the document :id => !@user.id.eql?("uid-0") ? @user.id : nil, :name => @user.name, :group => @user.group, :image => @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil }, - :embedded => { # the parameters for the embedded document type - :saveUrl => download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer + :embedded => { # the parameters for the embedded document type + :saveUrl => download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer :embedUrl => download_url(false), # the absolute URL to the document serving as a source file for the document embedded into the web page :shareUrl => download_url(false), # the absolute URL that will allow other users to share this document - :toolbarDocked => "top" # the place for the embedded viewer toolbar (top or bottom) + :toolbarDocked => "top" # the place for the embedded viewer toolbar (top or bottom) }, - :customization => { # the parameters for the editor interface - :about => true, # the About section display + :customization => { # the parameters for the editor interface + :about => true, # the About section display :comments => true, - :feedback => true, # the Feedback & Support menu button display - :forcesave => false, # adding the request for the forced file saving to the callback handler - :submitForm => submitForm, # the Submit form button state + :feedback => true, # the Feedback & Support menu button display + :forcesave => false, # adding the request for the forced file saving to the callback handler + :submitForm => submitForm, # the Submit form button state :goback => { :url => DocumentHelper.get_server_url(false) }, @@ -180,8 +180,8 @@ class FileModel } } - if JwtHelper.is_enabled # check if a secret key to generate token exists or not - config["token"] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config + if JwtHelper.is_enabled # check if a secret key to generate token exists or not + config["token"] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config end return config @@ -194,17 +194,17 @@ class FileModel doc_key = key() doc_uri = file_uri() - hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history - cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version + hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history + cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version - if (cur_ver > 0) # if file was modified + if (cur_ver > 0) # if file was modified hist = [] histData = {} - for i in 1..cur_ver # run through all the file versions + for i in 1..cur_ver # run through all the file versions obj = {} dataObj = {} - ver_dir = DocumentHelper.version_dir(hist_dir, i) # get the path to the given file version + ver_dir = DocumentHelper.version_dir(hist_dir, i) # get the path to the given file version # get document key cur_key = doc_key @@ -216,10 +216,10 @@ class FileModel obj["key"] = cur_key obj["version"] = i - if (i == 1) # check if the version number is equal to 1 - if File.file?(File.join(hist_dir, "createdInfo.json")) # check if the createdInfo.json file with meta data exists - File.open(File.join(hist_dir, "createdInfo.json"), 'r') do |file| # open it - cr_info = JSON.parse(file.read()) # parse the file content + if (i == 1) # check if the version number is equal to 1 + if File.file?(File.join(hist_dir, "createdInfo.json")) # check if the createdInfo.json file with meta data exists + File.open(File.join(hist_dir, "createdInfo.json"), 'r') do |file| # open it + cr_info = JSON.parse(file.read()) # parse the file content # write information about changes to the object obj["created"] = cr_info["created"] @@ -240,11 +240,11 @@ class FileModel end dataObj["version"] = i - if (i > 1) # check if the version number is greater than 1 + if (i > 1) # check if the version number is greater than 1 changes = nil change = nil - File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), "changes.json"), 'r') do |file| # get the path to the changes.json file - changes = JSON.parse(file.read()) # and parse its content + File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), "changes.json"), 'r') do |file| # get the path to the changes.json file + changes = JSON.parse(file.read()) # and parse its content end change = changes["changes"][0] @@ -255,8 +255,8 @@ class FileModel obj["created"] = change ? change["created"] : nil obj["user"] = change ? change["user"] : nil - prev = histData[(i - 2).to_s] # get the history data from the previous file version - dataObj["previous"] = is_enable_direct_url == true ? { # write key and url information about previous file version with optional direct url + prev = histData[(i - 2).to_s] # get the history data from the previous file version + dataObj["previous"] = is_enable_direct_url == true ? { # write key and url information about previous file version with optional direct url :fileType => prev["fileType"], :key => prev["key"], :url => prev["url"], @@ -271,16 +271,16 @@ class FileModel dataObj["changesUrl"] = DocumentHelper.get_historypath_uri(file_name, i - 1, "diff.zip") end - if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataObj["token"] = JwtHelper.encode(dataObj) # encode a payload object into a token and write it to the data object + if JwtHelper.is_enabled # check if a secret key to generate token exists or not + dataObj["token"] = JwtHelper.encode(dataObj) # encode a payload object into a token and write it to the data object end - hist.push(obj) # add object dictionary to the hist list - histData[(i - 1).to_s] = dataObj # write data object information to the history data + hist.push(obj) # add object dictionary to the hist list + histData[(i - 1).to_s] = dataObj # write data object information to the history data end return { - :hist => { # write history information about the current file version to the hist + :hist => { # write history information about the current file version to the hist :currentVersion => cur_ver, :history => hist }, @@ -294,16 +294,16 @@ class FileModel # get image information def get_insert_image insert_image = is_enable_direct_url == true ? { - :fileType => "png", # image file type - :url => DocumentHelper.get_server_url(true) + "/assets/logo.png", # server url to the image - :directUrl => DocumentHelper.get_server_url(false) + "/assets/logo.png" # direct url to the image + :fileType => "png", # image file type + :url => DocumentHelper.get_server_url(true) + "/assets/logo.png", # server url to the image + :directUrl => DocumentHelper.get_server_url(false) + "/assets/logo.png" # direct url to the image } : { - :fileType => "png", # image file type - :url => DocumentHelper.get_server_url(true) + "/assets/logo.png" # server url to the image + :fileType => "png", # image file type + :url => DocumentHelper.get_server_url(true) + "/assets/logo.png" # server url to the image } - if JwtHelper.is_enabled # check if a secret key to generate token exists or not - insert_image["token"] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object + if JwtHelper.is_enabled # check if a secret key to generate token exists or not + insert_image["token"] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object end return insert_image.to_json.tr("{", "").tr("}","") @@ -312,16 +312,16 @@ class FileModel # get compared file information def dataDocument compare_file = is_enable_direct_url == true ? { - :fileType => "docx", # file type - :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx", # server url to the compared file - :directUrl => DocumentHelper.get_server_url(false) + "/asset?fileName=sample.docx" # direct url to the compared file + :fileType => "docx", # file type + :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx", # server url to the compared file + :directUrl => DocumentHelper.get_server_url(false) + "/asset?fileName=sample.docx" # direct url to the compared file } : { - :fileType => "docx", # file type - :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx" # server url to the compared file + :fileType => "docx", # file type + :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx" # server url to the compared file } - if JwtHelper.is_enabled # check if a secret key to generate token exists or not - compare_file["token"] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object + if JwtHelper.is_enabled # check if a secret key to generate token exists or not + compare_file["token"] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object end return compare_file @@ -330,16 +330,16 @@ class FileModel # get mail merge recipients information def dataSpreadsheet dataSpreadsheet = is_enable_direct_url == true ? { - :fileType => "csv", # file type - :url => DocumentHelper.get_server_url(true) + "/csv", # server url to the mail merge recipients file - :directUrl => DocumentHelper.get_server_url(false) + "/csv" # direct url to the mail merge recipients file + :fileType => "csv", # file type + :url => DocumentHelper.get_server_url(true) + "/csv", # server url to the mail merge recipients file + :directUrl => DocumentHelper.get_server_url(false) + "/csv" # direct url to the mail merge recipients file } : { - :fileType => "csv", # file type - :url => DocumentHelper.get_server_url(true) + "/csv" # server url to the mail merge recipients file + :fileType => "csv", # file type + :url => DocumentHelper.get_server_url(true) + "/csv" # server url to the mail merge recipients file } - if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataSpreadsheet["token"] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object + if JwtHelper.is_enabled # check if a secret key to generate token exists or not + dataSpreadsheet["token"] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object end return dataSpreadsheet diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index b7268f01..ebb70823 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -30,7 +30,7 @@ class ServiceConverter # get the url of the converted file def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) - from_ext = from_ext == nil ? File.extname(document_uri).downcase : from_ext # get the current document extension + from_ext = from_ext == nil ? File.extname(document_uri).downcase : from_ext # get the current document extension # get the current document name or uuid title = File.basename(URI.parse(document_uri).path) @@ -40,7 +40,7 @@ class ServiceConverter document_revision_id = document_revision_id.empty? ? document_uri : document_revision_id document_revision_id = generate_revision_id(document_revision_id) - payload = { # write all the conversion parameters to the payload + payload = { # write all the conversion parameters to the payload :async => is_async ? true : false, :url => document_uri, :outputtype => to_ext.delete('.'), @@ -54,52 +54,52 @@ class ServiceConverter data = nil begin - uri = URI.parse(@@document_converter_url) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(@@document_converter_url) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server DocumentHelper.verify_ssl(@@document_converter_url, http) http.read_timeout = @@convert_timeout http.open_timeout = 5 - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Accept", "application/json") # set headers + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field("Accept", "application/json") # set headers req.add_field("Content-Type", "application/json") - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix + if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix end req.body = payload.to_json - res = http.request(req) # get the response + res = http.request(req) # get the response status_code = res.code.to_i - if status_code != 200 # checking status code + if status_code != 200 # checking status code raise "Conversion service returned status: #{status_code}" end - data = res.body # and take its body + data = res.body # and take its body rescue Timeout::Error # try again rescue => ex raise ex.message end - json_data = JSON.parse(data) # parse response body - return get_response_data(json_data) # get response url + json_data = JSON.parse(data) # parse response body + return get_response_data(json_data) # get response url end # generate the document key value def generate_revision_id(expected_key) require 'zlib' - if expected_key.length > 20 # check if the expected key length is greater than 20 - expected_key = (Zlib.crc32 expected_key).to_s # calculate 32-bit crc value from the expected key and turn it into the string + if expected_key.length > 20 # check if the expected key length is greater than 20 + expected_key = (Zlib.crc32 expected_key).to_s # calculate 32-bit crc value from the expected key and turn it into the string end key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') - key[(key.length - [key.length, 20].min)..key.length] # the resulting key is of the length 20 or less + key[(key.length - [key.length, 20].min)..key.length] # the resulting key is of the length 20 or less end # create an error message for the error code @@ -127,7 +127,7 @@ class ServiceConverter when 0 # public const int c_nErrorNo = 0 else - error_message = 'ErrorCode = ' + error_code.to_s # default value for the error message + error_message = 'ErrorCode = ' + error_code.to_s # default value for the error message end raise error_message @@ -138,30 +138,30 @@ class ServiceConverter file_result = json_data error_element = file_result['error'] - if error_element != nil # if an error occurs - process_convert_service_responce_error(error_element.to_i) # get an error message + if error_element != nil # if an error occurs + process_convert_service_responce_error(error_element.to_i) # get an error message end - is_end_convert = file_result['endConvert'] # check if the conversion is completed + is_end_convert = file_result['endConvert'] # check if the conversion is completed - result_percent = 0 # the conversion percentage + result_percent = 0 # the conversion percentage response_uri = '' response_file_type = '' - if is_end_convert # if the conversion is completed + if is_end_convert # if the conversion is completed file_url_element = file_result['fileUrl'] file_type_element = file_result['fileType'] - if file_url_element == nil # and the file url doesn't exist + if file_url_element == nil # and the file url doesn't exist raise 'Invalid answer format' # get ann error message end response_uri = file_url_element # otherwise, get the file url - response_file_type = file_type_element # get the file type + response_file_type = file_type_element # get the file type result_percent = 100 - else # if the conversion isn't completed + else # if the conversion isn't completed percent_element = file_result['percent'] # get the percentage value diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index a3250eac..65b56b2c 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -40,22 +40,22 @@ class TrackHelper return "" end - file_data = JSON.parse(body) # parse file data + file_data = JSON.parse(body) # parse file data # check if a secret key to generate token exists or not if JwtHelper.is_enabled && JwtHelper.use_for_request inHeader = false token = nil - jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config - if file_data["token"] # if the token is in the body - token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key - elsif request.headers[jwtHeader] # if the token is in the header + jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config + if file_data["token"] # if the token is in the body + token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key + elsif request.headers[jwtHeader] # if the token is in the header hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) - token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key + hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) + token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key inHeader = true else - raise "Expected JWT" # token missing error message + raise "Expected JWT" # token missing error message end if !token || token.eql?("") @@ -108,9 +108,9 @@ class TrackHelper end new_file_name = file_name - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - cur_ext = File.extname(file_name).downcase # get current file extension + cur_ext = File.extname(file_name).downcase # get current file extension # convert downloaded file to the file with the current extension if these extensions aren't equal unless cur_ext.eql?(download_ext) @@ -135,16 +135,16 @@ class TrackHelper end begin - storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file + storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file - hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file - ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version + hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file + ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version - FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist + FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist - FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory + FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory - save_file(data, storage_path) # save the downloaded file to the storage directory + save_file(data, storage_path) # save the downloaded file to the storage directory change_data = download_file(file_data["changesurl"]) # download file with document versions differences save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences @@ -154,8 +154,8 @@ class TrackHelper hist_data = file_data["history"].to_json # write the original history information to the history data end if hist_data - File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes - file.write(hist_data) # and write history data to this file + File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes + file.write(hist_data) # and write history data to this file end end @@ -164,7 +164,7 @@ class TrackHelper file.write(file_data["key"]) end - forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file + forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file unless forcesave_path.eql?("") # if this path is empty File.delete(forcesave_path) # remove it end @@ -185,9 +185,9 @@ class TrackHelper return saved end - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - cur_ext = File.extname(file_name).downcase # get current file extension + cur_ext = File.extname(file_name).downcase # get current file extension new_file_name = false @@ -214,30 +214,30 @@ class TrackHelper end begin - is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) + is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) if is_submit_form if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists else file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) end - forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else if new_file_name file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?("") - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it end end - save_file(data, forcesave_path) # save the downloaded file to the storage directory + save_file(data, forcesave_path) # save the downloaded file to the storage directory if is_submit_form uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name + DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name end saved = 0 @@ -263,35 +263,35 @@ class TrackHelper data = nil begin - uri = URI.parse(@@document_command_url) # parse the document command url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(@@document_command_url) # parse the document command url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server DocumentHelper.verify_ssl(@@document_command_url, http) - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Content-Type", "application/json") # set headers + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field("Content-Type", "application/json") # set headers - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix + if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix end - req.body = payload.to_json # convert the payload object into the json format - res = http.request(req) # get the response - data = res.body # and take its body + req.body = payload.to_json # convert the payload object into the json format + res = http.request(req) # get the response + data = res.body # and take its body rescue => ex raise ex.message end - json_data = JSON.parse(data) # convert the response body into the json format + json_data = JSON.parse(data) # convert the response body into the json format return json_data end # save file from the url def download_file(uristr) - uri = URI.parse(uristr) # parse the url string - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(uristr) # parse the url string + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server http.open_timeout = 5 DocumentHelper.verify_ssl(uristr, http) @@ -304,7 +304,7 @@ class TrackHelper raise "Document editing service returned status: #{status_code}" end - data = res.body # and take its body + data = res.body # and take its body if data == nil raise 'stream is null' @@ -314,7 +314,7 @@ class TrackHelper end def save_file(data, path) - File.open(path, 'wb') do |file| # open the file from the path specified + File.open(path, 'wb') do |file| # open the file from the path specified file.write(data) # and write the response data to it end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index fe827482..00d43150 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -110,11 +110,11 @@ class Users ] class << self - def get_all_users() # get a list of all the users + def get_all_users() # get a list of all the users @@users end - def get_user(id) # get a user by id specified + def get_user(id) # get a user by id specified for user in @@users do if user.id.eql?(id) return user @@ -123,7 +123,7 @@ class Users return @@users[0] end - def get_users_for_mentions(id) # get a list of users with their names and emails for mentions + def get_users_for_mentions(id) # get a list of users with their names and emails for mentions usersData = [] for user in @@users do if (!user.id.eql?(id) && user.name != nil && user.email != nil) From 3b66092a45e81b2eaf5393e465a631fb87cc697a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:25:32 +0300 Subject: [PATCH 005/176] ruby: Layout/IndentationWidth correct --- .../ruby/app/controllers/home_controller.rb | 156 ++--- .../ruby/app/models/document_helper.rb | 2 +- .../ruby/app/models/jwt_helper.rb | 58 +- .../ruby/app/models/track_helper.rb | 552 +++++++++--------- .../ruby/app/models/users.rb | 238 ++++---- 5 files changed, 503 insertions(+), 503 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index f4218dbd..0d97d3f9 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -89,7 +89,7 @@ class HomeController < ApplicationController begin file_data = request.body.read if file_data == nil || file_data.empty? - return "" + return "" end body = JSON.parse(file_data) @@ -205,7 +205,7 @@ class HomeController < ApplicationController if file_data['actions'][0]['type'] == 0 # finished edit user = file_data['actions'][0]['userid'] # get the user id if !file_data['users'].index(user) - json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command + json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command end end end @@ -280,7 +280,7 @@ class HomeController < ApplicationController if JwtHelper.is_enabled && isEmbedded == nil && user_address != nil && JwtHelper.use_for_request jwtHeader = HomeController.config_manager.jwt_header; if request.headers[jwtHeader] - hdr = request.headers[jwtHeader] + hdr = request.headers[jwtHeader] hdr.slice!(0, "Bearer ".length) token = JwtHelper.decode(hdr) end @@ -350,95 +350,95 @@ class HomeController < ApplicationController end # Rename... - def rename - body = JSON.parse(request.body.read) - dockey = body["dockey"] - newfilename = body["newfilename"] + def rename + body = JSON.parse(request.body.read) + dockey = body["dockey"] + newfilename = body["newfilename"] - orig_ext = '.' + body["ext"] - cur_ext = File.extname(newfilename).downcase - if orig_ext != cur_ext - newfilename += orig_ext - end - - meta = { - :title => newfilename - } - - json_data = TrackHelper.command_request("meta", dockey, meta) - render plain: '{ "result" : "' + JSON.dump(json_data) + '"}' + orig_ext = '.' + body["ext"] + cur_ext = File.extname(newfilename).downcase + if orig_ext != cur_ext + newfilename += orig_ext end + meta = { + :title => newfilename + } + + json_data = TrackHelper.command_request("meta", dockey, meta) + render plain: '{ "result" : "' + JSON.dump(json_data) + '"}' + end + #ReferenceData - def reference - body = JSON.parse(request.body.read) - fileName = "" - + def reference + body = JSON.parse(request.body.read) + fileName = "" + - if body.key?("referenceData") - referenceData = body["referenceData"] - instanceId = referenceData["instanceId"] - if instanceId == DocumentHelper.get_server_url(false) - fileKey = JSON.parse(referenceData["fileKey"]) - userAddress = fileKey["userAddress"] - if userAddress == DocumentHelper.cur_user_host_address(nil) - fileName = fileKey["fileName"] - end + if body.key?("referenceData") + referenceData = body["referenceData"] + instanceId = referenceData["instanceId"] + if instanceId == DocumentHelper.get_server_url(false) + fileKey = JSON.parse(referenceData["fileKey"]) + userAddress = fileKey["userAddress"] + if userAddress == DocumentHelper.cur_user_host_address(nil) + fileName = fileKey["fileName"] end end + end - link = body["link"] - if fileName.empty? and body.key?("link") - if !link.include?(DocumentHelper.get_server_url(false)) - data = { - url: link, - directUrl: link - } - render plain: data.to_json - return - end - - url_obj = URI(link) - query_params = CGI.parse(url_obj.query) - fileName = query_params['fileName'].first - if !File.exist?(DocumentHelper.storage_path(fileName, nil)) - render plain: '{ "error": "File is not exist"}' - return - end - end - - if fileName.empty? and body.key?("path") - path = File.basename(body["path"]) - if File.exist?(DocumentHelper.storage_path(path, nil)) - fileName = path - end - end - - if fileName.empty? - render plain: '{ "error": "File not found"}' + link = body["link"] + if fileName.empty? and body.key?("link") + if !link.include?(DocumentHelper.get_server_url(false)) + data = { + url: link, + directUrl: link + } + render plain: data.to_json return end - data = { - :fileType => File.extname(fileName).downcase.delete("."), - :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil)).to_s}"), - :url => DocumentHelper.get_download_url(fileName), - :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, - :referenceData => { - :instanceId => DocumentHelper.get_server_url(false), - :fileKey => {:fileName => fileName,:userAddress => DocumentHelper.cur_user_host_address(nil)}.to_json - }, - :path => fileName, - :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName - } - - if JwtHelper.is_enabled - data["token"] = JwtHelper.encode(data) + url_obj = URI(link) + query_params = CGI.parse(url_obj.query) + fileName = query_params['fileName'].first + if !File.exist?(DocumentHelper.storage_path(fileName, nil)) + render plain: '{ "error": "File is not exist"}' + return end - - render plain: data.to_json end + if fileName.empty? and body.key?("path") + path = File.basename(body["path"]) + if File.exist?(DocumentHelper.storage_path(path, nil)) + fileName = path + end + end + + if fileName.empty? + render plain: '{ "error": "File not found"}' + return + end + + data = { + :fileType => File.extname(fileName).downcase.delete("."), + :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil)).to_s}"), + :url => DocumentHelper.get_download_url(fileName), + :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, + :referenceData => { + :instanceId => DocumentHelper.get_server_url(false), + :fileKey => {:fileName => fileName,:userAddress => DocumentHelper.cur_user_host_address(nil)}.to_json + }, + :path => fileName, + :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName + } + + if JwtHelper.is_enabled + data["token"] = JwtHelper.encode(data) + end + + render plain: data.to_json + end + def restore body = JSON.parse(request.body.read) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index ab6be3bd..78558091 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -158,7 +158,7 @@ class DocumentHelper index = 1 while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory - name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name + name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name index = index + 1 end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 4101c144..1e0b22f6 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -19,35 +19,35 @@ require_relative '../configuration/configuration' class JwtHelper - @jwt_secret = ConfigurationManager.new.jwt_secret - @token_use_for_request = ConfigurationManager.new.jwt_use_for_request + @jwt_secret = ConfigurationManager.new.jwt_secret + @token_use_for_request = ConfigurationManager.new.jwt_use_for_request - class << self - # check if a secret key to generate token exists or not - def is_enabled - return @jwt_secret && !@jwt_secret.empty? ? true : false - end - - # check if a secret key used for request - def use_for_request - return @token_use_for_request - end - - # encode a payload object into a token using a secret key - def encode(payload) - return JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token - end - - # decode a token into a payload object using a secret key - def decode(token) - begin - decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } - rescue - return "" - end - # decoded = Array [ {"data"=>"test"}, # payload - # {"alg"=>"HS256"} # header ] - return decoded[0].to_json # get json payload - end + class << self + # check if a secret key to generate token exists or not + def is_enabled + return @jwt_secret && !@jwt_secret.empty? ? true : false end + + # check if a secret key used for request + def use_for_request + return @token_use_for_request + end + + # encode a payload object into a token using a secret key + def encode(payload) + return JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token + end + + # decode a token into a payload object using a secret key + def decode(token) + begin + decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } + rescue + return "" + end + # decoded = Array [ {"data"=>"test"}, # payload + # {"alg"=>"HS256"} # header ] + return decoded[0].to_json # get json payload + end + end end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 65b56b2c..c7b0f45b 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -30,293 +30,293 @@ class TrackHelper @@document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s - class << self + class << self - # read the request body - def read_body(request) - body = request.body.read + # read the request body + def read_body(request) + body = request.body.read - if body == nil || body.empty? - return "" - end - - file_data = JSON.parse(body) # parse file data - - # check if a secret key to generate token exists or not - if JwtHelper.is_enabled && JwtHelper.use_for_request - inHeader = false - token = nil - jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config - if file_data["token"] # if the token is in the body - token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key - elsif request.headers[jwtHeader] # if the token is in the header - hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) - token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key - inHeader = true - else - raise "Expected JWT" # token missing error message - end - - if !token || token.eql?("") - raise "Invalid JWT signature" - end - - file_data = JSON.parse(token) - - if inHeader - file_data = file_data["payload"] - end - end - - return file_data + if body == nil || body.empty? + return "" end - def resolve_process_save_body(body) - copied = body.dup + file_data = JSON.parse(body) # parse file data - url = copied['url'] - if url - uri = URI(url) - resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) - copied['url'] = resolved_uri.to_s - end - - changesurl = copied['changesurl'] - if changesurl - uri = URI(changesurl) - resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) - copied['changesurl'] = resolved_uri.to_s - end - - home = copied['home'] - if home - copied['home'] = resolve_process_save_body(home) - end - - copied - end - - # file saving process - def process_save(raw_file_data, file_name, user_address) - file_data = resolve_process_save_body(raw_file_data) - - download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved + # check if a secret key to generate token exists or not + if JwtHelper.is_enabled && JwtHelper.use_for_request + inHeader = false + token = nil + jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config + if file_data["token"] # if the token is in the body + token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key + elsif request.headers[jwtHeader] # if the token is in the header + hdr = request.headers[jwtHeader] + hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) + token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key + inHeader = true + else + raise "Expected JWT" # token missing error message end - new_file_name = file_name - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - - cur_ext = File.extname(file_name).downcase # get current file extension - - # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists - else - download_uri = new_file_uri - end - rescue StandardError => msg - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end + if !token || token.eql?("") + raise "Invalid JWT signature" end - saved = 1 + file_data = JSON.parse(token) - data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end - - begin - storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file - - hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file - ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version - - FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist - - FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory - - save_file(data, storage_path) # save the downloaded file to the storage directory - - change_data = download_file(file_data["changesurl"]) # download file with document versions differences - save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences - - hist_data = file_data["changeshistory"] - unless hist_data # if there are no changes in the history - hist_data = file_data["history"].to_json # write the original history information to the history data - end - if hist_data - File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes - file.write(hist_data) # and write history data to this file - end - end - - # write the key value to the key.txt file - File.open(File.join(ver_dir, "key.txt"), 'wb') do |file| - file.write(file_data["key"]) - end - - forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file - unless forcesave_path.eql?("") # if this path is empty - File.delete(forcesave_path) # remove it - end - - saved = 0 - rescue StandardError => msg - saved = 1 - end - - saved - end - - # file force saving process - def process_force_save(file_data, file_name, user_address) - download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved - end - - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - - cur_ext = File.extname(file_name).downcase # get current file extension - - new_file_name = false - - # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? - new_file_name = true - else - download_uri = new_file_uri - end - rescue StandardError => msg - new_file_name = true - end - end - - saved = 1 - - data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end - - begin - is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) - - if is_submit_form - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists - else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) - end - forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file - else - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) - if forcesave_path.eql?("") - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it - end - end - - save_file(data, forcesave_path) # save the downloaded file to the storage directory - - if is_submit_form - uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name - end - - saved = 0 - rescue StandardError => msg - saved = 1 - end - - saved - end - - # send the command request - def command_request(method, key, meta = nil) - # create a payload object with the method and key - payload = { - :c => method, - :key => key - } - - if (meta != nil) - payload.merge!({:meta => meta}) - end - - data = nil - begin - - uri = URI.parse(@@document_command_url) # parse the document command url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - - DocumentHelper.verify_ssl(@@document_command_url, http) - - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Content-Type", "application/json") # set headers - - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix - end - - req.body = payload.to_json # convert the payload object into the json format - res = http.request(req) # get the response - data = res.body # and take its body - rescue => ex - raise ex.message - end - - json_data = JSON.parse(data) # convert the response body into the json format - return json_data - end - - # save file from the url - def download_file(uristr) - uri = URI.parse(uristr) # parse the url string - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - http.open_timeout = 5 - - DocumentHelper.verify_ssl(uristr, http) - - req = Net::HTTP::Get.new(uri) - res = http.request(req) # get the response - - status_code = res.code - if status_code != '200' # checking status code - raise "Document editing service returned status: #{status_code}" - end - - data = res.body # and take its body - - if data == nil - raise 'stream is null' - end - - data - end - - def save_file(data, path) - File.open(path, 'wb') do |file| # open the file from the path specified - file.write(data) # and write the response data to it + if inHeader + file_data = file_data["payload"] end end + + return file_data end + + def resolve_process_save_body(body) + copied = body.dup + + url = copied['url'] + if url + uri = URI(url) + resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) + copied['url'] = resolved_uri.to_s + end + + changesurl = copied['changesurl'] + if changesurl + uri = URI(changesurl) + resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) + copied['changesurl'] = resolved_uri.to_s + end + + home = copied['home'] + if home + copied['home'] = resolve_process_save_body(home) + end + + copied + end + + # file saving process + def process_save(raw_file_data, file_name, user_address) + file_data = resolve_process_save_body(raw_file_data) + + download_uri = file_data['url'] + if download_uri.eql?(nil) + saved = 1 + return saved + end + + new_file_name = file_name + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + + cur_ext = File.extname(file_name).downcase # get current file extension + + # convert downloaded file to the file with the current extension if these extensions aren't equal + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key + begin + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + if new_file_uri == nil || new_file_uri.empty? + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists + else + download_uri = new_file_uri + end + rescue StandardError => msg + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + if data.eql?(nil) + return saved + end + + begin + storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file + + hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file + ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version + + FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist + + FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory + + save_file(data, storage_path) # save the downloaded file to the storage directory + + change_data = download_file(file_data["changesurl"]) # download file with document versions differences + save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences + + hist_data = file_data["changeshistory"] + unless hist_data # if there are no changes in the history + hist_data = file_data["history"].to_json # write the original history information to the history data + end + if hist_data + File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes + file.write(hist_data) # and write history data to this file + end + end + + # write the key value to the key.txt file + File.open(File.join(ver_dir, "key.txt"), 'wb') do |file| + file.write(file_data["key"]) + end + + forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file + unless forcesave_path.eql?("") # if this path is empty + File.delete(forcesave_path) # remove it + end + + saved = 0 + rescue StandardError => msg + saved = 1 + end + + saved + end + + # file force saving process + def process_force_save(file_data, file_name, user_address) + download_uri = file_data['url'] + if download_uri.eql?(nil) + saved = 1 + return saved + end + + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + + cur_ext = File.extname(file_name).downcase # get current file extension + + new_file_name = false + + # convert downloaded file to the file with the current extension if these extensions aren't equal + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key + begin + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + if new_file_uri == nil || new_file_uri.empty? + new_file_name = true + else + download_uri = new_file_uri + end + rescue StandardError => msg + new_file_name = true + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + if data.eql?(nil) + return saved + end + + begin + is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) + + if is_submit_form + if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists + else + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) + end + forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + else + if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + end + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) + if forcesave_path.eql?("") + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it + end + end + + save_file(data, forcesave_path) # save the downloaded file to the storage directory + + if is_submit_form + uid = file_data['actions'][0]['userid'] + DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name + end + + saved = 0 + rescue StandardError => msg + saved = 1 + end + + saved + end + + # send the command request + def command_request(method, key, meta = nil) + # create a payload object with the method and key + payload = { + :c => method, + :key => key + } + + if (meta != nil) + payload.merge!({:meta => meta}) + end + + data = nil + begin + + uri = URI.parse(@@document_command_url) # parse the document command url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + + DocumentHelper.verify_ssl(@@document_command_url, http) + + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field("Content-Type", "application/json") # set headers + + if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix + end + + req.body = payload.to_json # convert the payload object into the json format + res = http.request(req) # get the response + data = res.body # and take its body + rescue => ex + raise ex.message + end + + json_data = JSON.parse(data) # convert the response body into the json format + return json_data + end + + # save file from the url + def download_file(uristr) + uri = URI.parse(uristr) # parse the url string + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + http.open_timeout = 5 + + DocumentHelper.verify_ssl(uristr, http) + + req = Net::HTTP::Get.new(uri) + res = http.request(req) # get the response + + status_code = res.code + if status_code != '200' # checking status code + raise "Document editing service returned status: #{status_code}" + end + + data = res.body # and take its body + + if data == nil + raise 'stream is null' + end + + data + end + + def save_file(data, path) + File.open(path, 'wb') do |file| # open the file from the path specified + file.write(data) # and write the response data to it + end + end + end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 00d43150..471b6b38 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -15,133 +15,133 @@ # class User - attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, - :deniedPermissions, :descriptions, :templates, :avatar + attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, + :deniedPermissions, :descriptions, :templates, :avatar - def initialize (id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, - deniedPermissions, descriptions, templates, avatar) - @id = id - @name = name - @email = email - @group = group - @reviewGroups = reviewGroups - @commentGroups = commentGroups - @favorite = favorite - @deniedPermissions = deniedPermissions - @descriptions = descriptions - @templates = templates - @userInfoGroups = userInfoGroups - @avatar = avatar - end + def initialize (id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, + deniedPermissions, descriptions, templates, avatar) + @id = id + @name = name + @email = email + @group = group + @reviewGroups = reviewGroups + @commentGroups = commentGroups + @favorite = favorite + @deniedPermissions = deniedPermissions + @descriptions = descriptions + @templates = templates + @userInfoGroups = userInfoGroups + @avatar = avatar + end end class Users - @@descr_user_1 = [ - "File author by default", - "Doesn’t belong to any group", - "Can review all the changes", - "Can perform all actions with comments", - "The file favorite state is undefined", - "Can create files from templates using data from the editor", - "Can see the information about all users", - "Has an avatar", - ]; + @@descr_user_1 = [ + "File author by default", + "Doesn’t belong to any group", + "Can review all the changes", + "Can perform all actions with comments", + "The file favorite state is undefined", + "Can create files from templates using data from the editor", + "Can see the information about all users", + "Has an avatar", + ]; - @@descr_user_2 = [ - "Belongs to Group2", - "Can review only his own changes or changes made by users with no group", - "Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only", - "This file is marked as favorite", - "Can create new files from the editor", - "Can see the information about users from Group2 and users who don’t belong to any group", - "Has an avatar", - ]; + @@descr_user_2 = [ + "Belongs to Group2", + "Can review only his own changes or changes made by users with no group", + "Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only", + "This file is marked as favorite", + "Can create new files from the editor", + "Can see the information about users from Group2 and users who don’t belong to any group", + "Has an avatar", + ]; - @@descr_user_3 = [ - "Belongs to Group3", - "Can review changes made by Group2 users", - "Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users", - "This file isn’t marked as favorite", - "Can’t copy data from the file to clipboard", - "Can’t download the file", - "Can’t print the file", - "Can create new files from the editor", - "Can see the information about Group2 users", - ]; + @@descr_user_3 = [ + "Belongs to Group3", + "Can review changes made by Group2 users", + "Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users", + "This file isn’t marked as favorite", + "Can’t copy data from the file to clipboard", + "Can’t download the file", + "Can’t print the file", + "Can create new files from the editor", + "Can see the information about Group2 users", + ]; - @@descr_user_0 = [ - "The name is requested when the editor is opened", - "Doesn’t belong to any group", - "Can review all the changes", - "Can perform all actions with comments", - "The file favorite state is undefined", - "Can't mention others in comments", - "Can't create new files from the editor", - "Can’t see anyone’s information", - "Can't rename files from the editor", - "Can't view chat", - "Can't protect file", - "View file without collaboration" - ]; + @@descr_user_0 = [ + "The name is requested when the editor is opened", + "Doesn’t belong to any group", + "Can review all the changes", + "Can perform all actions with comments", + "The file favorite state is undefined", + "Can't mention others in comments", + "Can't create new files from the editor", + "Can’t see anyone’s information", + "Can't rename files from the editor", + "Can't view chat", + "Can't protect file", + "View file without collaboration" + ]; - @@users = [ - User.new("uid-1", "John Smith", "smith@example.com", - "", nil, {}, nil, - nil, [], @@descr_user_1, true, true), - User.new("uid-2", "Mark Pottato", "pottato@example.com", - "group-2", ["group-2", ""], { - :view => "", - :edit => ["group-2", ""], - :remove => ["group-2"] - }, - ["group-2", ""], - true, [], @@descr_user_2, false, true), - User.new("uid-3", "Hamish Mitchell", nil, - "group-3", ["group-2"], { - :view => ["group-3", "group-2"], - :edit => ["group-2"], - :remove => [] - }, - ["group-2"], - false, ["copy", "download", "print"], @@descr_user_3, false, false), - User.new("uid-0", nil, nil, - "", nil, {}, [], - nil, ["protect"], @@descr_user_0, false, false) - ] - - class << self - def get_all_users() # get a list of all the users - @@users - end - - def get_user(id) # get a user by id specified - for user in @@users do - if user.id.eql?(id) - return user - end - end - return @@users[0] - end - - def get_users_for_mentions(id) # get a list of users with their names and emails for mentions - usersData = [] - for user in @@users do - if (!user.id.eql?(id) && user.name != nil && user.email != nil) - usersData.push({:name => user.name, :email => user.email}) - end - end - return usersData - end - - def get_users_for_protect(id) # get a list of users with their id, names and emails for protect - users_data = [] - for user in @@users do - if (!user.id.eql?(id) && user.name != nil) - users_data.push({id: user.id, name: user.name, email: user.email}) - end - end - return users_data - end + @@users = [ + User.new("uid-1", "John Smith", "smith@example.com", + "", nil, {}, nil, + nil, [], @@descr_user_1, true, true), + User.new("uid-2", "Mark Pottato", "pottato@example.com", + "group-2", ["group-2", ""], { + :view => "", + :edit => ["group-2", ""], + :remove => ["group-2"] + }, + ["group-2", ""], + true, [], @@descr_user_2, false, true), + User.new("uid-3", "Hamish Mitchell", nil, + "group-3", ["group-2"], { + :view => ["group-3", "group-2"], + :edit => ["group-2"], + :remove => [] + }, + ["group-2"], + false, ["copy", "download", "print"], @@descr_user_3, false, false), + User.new("uid-0", nil, nil, + "", nil, {}, [], + nil, ["protect"], @@descr_user_0, false, false) + ] + class << self + def get_all_users() # get a list of all the users + @@users end + + def get_user(id) # get a user by id specified + for user in @@users do + if user.id.eql?(id) + return user + end + end + return @@users[0] + end + + def get_users_for_mentions(id) # get a list of users with their names and emails for mentions + usersData = [] + for user in @@users do + if (!user.id.eql?(id) && user.name != nil && user.email != nil) + usersData.push({:name => user.name, :email => user.email}) + end + end + return usersData + end + + def get_users_for_protect(id) # get a list of users with their id, names and emails for protect + users_data = [] + for user in @@users do + if (!user.id.eql?(id) && user.name != nil) + users_data.push({id: user.id, name: user.name, email: user.email}) + end + end + return users_data + end + + end end From dbce9946e0903a2b8bddde5142a2dc052973833d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:29:46 +0300 Subject: [PATCH 006/176] ruby: Layout/TrailingWhitespace correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- .../ruby/app/models/document_helper.rb | 2 +- .../ruby/app/models/file_model.rb | 20 +++++++++---------- .../ruby/app/models/track_helper.rb | 4 ++-- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 0d97d3f9..28ad29bf 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -93,7 +93,7 @@ class HomeController < ApplicationController end body = JSON.parse(file_data) - + file_name = File.basename(body["filename"]) lang = cookies[:ulang] ? cookies[:ulang] : "en" file_pass = body["filePass"] ? body["filePass"] : nil @@ -373,7 +373,7 @@ class HomeController < ApplicationController def reference body = JSON.parse(request.body.read) fileName = "" - + if body.key?("referenceData") referenceData = body["referenceData"] diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 78558091..36ff1317 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -306,7 +306,7 @@ class DocumentHelper "contentLength" => "#{(File.size(directory)/ 1024.0).round(2)} KB", "pureContentLength" => File.size(directory), "title" => fileName, - "updated" => File.mtime(directory) + "updated" => File.mtime(directory) } if file_id == nil # if file id is undefined diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 8f2fb2c8..feb2e8e6 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -150,7 +150,7 @@ class FileModel :lang => @lang ? @lang : "en", :callbackUrl => callback_url, # absolute URL to the document storage service :coEditing => editorsmode.eql?("view") && @user.id.eql?("uid-0") ? { - :mode => "strict", + :mode => "strict", :change => false } : nil, :createUrl => !@user.id.eql?("uid-0") ? create_url : nil, @@ -169,7 +169,7 @@ class FileModel }, :customization => { # the parameters for the editor interface :about => true, # the About section display - :comments => true, + :comments => true, :feedback => true, # the Feedback & Support menu button display :forcesave => false, # adding the request for the forced file saving to the callback handler :submitForm => submitForm, # the Submit form button state @@ -323,7 +323,7 @@ class FileModel if JwtHelper.is_enabled # check if a secret key to generate token exists or not compare_file["token"] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object end - + return compare_file end @@ -358,14 +358,14 @@ class FileModel id: user_info.id, name: user_info.name, email: user_info.email, - group: user_info.group, - reviewGroups: user_info.reviewGroups, - commentGroups: user_info.commentGroups, - userInfoGroups: user_info.userInfoGroups, + group: user_info.group, + reviewGroups: user_info.reviewGroups, + commentGroups: user_info.commentGroups, + userInfoGroups: user_info.userInfoGroups, favorite: user_info.favorite, - deniedPermissions: user_info.deniedPermissions, - descriptions: user_info.descriptions, - templates: user_info.templates, + deniedPermissions: user_info.deniedPermissions, + descriptions: user_info.descriptions, + templates: user_info.templates, avatar: user_info.avatar } u["image"] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c7b0f45b..34c03eb3 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -178,7 +178,7 @@ class TrackHelper end # file force saving process - def process_force_save(file_data, file_name, user_address) + def process_force_save(file_data, file_name, user_address) download_uri = file_data['url'] if download_uri.eql?(nil) saved = 1 @@ -237,7 +237,7 @@ class TrackHelper if is_submit_form uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name + DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name end saved = 0 From f1a69218ae0cd93d6f911921766f8dfd01e3bd01 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:32:08 +0300 Subject: [PATCH 007/176] ruby: Layout/IndentationConsistency correct --- .../ruby/app/controllers/home_controller.rb | 10 +- .../ruby/app/models/document_helper.rb | 2 +- .../ruby/app/models/file_model.rb | 2 +- .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/track_helper.rb | 380 +++++++++--------- .../ruby/app/models/users.rb | 44 +- 6 files changed, 220 insertions(+), 220 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 28ad29bf..7124d017 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -204,9 +204,9 @@ class HomeController < ApplicationController if status == 1 # editing if file_data['actions'][0]['type'] == 0 # finished edit user = file_data['actions'][0]['userid'] # get the user id - if !file_data['users'].index(user) - json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command - end + if !file_data['users'].index(user) + json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command + end end end @@ -281,8 +281,8 @@ class HomeController < ApplicationController jwtHeader = HomeController.config_manager.jwt_header; if request.headers[jwtHeader] hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) - token = JwtHelper.decode(hdr) + hdr.slice!(0, "Bearer ".length) + token = JwtHelper.decode(hdr) end if !token || token.eql?("") render plain: "JWT validation failed", :status => 403 diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 36ff1317..6bdcd805 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -159,7 +159,7 @@ class DocumentHelper while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name - index = index + 1 + index = index + 1 end name diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index feb2e8e6..6f8620e2 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -371,7 +371,7 @@ class FileModel u["image"] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil users_info.push(u) end - return users_info + return users_info end end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 1e0b22f6..872251da 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -47,7 +47,7 @@ class JwtHelper end # decoded = Array [ {"data"=>"test"}, # payload # {"alg"=>"HS256"} # header ] - return decoded[0].to_json # get json payload + return decoded[0].to_json # get json payload end end end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 34c03eb3..0cec3d26 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -36,40 +36,40 @@ class TrackHelper def read_body(request) body = request.body.read - if body == nil || body.empty? - return "" - end + if body == nil || body.empty? + return "" + end - file_data = JSON.parse(body) # parse file data + file_data = JSON.parse(body) # parse file data # check if a secret key to generate token exists or not - if JwtHelper.is_enabled && JwtHelper.use_for_request - inHeader = false - token = nil - jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config - if file_data["token"] # if the token is in the body - token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key - elsif request.headers[jwtHeader] # if the token is in the header - hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) - token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key - inHeader = true - else - raise "Expected JWT" # token missing error message - end - - if !token || token.eql?("") - raise "Invalid JWT signature" - end - - file_data = JSON.parse(token) - - if inHeader - file_data = file_data["payload"] - end + if JwtHelper.is_enabled && JwtHelper.use_for_request + inHeader = false + token = nil + jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config + if file_data["token"] # if the token is in the body + token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key + elsif request.headers[jwtHeader] # if the token is in the header + hdr = request.headers[jwtHeader] + hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) + token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key + inHeader = true + else + raise "Expected JWT" # token missing error message end - return file_data + if !token || token.eql?("") + raise "Invalid JWT signature" + end + + file_data = JSON.parse(token) + + if inHeader + file_data = file_data["payload"] + end + end + + return file_data end def resolve_process_save_body(body) @@ -101,151 +101,151 @@ class TrackHelper def process_save(raw_file_data, file_name, user_address) file_data = resolve_process_save_body(raw_file_data) - download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved - end + download_uri = file_data['url'] + if download_uri.eql?(nil) + saved = 1 + return saved + end - new_file_name = file_name - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + new_file_name = file_name + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - cur_ext = File.extname(file_name).downcase # get current file extension + cur_ext = File.extname(file_name).downcase # get current file extension # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists - else - download_uri = new_file_uri - end - rescue StandardError => msg - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end - end - - saved = 1 - - data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end - + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file - - hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file - ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version - - FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist - - FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory - - save_file(data, storage_path) # save the downloaded file to the storage directory - - change_data = download_file(file_data["changesurl"]) # download file with document versions differences - save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences - - hist_data = file_data["changeshistory"] - unless hist_data # if there are no changes in the history - hist_data = file_data["history"].to_json # write the original history information to the history data + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + if new_file_uri == nil || new_file_uri.empty? + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists + else + download_uri = new_file_uri end - if hist_data - File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes - file.write(hist_data) # and write history data to this file - end - end - - # write the key value to the key.txt file - File.open(File.join(ver_dir, "key.txt"), 'wb') do |file| - file.write(file_data["key"]) - end - - forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file - unless forcesave_path.eql?("") # if this path is empty - File.delete(forcesave_path) # remove it - end - - saved = 0 rescue StandardError => msg - saved = 1 + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + if data.eql?(nil) + return saved + end + + begin + storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file + + hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file + ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version + + FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist + + FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory + + save_file(data, storage_path) # save the downloaded file to the storage directory + + change_data = download_file(file_data["changesurl"]) # download file with document versions differences + save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences + + hist_data = file_data["changeshistory"] + unless hist_data # if there are no changes in the history + hist_data = file_data["history"].to_json # write the original history information to the history data + end + if hist_data + File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes + file.write(hist_data) # and write history data to this file + end end - saved + # write the key value to the key.txt file + File.open(File.join(ver_dir, "key.txt"), 'wb') do |file| + file.write(file_data["key"]) + end + + forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file + unless forcesave_path.eql?("") # if this path is empty + File.delete(forcesave_path) # remove it + end + + saved = 0 + rescue StandardError => msg + saved = 1 + end + + saved end # file force saving process def process_force_save(file_data, file_name, user_address) download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved - end + if download_uri.eql?(nil) + saved = 1 + return saved + end - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + download_ext = "."+file_data['filetype'] # get the extension of the downloaded file - cur_ext = File.extname(file_name).downcase # get current file extension + cur_ext = File.extname(file_name).downcase # get current file extension - new_file_name = false + new_file_name = false # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? - new_file_name = true - else - download_uri = new_file_uri - end - rescue StandardError => msg - new_file_name = true - end - end - - saved = 1 - - data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end - + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) - - if is_submit_form - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists - else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) - end - forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + if new_file_uri == nil || new_file_uri.empty? + new_file_name = true else - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) - if forcesave_path.eql?("") - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it - end + download_uri = new_file_uri end - - save_file(data, forcesave_path) # save the downloaded file to the storage directory - - if is_submit_form - uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name - end - - saved = 0 rescue StandardError => msg - saved = 1 + new_file_name = true + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + if data.eql?(nil) + return saved + end + + begin + is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) + + if is_submit_form + if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists + else + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) + end + forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + else + if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + end + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) + if forcesave_path.eql?("") + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it + end end - saved + save_file(data, forcesave_path) # save the downloaded file to the storage directory + + if is_submit_form + uid = file_data['actions'][0]['userid'] + DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name + end + + saved = 0 + rescue StandardError => msg + saved = 1 + end + + saved end # send the command request @@ -256,61 +256,61 @@ class TrackHelper :key => key } - if (meta != nil) - payload.merge!({:meta => meta}) + if (meta != nil) + payload.merge!({:meta => meta}) + end + + data = nil + begin + + uri = URI.parse(@@document_command_url) # parse the document command url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + + DocumentHelper.verify_ssl(@@document_command_url, http) + + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field("Content-Type", "application/json") # set headers + + if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix end - data = nil - begin + req.body = payload.to_json # convert the payload object into the json format + res = http.request(req) # get the response + data = res.body # and take its body + rescue => ex + raise ex.message + end - uri = URI.parse(@@document_command_url) # parse the document command url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - - DocumentHelper.verify_ssl(@@document_command_url, http) - - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Content-Type", "application/json") # set headers - - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix - end - - req.body = payload.to_json # convert the payload object into the json format - res = http.request(req) # get the response - data = res.body # and take its body - rescue => ex - raise ex.message - end - - json_data = JSON.parse(data) # convert the response body into the json format - return json_data + json_data = JSON.parse(data) # convert the response body into the json format + return json_data end # save file from the url def download_file(uristr) uri = URI.parse(uristr) # parse the url string - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - http.open_timeout = 5 + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + http.open_timeout = 5 - DocumentHelper.verify_ssl(uristr, http) + DocumentHelper.verify_ssl(uristr, http) - req = Net::HTTP::Get.new(uri) - res = http.request(req) # get the response + req = Net::HTTP::Get.new(uri) + res = http.request(req) # get the response - status_code = res.code - if status_code != '200' # checking status code - raise "Document editing service returned status: #{status_code}" - end + status_code = res.code + if status_code != '200' # checking status code + raise "Document editing service returned status: #{status_code}" + end - data = res.body # and take its body + data = res.body # and take its body - if data == nil - raise 'stream is null' - end + if data == nil + raise 'stream is null' + end - data + data end def save_file(data, path) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 471b6b38..e1713601 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -21,17 +21,17 @@ class User def initialize (id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, deniedPermissions, descriptions, templates, avatar) @id = id - @name = name - @email = email - @group = group - @reviewGroups = reviewGroups - @commentGroups = commentGroups - @favorite = favorite - @deniedPermissions = deniedPermissions - @descriptions = descriptions - @templates = templates - @userInfoGroups = userInfoGroups - @avatar = avatar + @name = name + @email = email + @group = group + @reviewGroups = reviewGroups + @commentGroups = commentGroups + @favorite = favorite + @deniedPermissions = deniedPermissions + @descriptions = descriptions + @templates = templates + @userInfoGroups = userInfoGroups + @avatar = avatar end end @@ -120,27 +120,27 @@ class Users return user end end - return @@users[0] + return @@users[0] end def get_users_for_mentions(id) # get a list of users with their names and emails for mentions usersData = [] - for user in @@users do - if (!user.id.eql?(id) && user.name != nil && user.email != nil) - usersData.push({:name => user.name, :email => user.email}) - end + for user in @@users do + if (!user.id.eql?(id) && user.name != nil && user.email != nil) + usersData.push({:name => user.name, :email => user.email}) end - return usersData + end + return usersData end def get_users_for_protect(id) # get a list of users with their id, names and emails for protect users_data = [] - for user in @@users do - if (!user.id.eql?(id) && user.name != nil) - users_data.push({id: user.id, name: user.name, email: user.email}) - end + for user in @@users do + if (!user.id.eql?(id) && user.name != nil) + users_data.push({id: user.id, name: user.name, email: user.email}) end - return users_data + end + return users_data end end From b5585cf3db168c24ddcff4309fec42aba324006c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:33:31 +0300 Subject: [PATCH 008/176] ruby: Layout/LeadingCommentSpace correct --- .../ruby/app/controllers/home_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 7124d017..40a62cc7 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -369,7 +369,7 @@ class HomeController < ApplicationController render plain: '{ "result" : "' + JSON.dump(json_data) + '"}' end - #ReferenceData + # ReferenceData def reference body = JSON.parse(request.body.read) fileName = "" From f12fb576d83500fa3748b7b8b9db457db1585478 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:34:49 +0300 Subject: [PATCH 009/176] ruby: Layout/SpaceInsideHashLiteralBraces correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 40a62cc7..36796b8e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -426,7 +426,7 @@ class HomeController < ApplicationController :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), - :fileKey => {:fileName => fileName,:userAddress => DocumentHelper.cur_user_host_address(nil)}.to_json + :fileKey => { :fileName => fileName,:userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json }, :path => fileName, :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 6f8620e2..60410b15 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -141,7 +141,7 @@ class FileModel }, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), - :fileKey => !@user.id.eql?("uid-0") ? {:fileName => @file_name,:userAddress => DocumentHelper.cur_user_host_address(nil)}.to_json : nil + :fileKey => !@user.id.eql?("uid-0") ? { :fileName => @file_name,:userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil } }, :editorConfig => { diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 0cec3d26..dcaee067 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -257,7 +257,7 @@ class TrackHelper } if (meta != nil) - payload.merge!({:meta => meta}) + payload.merge!({ :meta => meta }) end data = nil diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index e1713601..8c170ca4 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -127,7 +127,7 @@ class Users usersData = [] for user in @@users do if (!user.id.eql?(id) && user.name != nil && user.email != nil) - usersData.push({:name => user.name, :email => user.email}) + usersData.push({ :name => user.name, :email => user.email }) end end return usersData @@ -137,7 +137,7 @@ class Users users_data = [] for user in @@users do if (!user.id.eql?(id) && user.name != nil) - users_data.push({id: user.id, name: user.name, email: user.email}) + users_data.push({ id: user.id, name: user.name, email: user.email }) end end return users_data From fde6a09f7522aafc4c63fa04fc095fa620d7ffc8 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:39:32 +0300 Subject: [PATCH 010/176] ruby: Layout/SpaceAfterComma correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- web/documentserver-example/ruby/app/models/file_model.rb | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 36796b8e..68868fde 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -426,7 +426,7 @@ class HomeController < ApplicationController :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), - :fileKey => { :fileName => fileName,:userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json + :fileKey => { :fileName => fileName, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json }, :path => fileName, :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 6bdcd805..5eac9872 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -93,7 +93,7 @@ class DocumentHelper return "" end - directory = File.join(directory,"#{File.basename(file_name)}-hist") # get the path to the history of the given file + directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file unless File.directory?(directory) if create FileUtils.mkdir_p(directory) # create history directory if it doesn't exist @@ -226,7 +226,7 @@ class DocumentHelper end # get history path url - def get_historypath_uri(file_name,version,file,is_serverUrl=true) + def get_historypath_uri(file_name, version, file, is_serverUrl=true) # for redirection to my link user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver='+ version.to_s + '&file='+ ERB::Util.url_encode(file) + user_host diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 60410b15..efccde50 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -141,7 +141,7 @@ class FileModel }, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), - :fileKey => !@user.id.eql?("uid-0") ? { :fileName => @file_name,:userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil + :fileKey => !@user.id.eql?("uid-0") ? { :fileName => @file_name, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil } }, :editorConfig => { @@ -306,7 +306,7 @@ class FileModel insert_image["token"] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object end - return insert_image.to_json.tr("{", "").tr("}","") + return insert_image.to_json.tr("{", "").tr("}", "") end # get compared file information From ac3e0faba86a0d8da02f9c0159d2b2006e34cc80 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:40:44 +0300 Subject: [PATCH 011/176] ruby: Layout/MultilineOperationIndentation correct --- web/documentserver-example/ruby/app/format/format.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/format/format.rb b/web/documentserver-example/ruby/app/format/format.rb index 0cca61d8..59bb56ea 100644 --- a/web/documentserver-example/ruby/app/format/format.rb +++ b/web/documentserver-example/ruby/app/format/format.rb @@ -76,7 +76,7 @@ class FormatManager def editable all.filter do |format| format.actions.include?('edit') || - format.actions.include?('lossy-edit') + format.actions.include?('lossy-edit') end end From 64f66d4fa3220dc248024218231f3f49392d40a2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:41:38 +0300 Subject: [PATCH 012/176] ruby: Layout/EmptyLinesAroundClassBody correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 -- web/documentserver-example/ruby/app/models/file_model.rb | 2 -- web/documentserver-example/ruby/app/models/jwt_helper.rb | 1 - .../ruby/app/models/service_converter.rb | 3 --- web/documentserver-example/ruby/app/models/track_helper.rb | 1 - web/documentserver-example/ruby/app/models/users.rb | 1 - 6 files changed, 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 5eac9872..294c7cd5 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -31,7 +31,6 @@ class DocumentHelper @@base_url = nil class << self - def init (ip, url) @@remote_ip = ip @@base_url = url @@ -333,5 +332,4 @@ class DocumentHelper end end end - end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index efccde50..a20ffc0f 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -17,7 +17,6 @@ require_relative '../configuration/configuration' class FileModel - attr_accessor :file_name, :mode, :type, :user_ip, :lang, :user, :action_data, :direct_url attr_reader :config_manager @@ -384,5 +383,4 @@ class FileModel def is_enable_direct_url return @direct_url != nil && @direct_url == "true" end - end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 872251da..779cb7aa 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -18,7 +18,6 @@ require 'jwt' require_relative '../configuration/configuration' class JwtHelper - @jwt_secret = ConfigurationManager.new.jwt_secret @token_use_for_request = ConfigurationManager.new.jwt_use_for_request diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index ebb70823..5f6e3caf 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -27,7 +27,6 @@ class ServiceConverter @@document_converter_url = ServiceConverter.config_manager.document_server_converter_uri.to_s class << self - # get the url of the converted file def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) from_ext = from_ext == nil ? File.extname(document_uri).downcase : from_ext # get the current document extension @@ -175,7 +174,5 @@ class ServiceConverter return result_percent, response_uri, response_file_type end - end - end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index dcaee067..90c1d988 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -31,7 +31,6 @@ class TrackHelper @@document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s class << self - # read the request body def read_body(request) body = request.body.read diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 8c170ca4..f2e2b4fd 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -142,6 +142,5 @@ class Users end return users_data end - end end From 276f5c1e2090f893d26fd61e99982b758bd96f3e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:42:27 +0300 Subject: [PATCH 013/176] ruby: Layout/SpaceAfterMethodName correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 294c7cd5..48fcdb9f 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -31,7 +31,7 @@ class DocumentHelper @@base_url = nil class << self - def init (ip, url) + def init(ip, url) @@remote_ip = ip @@base_url = url end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index f2e2b4fd..3d801aae 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -18,7 +18,7 @@ class User attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, :deniedPermissions, :descriptions, :templates, :avatar - def initialize (id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, + def initialize(id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, deniedPermissions, descriptions, templates, avatar) @id = id @name = name From 118779aac1e44ff7163df39eae620b0552110230 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:47:02 +0300 Subject: [PATCH 014/176] ruby: Layout/SpaceInsideBlockBraces correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 48fcdb9f..92d6ef41 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -135,7 +135,7 @@ class DocumentHelper end ver = 1 - Dir.foreach(hist_dir) {|e| # run through all the file versions + Dir.foreach(hist_dir) { |e| # run through all the file versions next if e.eql?(".") next if e.eql?("..") @@ -171,7 +171,7 @@ class DocumentHelper arr = []; if Dir.exist?(directory) - Dir.foreach(directory) {|e| # run through all the elements from the folder + Dir.foreach(directory) { |e| # run through all the elements from the folder next if e.eql?(".") next if e.eql?("..") next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it From c0eb1c8a859543a4bd7b7da8aca8270374e13b32 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:48:06 +0300 Subject: [PATCH 015/176] ruby: Layout/SpaceAroundEqualsInParameterDefault correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 92d6ef41..9da15f2d 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -225,7 +225,7 @@ class DocumentHelper end # get history path url - def get_historypath_uri(file_name, version, file, is_serverUrl=true) + def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver='+ version.to_s + '&file='+ ERB::Util.url_encode(file) + user_host @@ -252,7 +252,7 @@ class DocumentHelper end # get url to download a file - def get_download_url(file_name, is_serverUrl=true) + def get_download_url(file_name, is_serverUrl = true) user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index a20ffc0f..407c34be 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -75,7 +75,7 @@ class FileModel end # get url to download a file - def download_url(is_serverUrl=true) + def download_url(is_serverUrl = true) DocumentHelper.get_download_url(@file_name, is_serverUrl) end From b48efac604d5cd66a7e904cf27a7c534c32a4be6 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:48:40 +0300 Subject: [PATCH 016/176] ruby: Layout/SpaceAroundOperators correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- web/documentserver-example/ruby/app/models/track_helper.rb | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 9da15f2d..d708dacb 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -228,7 +228,7 @@ class DocumentHelper def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" - uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver='+ version.to_s + '&file='+ ERB::Util.url_encode(file) + user_host + uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver=' + version.to_s + '&file=' + ERB::Util.url_encode(file) + user_host return uri end @@ -302,7 +302,7 @@ class DocumentHelper info = { "version" => get_file_version(history_dir(directory)), "id" => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory).to_s}"), - "contentLength" => "#{(File.size(directory)/ 1024.0).round(2)} KB", + "contentLength" => "#{(File.size(directory) / 1024.0).round(2)} KB", "pureContentLength" => File.size(directory), "title" => fileName, "updated" => File.mtime(directory) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 90c1d988..31c6627a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -107,7 +107,7 @@ class TrackHelper end new_file_name = file_name - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + download_ext = "." + file_data['filetype'] # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension @@ -184,7 +184,7 @@ class TrackHelper return saved end - download_ext = "."+file_data['filetype'] # get the extension of the downloaded file + download_ext = "." + file_data['filetype'] # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension From 95de0fc2c7d15f81b23a14d0858688102f5b5fc7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:50:09 +0300 Subject: [PATCH 017/176] ruby: Layout/CaseIndentation correct --- .../ruby/app/models/document_helper.rb | 12 ++++++------ .../ruby/app/models/service_converter.rb | 18 +++++++++--------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index d708dacb..dc2abb91 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -260,11 +260,11 @@ class DocumentHelper # get internal file extension by its type def get_internal_extension(file_type) case file_type - when 'word' # .docx for word type + when 'word' # .docx for word type ext = '.docx' - when 'cell' # .xlsx for cell type + when 'cell' # .xlsx for cell type ext = '.xlsx' - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type ext = '.pptx' else ext = '.docx' # the default value is .docx @@ -277,11 +277,11 @@ class DocumentHelper def get_template_image_url(file_type) path = get_server_url(true) + "/assets/" case file_type - when 'word' # for word type + when 'word' # for word type full_path = path + 'file_docx.svg' - when 'cell' # .xlsx for cell type + when 'cell' # .xlsx for cell type full_path = path + 'file_xlsx.svg' - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type full_path = path + 'file_pptx.svg' else full_path = path + 'file_docx.svg' # the default value is .docx diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 5f6e3caf..cbf966bd 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -107,23 +107,23 @@ class ServiceConverter # add an error message to the error message template depending on the error code case error_code - when -8 + when -8 error_message = 'Error occurred in the ConvertService.ashx: Error document VKey' - when -7 + when -7 error_message = 'Error occurred in the ConvertService.ashx: Error document request' - when -6 + when -6 error_message = 'Error occurred in the ConvertService.ashx: Error database' - when -5 + when -5 error_message = 'Error occurred in the ConvertService.ashx: Incorrect password' - when -4 + when -4 error_message = 'Error occurred in the ConvertService.ashx: Error download error' - when -3 + when -3 error_message = 'Error occurred in the ConvertService.ashx: Error convertation error' - when -2 + when -2 error_message = 'Error occurred in the ConvertService.ashx: Error convertation timeout' - when -1 + when -1 error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' - when 0 + when 0 # public const int c_nErrorNo = 0 else error_message = 'ErrorCode = ' + error_code.to_s # default value for the error message From 831e59b3901aa73d5a22b3d738aef43773249a3e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:50:53 +0300 Subject: [PATCH 018/176] ruby: Layout/EmptyLineBetweenDefs correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index dc2abb91..8fc44dd8 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -324,6 +324,7 @@ class DocumentHelper return result end end + # enable ignore certificate def verify_ssl(file_uri, http) if file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled From 8ddbb6ba18e32834271b530c82acdaf3ad81e454 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:51:36 +0300 Subject: [PATCH 019/176] ruby: Layout/EmptyLinesAroundBeginBody correct --- web/documentserver-example/ruby/app/models/service_converter.rb | 1 - web/documentserver-example/ruby/app/models/track_helper.rb | 1 - 2 files changed, 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index cbf966bd..aee29c3c 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -52,7 +52,6 @@ class ServiceConverter data = nil begin - uri = URI.parse(@@document_converter_url) # create the request url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 31c6627a..8f652c0a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -261,7 +261,6 @@ class TrackHelper data = nil begin - uri = URI.parse(@@document_command_url) # parse the document command url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server From d8b0bd55cfff3171f6415c5e06cd9ba423432cb6 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:52:07 +0300 Subject: [PATCH 020/176] ruby: Layout/FirstHashElementIndentation correct --- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 8f652c0a..1abf4d72 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -251,7 +251,7 @@ class TrackHelper def command_request(method, key, meta = nil) # create a payload object with the method and key payload = { - :c => method, + :c => method, :key => key } diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 3d801aae..c4c003d8 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -90,7 +90,7 @@ class Users nil, [], @@descr_user_1, true, true), User.new("uid-2", "Mark Pottato", "pottato@example.com", "group-2", ["group-2", ""], { - :view => "", + :view => "", :edit => ["group-2", ""], :remove => ["group-2"] }, @@ -98,7 +98,7 @@ class Users true, [], @@descr_user_2, false, true), User.new("uid-3", "Hamish Mitchell", nil, "group-3", ["group-2"], { - :view => ["group-3", "group-2"], + :view => ["group-3", "group-2"], :edit => ["group-2"], :remove => [] }, From dcf78b13f2f63df863038e65fb1aab2fd49611c1 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:52:39 +0300 Subject: [PATCH 021/176] ruby: Layout/ArgumentAlignment correct --- .../ruby/app/models/users.rb | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index c4c003d8..84e3d3f2 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -16,7 +16,7 @@ class User attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, - :deniedPermissions, :descriptions, :templates, :avatar + :deniedPermissions, :descriptions, :templates, :avatar def initialize(id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, deniedPermissions, descriptions, templates, avatar) @@ -86,27 +86,27 @@ class Users @@users = [ User.new("uid-1", "John Smith", "smith@example.com", - "", nil, {}, nil, - nil, [], @@descr_user_1, true, true), + "", nil, {}, nil, + nil, [], @@descr_user_1, true, true), User.new("uid-2", "Mark Pottato", "pottato@example.com", - "group-2", ["group-2", ""], { + "group-2", ["group-2", ""], { :view => "", :edit => ["group-2", ""], :remove => ["group-2"] }, ["group-2", ""], - true, [], @@descr_user_2, false, true), + true, [], @@descr_user_2, false, true), User.new("uid-3", "Hamish Mitchell", nil, - "group-3", ["group-2"], { + "group-3", ["group-2"], { :view => ["group-3", "group-2"], :edit => ["group-2"], :remove => [] }, ["group-2"], - false, ["copy", "download", "print"], @@descr_user_3, false, false), + false, ["copy", "download", "print"], @@descr_user_3, false, false), User.new("uid-0", nil, nil, - "", nil, {}, [], - nil, ["protect"], @@descr_user_0, false, false) + "", nil, {}, [], + nil, ["protect"], @@descr_user_0, false, false) ] class << self From b6e71e42c1fbaeef7251872640c2dd08bc5db249 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:53:08 +0300 Subject: [PATCH 022/176] ruby: Layout/ParameterAlignment correct --- web/documentserver-example/ruby/app/models/users.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 84e3d3f2..01a9b27b 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -19,7 +19,7 @@ class User :deniedPermissions, :descriptions, :templates, :avatar def initialize(id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, - deniedPermissions, descriptions, templates, avatar) + deniedPermissions, descriptions, templates, avatar) @id = id @name = name @email = email From 2d3fc7228300ef823939b07028723909d9b201cc Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 13:53:42 +0300 Subject: [PATCH 023/176] ruby: Layout/FirstArrayElementIndentation correct --- .../ruby/app/models/users.rb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 01a9b27b..a7c367ba 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -37,7 +37,7 @@ end class Users @@descr_user_1 = [ - "File author by default", + "File author by default", "Doesn’t belong to any group", "Can review all the changes", "Can perform all actions with comments", @@ -48,7 +48,7 @@ class Users ]; @@descr_user_2 = [ - "Belongs to Group2", + "Belongs to Group2", "Can review only his own changes or changes made by users with no group", "Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only", "This file is marked as favorite", @@ -58,7 +58,7 @@ class Users ]; @@descr_user_3 = [ - "Belongs to Group3", + "Belongs to Group3", "Can review changes made by Group2 users", "Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users", "This file isn’t marked as favorite", @@ -70,7 +70,7 @@ class Users ]; @@descr_user_0 = [ - "The name is requested when the editor is opened", + "The name is requested when the editor is opened", "Doesn’t belong to any group", "Can review all the changes", "Can perform all actions with comments", @@ -85,9 +85,9 @@ class Users ]; @@users = [ - User.new("uid-1", "John Smith", "smith@example.com", - "", nil, {}, nil, - nil, [], @@descr_user_1, true, true), + User.new("uid-1", "John Smith", "smith@example.com", + "", nil, {}, nil, + nil, [], @@descr_user_1, true, true), User.new("uid-2", "Mark Pottato", "pottato@example.com", "group-2", ["group-2", ""], { :view => "", From 63c04c85b0608294a835c938828ed41c749495cd Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:01:39 +0300 Subject: [PATCH 024/176] ruby: Lint/ParenthesesAsGroupedExpression correct --- .../ruby/app/controllers/home_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 68868fde..86bc277e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -101,7 +101,7 @@ class HomeController < ApplicationController extension = File.extname(file_name).downcase internal_extension = 'ooxml' - if DocumentHelper.convert_exts.include? (extension) # check if the file with such an extension can be converted + if DocumentHelper.convert_exts.include?(extension) # check if the file with such an extension can be converted key = ServiceConverter.generate_revision_id(file_uri) # generate document key percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(file_uri, extension.delete('.'), internal_extension.delete('.'), key, true, file_pass, lang) # get the url and file type of the converted file and the conversion percentage From de32be3945590b7d12fc2ebccae68caac9dee74a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:30:45 +0300 Subject: [PATCH 025/176] ruby: Lint/RedundantStringCoercion correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 86bc277e..4c8f38f6 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -421,7 +421,7 @@ class HomeController < ApplicationController data = { :fileType => File.extname(fileName).downcase.delete("."), - :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil)).to_s}"), + :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), :url => DocumentHelper.get_download_url(fileName), :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, :referenceData => { diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 8fc44dd8..7c45357e 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -301,7 +301,7 @@ class DocumentHelper # write file parameters to the info object info = { "version" => get_file_version(history_dir(directory)), - "id" => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory).to_s}"), + "id" => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), "contentLength" => "#{(File.size(directory) / 1024.0).round(2)} KB", "pureContentLength" => File.size(directory), "title" => fileName, diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 407c34be..e2c4ec5d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -61,7 +61,7 @@ class FileModel def key uri = DocumentHelper.cur_user_host_address(nil) + '/' + @file_name # get current user host address stat = File.mtime(DocumentHelper.storage_path(@file_name, nil)) # get the modification time of the given file - return ServiceConverter.generate_revision_id("#{uri}.#{stat.to_s}") + return ServiceConverter.generate_revision_id("#{uri}.#{stat}") end # get callback url From 5e29215a11d02d6e7ebf66e937b7a6402e4e7954 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:38:10 +0300 Subject: [PATCH 026/176] ruby: Style/StringLiterals correct --- web/documentserver-example/ruby/Gemfile | 46 ++--- .../ruby/app/controllers/home_controller.rb | 72 ++++---- .../ruby/app/models/document_helper.rb | 38 ++-- .../ruby/app/models/file_model.rb | 174 +++++++++--------- .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/service_converter.rb | 6 +- .../ruby/app/models/track_helper.rb | 50 ++--- .../ruby/app/models/users.rb | 96 +++++----- 8 files changed, 242 insertions(+), 242 deletions(-) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index f826fb4c..43adf6cd 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -1,25 +1,25 @@ -source "https://rubygems.org" +source 'https://rubygems.org' -gem "byebug", "~> 11.1", :groups => [:development, :test] -gem "coffee-rails", "~> 5.0" -gem "dalli", "~> 3.2", :group => :development -gem "jbuilder", "~> 2.11" -gem "jquery-rails", "~> 4.5" -gem "jwt", "~> 2.7" -gem "mimemagic", github: "mimemagicrb/mimemagic", ref: "01f92d86d15d85cfd0f20dabd025dcbd36a8a60f" -gem "rack-cors", "~> 2.0" -gem "rails", "~> 7.0.8" -gem "rubocop", "~> 1.52", :group => :development -gem "sass-rails", "~> 6.0" -gem "sdoc", "~> 2.6", :group => :doc -gem "sorbet-runtime", "~> 0.5.10871" -gem "test-unit", "~> 3.6", :groups => [:development, :test] -gem "turbolinks", "~> 5.2" -gem "tzinfo-data", "~> 1.2023" -gem "uglifier", "~> 4.2" -gem "uuid", "~> 2.3" -gem "web-console", "~> 4.2", :groups => [:development, :test] -gem "webrick", "~> 1.8" +gem 'byebug', '~> 11.1', :groups => [:development, :test] +gem 'coffee-rails', '~> 5.0' +gem 'dalli', '~> 3.2', :group => :development +gem 'jbuilder', '~> 2.11' +gem 'jquery-rails', '~> 4.5' +gem 'jwt', '~> 2.7' +gem 'mimemagic', github: 'mimemagicrb/mimemagic', ref: '01f92d86d15d85cfd0f20dabd025dcbd36a8a60f' +gem 'rack-cors', '~> 2.0' +gem 'rails', '~> 7.0.8' +gem 'rubocop', '~> 1.52', :group => :development +gem 'sass-rails', '~> 6.0' +gem 'sdoc', '~> 2.6', :group => :doc +gem 'sorbet-runtime', '~> 0.5.10871' +gem 'test-unit', '~> 3.6', :groups => [:development, :test] +gem 'turbolinks', '~> 5.2' +gem 'tzinfo-data', '~> 1.2023' +gem 'uglifier', '~> 4.2' +gem 'uuid', '~> 2.3' +gem 'web-console', '~> 4.2', :groups => [:development, :test] +gem 'webrick', '~> 1.8' # Unfortunately, Sorbet only supports Darwin and Linux-based systems. # Additionally, it doesn't support Linux on ARM64, which may be used in a Docker @@ -28,6 +28,6 @@ gem "webrick", "~> 1.8" # https://github.com/sorbet/sorbet/issues/4011 # https://github.com/sorbet/sorbet/issues/4119 install_if -> { RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /x86_64/ } do - gem "sorbet", "~> 0.5.10871", :group => :development - gem "tapioca", "~> 0.11.6", :group => :development + gem 'sorbet', '~> 0.5.10871', :group => :development + gem 'tapioca', '~> 0.11.6', :group => :development end diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 4c8f38f6..b968b45b 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -89,14 +89,14 @@ class HomeController < ApplicationController begin file_data = request.body.read if file_data == nil || file_data.empty? - return "" + return '' end body = JSON.parse(file_data) - file_name = File.basename(body["filename"]) - lang = cookies[:ulang] ? cookies[:ulang] : "en" - file_pass = body["filePass"] ? body["filePass"] : nil + file_name = File.basename(body['filename']) + lang = cookies[:ulang] ? cookies[:ulang] : 'en' + file_pass = body['filePass'] ? body['filePass'] : nil file_uri = DocumentHelper.get_download_url(file_name) extension = File.extname(file_name).downcase internal_extension = 'ooxml' @@ -112,7 +112,7 @@ class HomeController < ApplicationController end # get the correct file name if such a name already exists - correct_name = DocumentHelper.get_correct_name(File.basename(file_name, extension) + "." + new_file_type, nil) + correct_name = DocumentHelper.get_correct_name(File.basename(file_name, extension) + '.' + new_file_type, nil) uri = URI.parse(new_file_uri) # create the request url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server @@ -162,18 +162,18 @@ class HomeController < ApplicationController jwtHeader = HomeController.config_manager.jwt_header; if request.headers[jwtHeader] hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) + hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) - if !token || token.eql?("") - render plain: "JWT validation failed", :status => 403 + if !token || token.eql?('') + render plain: 'JWT validation failed', :status => 403 return end else - render plain: "JWT validation failed", :status => 403 + render plain: 'JWT validation failed', :status => 403 return end end - hist_path = DocumentHelper.storage_path(file_name, user_address) + "-hist" # or to the original document + hist_path = DocumentHelper.storage_path(file_name, user_address) + '-hist' # or to the original document file_path = File.join(hist_path, version, file) @@ -205,7 +205,7 @@ class HomeController < ApplicationController if file_data['actions'][0]['type'] == 0 # finished edit user = file_data['actions'][0]['userid'] # get the user id if !file_data['users'].index(user) - json_data = TrackHelper.command_request("forcesave", file_data['key']) # call the forcesave command + json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end end end @@ -259,7 +259,7 @@ class HomeController < ApplicationController # downloading a csv file def csv - file_name = "csv.csv" + file_name = 'csv.csv' csvPath = Rails.root.join('assets', 'document-templates', 'sample', file_name) # add headers to the response to specify the page parameters @@ -281,17 +281,17 @@ class HomeController < ApplicationController jwtHeader = HomeController.config_manager.jwt_header; if request.headers[jwtHeader] hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) + hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) end - if !token || token.eql?("") - render plain: "JWT validation failed", :status => 403 + if !token || token.eql?('') + render plain: 'JWT validation failed', :status => 403 return end end file_path = DocumentHelper.forcesave_path(file_name, user_address, false) # get the path to the force saved document version - if file_path.eql?("") + if file_path.eql?('') file_path = DocumentHelper.storage_path(file_name, user_address) # or to the original document end @@ -310,8 +310,8 @@ class HomeController < ApplicationController def saveas begin body = JSON.parse(request.body.read) - file_url = body["url"] - title = body["title"] + file_url = body['url'] + title = body['title'] file_name = DocumentHelper.get_correct_name(title, nil) extension = File.extname(file_name).downcase all_exts = DocumentHelper.convert_exts + DocumentHelper.edited_exts + DocumentHelper.viewed_exts + DocumentHelper.fill_forms_exts @@ -352,10 +352,10 @@ class HomeController < ApplicationController # Rename... def rename body = JSON.parse(request.body.read) - dockey = body["dockey"] - newfilename = body["newfilename"] + dockey = body['dockey'] + newfilename = body['newfilename'] - orig_ext = '.' + body["ext"] + orig_ext = '.' + body['ext'] cur_ext = File.extname(newfilename).downcase if orig_ext != cur_ext newfilename += orig_ext @@ -365,30 +365,30 @@ class HomeController < ApplicationController :title => newfilename } - json_data = TrackHelper.command_request("meta", dockey, meta) + json_data = TrackHelper.command_request('meta', dockey, meta) render plain: '{ "result" : "' + JSON.dump(json_data) + '"}' end # ReferenceData def reference body = JSON.parse(request.body.read) - fileName = "" + fileName = '' - if body.key?("referenceData") - referenceData = body["referenceData"] - instanceId = referenceData["instanceId"] + if body.key?('referenceData') + referenceData = body['referenceData'] + instanceId = referenceData['instanceId'] if instanceId == DocumentHelper.get_server_url(false) - fileKey = JSON.parse(referenceData["fileKey"]) - userAddress = fileKey["userAddress"] + fileKey = JSON.parse(referenceData['fileKey']) + userAddress = fileKey['userAddress'] if userAddress == DocumentHelper.cur_user_host_address(nil) - fileName = fileKey["fileName"] + fileName = fileKey['fileName'] end end end - link = body["link"] - if fileName.empty? and body.key?("link") + link = body['link'] + if fileName.empty? and body.key?('link') if !link.include?(DocumentHelper.get_server_url(false)) data = { url: link, @@ -407,8 +407,8 @@ class HomeController < ApplicationController end end - if fileName.empty? and body.key?("path") - path = File.basename(body["path"]) + if fileName.empty? and body.key?('path') + path = File.basename(body['path']) if File.exist?(DocumentHelper.storage_path(path, nil)) fileName = path end @@ -420,10 +420,10 @@ class HomeController < ApplicationController end data = { - :fileType => File.extname(fileName).downcase.delete("."), + :fileType => File.extname(fileName).downcase.delete('.'), :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), :url => DocumentHelper.get_download_url(fileName), - :directUrl => body["directUrl"] ? DocumentHelper.get_download_url(fileName, false) : nil, + :directUrl => body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), :fileKey => { :fileName => fileName, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json @@ -433,7 +433,7 @@ class HomeController < ApplicationController } if JwtHelper.is_enabled - data["token"] = JwtHelper.encode(data) + data['token'] = JwtHelper.encode(data) end render plain: data.to_json diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 7c45357e..445deddd 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -89,7 +89,7 @@ class DocumentHelper # the directory with host address doesn't exist unless File.directory?(directory) - return "" + return '' end directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file @@ -97,14 +97,14 @@ class DocumentHelper if create FileUtils.mkdir_p(directory) # create history directory if it doesn't exist else - return "" # the history directory doesn't exist and we are not supposed to create it + return '' # the history directory doesn't exist and we are not supposed to create it end end directory = File.join(directory, File.basename(file_name)) # get the path to the given file unless File.file?(directory) if !create - return "" + return '' end end @@ -136,8 +136,8 @@ class DocumentHelper ver = 1 Dir.foreach(hist_dir) { |e| # run through all the file versions - next if e.eql?(".") - next if e.eql?("..") + next if e.eql?('.') + next if e.eql?('..') if File.directory?(File.join(hist_dir, e)) ver += 1 # and count them @@ -172,8 +172,8 @@ class DocumentHelper if Dir.exist?(directory) Dir.foreach(directory) { |e| # run through all the elements from the folder - next if e.eql?(".") - next if e.eql?("..") + next if e.eql?('.') + next if e.eql?('..') next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it arr.push(e) # push the file to the array @@ -195,7 +195,7 @@ class DocumentHelper } # write file meta information to the createdInfo.json file - File.open(File.join(hist_dir, "createdInfo.json"), 'wb') do |file| + File.open(File.join(hist_dir, 'createdInfo.json'), 'wb') do |file| file.write(json.to_json) end end @@ -227,7 +227,7 @@ class DocumentHelper # get history path url def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link - user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" + user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : '' uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver=' + version.to_s + '&file=' + ERB::Util.url_encode(file) + user_host return uri end @@ -253,7 +253,7 @@ class DocumentHelper # get url to download a file def get_download_url(file_name, is_serverUrl = true) - user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : "" + user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : '' get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host end @@ -275,7 +275,7 @@ class DocumentHelper # get image url for templates def get_template_image_url(file_type) - path = get_server_url(true) + "/assets/" + path = get_server_url(true) + '/assets/' case file_type when 'word' # for word type full_path = path + 'file_docx.svg' @@ -300,18 +300,18 @@ class DocumentHelper # write file parameters to the info object info = { - "version" => get_file_version(history_dir(directory)), - "id" => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), - "contentLength" => "#{(File.size(directory) / 1024.0).round(2)} KB", - "pureContentLength" => File.size(directory), - "title" => fileName, - "updated" => File.mtime(directory) + 'version' => get_file_version(history_dir(directory)), + 'id' => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), + 'contentLength' => "#{(File.size(directory) / 1024.0).round(2)} KB", + 'pureContentLength' => File.size(directory), + 'title' => fileName, + 'updated' => File.mtime(directory) } if file_id == nil # if file id is undefined result.push(info) # push info object to the response array else # if file id is defined - if file_id.eql?(info["id"]) # and it is equal to the document key value + if file_id.eql?(info['id']) # and it is equal to the document key value result.push(info) # response object will be equal to the info object return result end @@ -319,7 +319,7 @@ class DocumentHelper end if file_id != nil - return "\"File not found\"" + return '"File not found"' else return result end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index e2c4ec5d..d0b1e531 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -34,7 +34,7 @@ class FileModel end def type - @type ? @type : "desktop" # the default platform type is desktop + @type ? @type : 'desktop' # the default platform type is desktop end # get file extension from its name @@ -49,7 +49,7 @@ class FileModel # get file uri for document server def file_uri_user - @config_manager.storage_path.absolute? ? download_url + "&dmode=emb" : DocumentHelper.get_file_uri(@file_name, false) + @config_manager.storage_path.absolute? ? download_url + '&dmode=emb' : DocumentHelper.get_file_uri(@file_name, false) end # get document type from its name (word, cell or slide) @@ -86,25 +86,25 @@ class FileModel # get config parameters def get_config - editorsmode = @mode ? @mode : "edit" # mode: view/edit/review/comment/fillForms/embedded + editorsmode = @mode ? @mode : 'edit' # mode: view/edit/review/comment/fillForms/embedded canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited - if (!canEdit && editorsmode.eql?("edit") || editorsmode.eql?("fillForms")) && DocumentHelper.fill_forms_exts.include?(file_ext) - editorsmode = "fillForms" + if (!canEdit && editorsmode.eql?('edit') || editorsmode.eql?('fillForms')) && DocumentHelper.fill_forms_exts.include?(file_ext) + editorsmode = 'fillForms' canEdit = true end - submitForm = editorsmode.eql?("fillForms") && @user.id.eql?("uid-1") && false # the Submit form button state - mode = canEdit && !editorsmode.eql?("view") ? "edit" : "view" + submitForm = editorsmode.eql?('fillForms') && @user.id.eql?('uid-1') && false # the Submit form button state + mode = canEdit && !editorsmode.eql?('view') ? 'edit' : 'view' templatesImageUrl = DocumentHelper.get_template_image_url(document_type) # templates image url in the "From Template" section templates = [ { - :image => "", - :title => "Blank", + :image => '', + :title => 'Blank', :url => create_url }, { :image => templatesImageUrl, - :title => "With sample content", - :url => create_url + "&sample=true" + :title => 'With sample content', + :url => create_url + '&sample=true' } ] @@ -114,48 +114,48 @@ class FileModel :document => { :title => @file_name, :url => download_url, - :directUrl => is_enable_direct_url ? download_url(false) : "", - :fileType => file_ext.delete("."), + :directUrl => is_enable_direct_url ? download_url(false) : '', + :fileType => file_ext.delete('.'), :key => key, :info => { - :owner => "Me", + :owner => 'Me', :uploaded => Time.now.to_s, :favorite => @user.favorite }, :permissions => { # the permission for the document to be edited and downloaded or not - :comment => !editorsmode.eql?("view") && !editorsmode.eql?("fillForms") && !editorsmode.eql?("embedded") && !editorsmode.eql?("blockcontent"), - :copy => !@user.deniedPermissions.include?("copy"), - :download => !@user.deniedPermissions.include?("download"), - :edit => canEdit && (editorsmode.eql?("edit") || editorsmode.eql?("view") || editorsmode.eql?("filter") || editorsmode.eql?("blockcontent")), - :print => !@user.deniedPermissions.include?("print"), - :fillForms => !editorsmode.eql?("view") && !editorsmode.eql?("comment") && !editorsmode.eql?("embedded") && !editorsmode.eql?("blockcontent"), - :modifyFilter => !editorsmode.eql?("filter"), - :modifyContentControl => !editorsmode.eql?("blockcontent"), - :review => canEdit && (editorsmode.eql?("edit") || editorsmode.eql?("review")), - :chat => !@user.id.eql?("uid-0"), + :comment => !editorsmode.eql?('view') && !editorsmode.eql?('fillForms') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + :copy => !@user.deniedPermissions.include?('copy'), + :download => !@user.deniedPermissions.include?('download'), + :edit => canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('view') || editorsmode.eql?('filter') || editorsmode.eql?('blockcontent')), + :print => !@user.deniedPermissions.include?('print'), + :fillForms => !editorsmode.eql?('view') && !editorsmode.eql?('comment') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + :modifyFilter => !editorsmode.eql?('filter'), + :modifyContentControl => !editorsmode.eql?('blockcontent'), + :review => canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('review')), + :chat => !@user.id.eql?('uid-0'), :reviewGroups => @user.reviewGroups, :commentGroups => @user.commentGroups, :userInfoGroups => @user.userInfoGroups, - :protect => !@user.deniedPermissions.include?("protect") + :protect => !@user.deniedPermissions.include?('protect') }, :referenceData => { :instanceId => DocumentHelper.get_server_url(false), - :fileKey => !@user.id.eql?("uid-0") ? { :fileName => @file_name, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil + :fileKey => !@user.id.eql?('uid-0') ? { :fileName => @file_name, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil } }, :editorConfig => { :actionLink => @action_data ? JSON.parse(@action_data) : nil, :mode => mode, - :lang => @lang ? @lang : "en", + :lang => @lang ? @lang : 'en', :callbackUrl => callback_url, # absolute URL to the document storage service - :coEditing => editorsmode.eql?("view") && @user.id.eql?("uid-0") ? { - :mode => "strict", + :coEditing => editorsmode.eql?('view') && @user.id.eql?('uid-0') ? { + :mode => 'strict', :change => false } : nil, - :createUrl => !@user.id.eql?("uid-0") ? create_url : nil, + :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, :templates => @user.templates ? templates : nil, :user => { # the user currently viewing or editing the document - :id => !@user.id.eql?("uid-0") ? @user.id : nil, + :id => !@user.id.eql?('uid-0') ? @user.id : nil, :name => @user.name, :group => @user.group, :image => @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil @@ -164,7 +164,7 @@ class FileModel :saveUrl => download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer :embedUrl => download_url(false), # the absolute URL to the document serving as a source file for the document embedded into the web page :shareUrl => download_url(false), # the absolute URL that will allow other users to share this document - :toolbarDocked => "top" # the place for the embedded viewer toolbar (top or bottom) + :toolbarDocked => 'top' # the place for the embedded viewer toolbar (top or bottom) }, :customization => { # the parameters for the editor interface :about => true, # the About section display @@ -180,7 +180,7 @@ class FileModel } if JwtHelper.is_enabled # check if a secret key to generate token exists or not - config["token"] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config + config['token'] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config end return config @@ -208,70 +208,70 @@ class FileModel # get document key cur_key = doc_key if (i != cur_ver) - File.open(File.join(ver_dir, "key.txt"), 'r') do |file| + File.open(File.join(ver_dir, 'key.txt'), 'r') do |file| cur_key = file.read() end end - obj["key"] = cur_key - obj["version"] = i + obj['key'] = cur_key + obj['version'] = i if (i == 1) # check if the version number is equal to 1 - if File.file?(File.join(hist_dir, "createdInfo.json")) # check if the createdInfo.json file with meta data exists - File.open(File.join(hist_dir, "createdInfo.json"), 'r') do |file| # open it + if File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists + File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it cr_info = JSON.parse(file.read()) # parse the file content # write information about changes to the object - obj["created"] = cr_info["created"] - obj["user"] = { - :id => cr_info["uid"], - :name => cr_info["uname"] + obj['created'] = cr_info['created'] + obj['user'] = { + :id => cr_info['uid'], + :name => cr_info['uname'] } end end end # get the history data from the previous file version and write key and url information about it - dataObj["fileType"] = file_ext[1..file_ext.length] - dataObj["key"] = cur_key - dataObj["url"] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") + dataObj['fileType'] = file_ext[1..file_ext.length] + dataObj['key'] = cur_key + dataObj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") if is_enable_direct_url == true - dataObj["directUrl"] = i == cur_ver ? download_url(false) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) + dataObj['directUrl'] = i == cur_ver ? download_url(false) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) end - dataObj["version"] = i + dataObj['version'] = i if (i > 1) # check if the version number is greater than 1 changes = nil change = nil - File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), "changes.json"), 'r') do |file| # get the path to the changes.json file + File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| # get the path to the changes.json file changes = JSON.parse(file.read()) # and parse its content end - change = changes["changes"][0] + change = changes['changes'][0] # write information about changes to the object - obj["changes"] = change ? changes["changes"] : nil - obj["serverVersion"] = changes["serverVersion"] - obj["created"] = change ? change["created"] : nil - obj["user"] = change ? change["user"] : nil + obj['changes'] = change ? changes['changes'] : nil + obj['serverVersion'] = changes['serverVersion'] + obj['created'] = change ? change['created'] : nil + obj['user'] = change ? change['user'] : nil prev = histData[(i - 2).to_s] # get the history data from the previous file version - dataObj["previous"] = is_enable_direct_url == true ? { # write key and url information about previous file version with optional direct url - :fileType => prev["fileType"], - :key => prev["key"], - :url => prev["url"], - :directUrl => prev["directUrl"] + dataObj['previous'] = is_enable_direct_url == true ? { # write key and url information about previous file version with optional direct url + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'], + :directUrl => prev['directUrl'] } : { - :fileType => prev["fileType"], - :key => prev["key"], - :url => prev["url"] + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'] } # write the path to the diff.zip archive with differences in this file version - dataObj["changesUrl"] = DocumentHelper.get_historypath_uri(file_name, i - 1, "diff.zip") + dataObj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataObj["token"] = JwtHelper.encode(dataObj) # encode a payload object into a token and write it to the data object + dataObj['token'] = JwtHelper.encode(dataObj) # encode a payload object into a token and write it to the data object end hist.push(obj) # add object dictionary to the hist list @@ -293,34 +293,34 @@ class FileModel # get image information def get_insert_image insert_image = is_enable_direct_url == true ? { - :fileType => "png", # image file type - :url => DocumentHelper.get_server_url(true) + "/assets/logo.png", # server url to the image - :directUrl => DocumentHelper.get_server_url(false) + "/assets/logo.png" # direct url to the image + :fileType => 'png', # image file type + :url => DocumentHelper.get_server_url(true) + '/assets/logo.png', # server url to the image + :directUrl => DocumentHelper.get_server_url(false) + '/assets/logo.png' # direct url to the image } : { - :fileType => "png", # image file type - :url => DocumentHelper.get_server_url(true) + "/assets/logo.png" # server url to the image + :fileType => 'png', # image file type + :url => DocumentHelper.get_server_url(true) + '/assets/logo.png' # server url to the image } if JwtHelper.is_enabled # check if a secret key to generate token exists or not - insert_image["token"] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object + insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object end - return insert_image.to_json.tr("{", "").tr("}", "") + return insert_image.to_json.tr('{', '').tr('}', '') end # get compared file information def dataDocument compare_file = is_enable_direct_url == true ? { - :fileType => "docx", # file type - :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx", # server url to the compared file - :directUrl => DocumentHelper.get_server_url(false) + "/asset?fileName=sample.docx" # direct url to the compared file + :fileType => 'docx', # file type + :url => DocumentHelper.get_server_url(true) + '/asset?fileName=sample.docx', # server url to the compared file + :directUrl => DocumentHelper.get_server_url(false) + '/asset?fileName=sample.docx' # direct url to the compared file } : { - :fileType => "docx", # file type - :url => DocumentHelper.get_server_url(true) + "/asset?fileName=sample.docx" # server url to the compared file + :fileType => 'docx', # file type + :url => DocumentHelper.get_server_url(true) + '/asset?fileName=sample.docx' # server url to the compared file } if JwtHelper.is_enabled # check if a secret key to generate token exists or not - compare_file["token"] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object + compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object end return compare_file @@ -329,16 +329,16 @@ class FileModel # get mail merge recipients information def dataSpreadsheet dataSpreadsheet = is_enable_direct_url == true ? { - :fileType => "csv", # file type - :url => DocumentHelper.get_server_url(true) + "/csv", # server url to the mail merge recipients file - :directUrl => DocumentHelper.get_server_url(false) + "/csv" # direct url to the mail merge recipients file + :fileType => 'csv', # file type + :url => DocumentHelper.get_server_url(true) + '/csv', # server url to the mail merge recipients file + :directUrl => DocumentHelper.get_server_url(false) + '/csv' # direct url to the mail merge recipients file } : { - :fileType => "csv", # file type - :url => DocumentHelper.get_server_url(true) + "/csv" # server url to the mail merge recipients file + :fileType => 'csv', # file type + :url => DocumentHelper.get_server_url(true) + '/csv' # server url to the mail merge recipients file } if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataSpreadsheet["token"] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object + dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object end return dataSpreadsheet @@ -346,12 +346,12 @@ class FileModel # get users data for mentions def get_users_mentions - return !@user.id.eql?("uid-0") ? Users.get_users_for_mentions(@user.id) : nil + return !@user.id.eql?('uid-0') ? Users.get_users_for_mentions(@user.id) : nil end def get_users_info users_info = [] - if !@user.id.eql?("uid-0") + if !@user.id.eql?('uid-0') Users.get_all_users().each do |user_info| u = { id: user_info.id, @@ -367,7 +367,7 @@ class FileModel templates: user_info.templates, avatar: user_info.avatar } - u["image"] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil + u['image'] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil users_info.push(u) end return users_info @@ -376,11 +376,11 @@ class FileModel # get users data for protect def get_users_protect - return !@user.id.eql?("uid-0") ? Users.get_users_for_protect(@user.id) : nil + return !@user.id.eql?('uid-0') ? Users.get_users_for_protect(@user.id) : nil end # get direct url existence flag def is_enable_direct_url - return @direct_url != nil && @direct_url == "true" + return @direct_url != nil && @direct_url == 'true' end end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 779cb7aa..6951c6ce 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -42,7 +42,7 @@ class JwtHelper begin decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } rescue - return "" + return '' end # decoded = Array [ {"data"=>"test"}, # payload # {"alg"=>"HS256"} # header ] diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index aee29c3c..10bd7169 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -60,11 +60,11 @@ class ServiceConverter http.read_timeout = @@convert_timeout http.open_timeout = 5 req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Accept", "application/json") # set headers - req.add_field("Content-Type", "application/json") + req.add_field('Accept', 'application/json') # set headers + req.add_field('Content-Type', 'application/json') if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 1abf4d72..1b61fe9e 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -36,7 +36,7 @@ class TrackHelper body = request.body.read if body == nil || body.empty? - return "" + return '' end file_data = JSON.parse(body) # parse file data @@ -46,25 +46,25 @@ class TrackHelper inHeader = false token = nil jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config - if file_data["token"] # if the token is in the body - token = JwtHelper.decode(file_data["token"]) # decode a token into a payload object using a secret key + if file_data['token'] # if the token is in the body + token = JwtHelper.decode(file_data['token']) # decode a token into a payload object using a secret key elsif request.headers[jwtHeader] # if the token is in the header hdr = request.headers[jwtHeader] - hdr.slice!(0, "Bearer ".length) # get token from it (after Bearer prefix) + hdr.slice!(0, 'Bearer '.length) # get token from it (after Bearer prefix) token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key inHeader = true else - raise "Expected JWT" # token missing error message + raise 'Expected JWT' # token missing error message end - if !token || token.eql?("") - raise "Invalid JWT signature" + if !token || token.eql?('') + raise 'Invalid JWT signature' end file_data = JSON.parse(token) if inHeader - file_data = file_data["payload"] + file_data = file_data['payload'] end end @@ -107,7 +107,7 @@ class TrackHelper end new_file_name = file_name - download_ext = "." + file_data['filetype'] # get the extension of the downloaded file + download_ext = '.' + file_data['filetype'] # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension @@ -145,26 +145,26 @@ class TrackHelper save_file(data, storage_path) # save the downloaded file to the storage directory - change_data = download_file(file_data["changesurl"]) # download file with document versions differences - save_file(change_data, File.join(ver_dir, "diff.zip")) # save file with document versions differences + change_data = download_file(file_data['changesurl']) # download file with document versions differences + save_file(change_data, File.join(ver_dir, 'diff.zip')) # save file with document versions differences - hist_data = file_data["changeshistory"] + hist_data = file_data['changeshistory'] unless hist_data # if there are no changes in the history - hist_data = file_data["history"].to_json # write the original history information to the history data + hist_data = file_data['history'].to_json # write the original history information to the history data end if hist_data - File.open(File.join(ver_dir, "changes.json"), 'wb') do |file| # open the file with document changes + File.open(File.join(ver_dir, 'changes.json'), 'wb') do |file| # open the file with document changes file.write(hist_data) # and write history data to this file end end # write the key value to the key.txt file - File.open(File.join(ver_dir, "key.txt"), 'wb') do |file| - file.write(file_data["key"]) + File.open(File.join(ver_dir, 'key.txt'), 'wb') do |file| + file.write(file_data['key']) end forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file - unless forcesave_path.eql?("") # if this path is empty + unless forcesave_path.eql?('') # if this path is empty File.delete(forcesave_path) # remove it end @@ -184,7 +184,7 @@ class TrackHelper return saved end - download_ext = "." + file_data['filetype'] # get the extension of the downloaded file + download_ext = '.' + file_data['filetype'] # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension @@ -213,13 +213,13 @@ class TrackHelper end begin - is_submit_form = file_data["forcesavetype"].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) + is_submit_form = file_data['forcesavetype'].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) if is_submit_form if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + download_ext, user_address) # get the correct file name if it already exists + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + '-form' + download_ext, user_address) # get the correct file name if it already exists else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + "-form" + cur_ext, user_address) + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + '-form' + cur_ext, user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else @@ -227,7 +227,7 @@ class TrackHelper file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) - if forcesave_path.eql?("") + if forcesave_path.eql?('') forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it end end @@ -236,7 +236,7 @@ class TrackHelper if is_submit_form uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name + DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) # create file meta information with the Filling form tag instead of user name end saved = 0 @@ -267,10 +267,10 @@ class TrackHelper DocumentHelper.verify_ssl(@@document_command_url, http) req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field("Content-Type", "application/json") # set headers + req.add_field('Content-Type', 'application/json') # set headers if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled - payload["token"] = JwtHelper.encode(payload) # get token and save it to the payload + payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index a7c367ba..8d85b376 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -37,76 +37,76 @@ end class Users @@descr_user_1 = [ - "File author by default", - "Doesn’t belong to any group", - "Can review all the changes", - "Can perform all actions with comments", - "The file favorite state is undefined", - "Can create files from templates using data from the editor", - "Can see the information about all users", - "Has an avatar", + 'File author by default', + 'Doesn’t belong to any group', + 'Can review all the changes', + 'Can perform all actions with comments', + 'The file favorite state is undefined', + 'Can create files from templates using data from the editor', + 'Can see the information about all users', + 'Has an avatar', ]; @@descr_user_2 = [ - "Belongs to Group2", - "Can review only his own changes or changes made by users with no group", - "Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only", - "This file is marked as favorite", - "Can create new files from the editor", - "Can see the information about users from Group2 and users who don’t belong to any group", - "Has an avatar", + 'Belongs to Group2', + 'Can review only his own changes or changes made by users with no group', + 'Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only', + 'This file is marked as favorite', + 'Can create new files from the editor', + 'Can see the information about users from Group2 and users who don’t belong to any group', + 'Has an avatar', ]; @@descr_user_3 = [ - "Belongs to Group3", - "Can review changes made by Group2 users", - "Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users", - "This file isn’t marked as favorite", - "Can’t copy data from the file to clipboard", - "Can’t download the file", - "Can’t print the file", - "Can create new files from the editor", - "Can see the information about Group2 users", + 'Belongs to Group3', + 'Can review changes made by Group2 users', + 'Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users', + 'This file isn’t marked as favorite', + 'Can’t copy data from the file to clipboard', + 'Can’t download the file', + 'Can’t print the file', + 'Can create new files from the editor', + 'Can see the information about Group2 users', ]; @@descr_user_0 = [ - "The name is requested when the editor is opened", - "Doesn’t belong to any group", - "Can review all the changes", - "Can perform all actions with comments", - "The file favorite state is undefined", + 'The name is requested when the editor is opened', + 'Doesn’t belong to any group', + 'Can review all the changes', + 'Can perform all actions with comments', + 'The file favorite state is undefined', "Can't mention others in comments", "Can't create new files from the editor", - "Can’t see anyone’s information", + 'Can’t see anyone’s information', "Can't rename files from the editor", "Can't view chat", "Can't protect file", - "View file without collaboration" + 'View file without collaboration' ]; @@users = [ - User.new("uid-1", "John Smith", "smith@example.com", - "", nil, {}, nil, + User.new('uid-1', 'John Smith', 'smith@example.com', + '', nil, {}, nil, nil, [], @@descr_user_1, true, true), - User.new("uid-2", "Mark Pottato", "pottato@example.com", - "group-2", ["group-2", ""], { - :view => "", - :edit => ["group-2", ""], - :remove => ["group-2"] + User.new('uid-2', 'Mark Pottato', 'pottato@example.com', + 'group-2', ['group-2', ''], { + :view => '', + :edit => ['group-2', ''], + :remove => ['group-2'] }, - ["group-2", ""], + ['group-2', ''], true, [], @@descr_user_2, false, true), - User.new("uid-3", "Hamish Mitchell", nil, - "group-3", ["group-2"], { - :view => ["group-3", "group-2"], - :edit => ["group-2"], + User.new('uid-3', 'Hamish Mitchell', nil, + 'group-3', ['group-2'], { + :view => ['group-3', 'group-2'], + :edit => ['group-2'], :remove => [] }, - ["group-2"], - false, ["copy", "download", "print"], @@descr_user_3, false, false), - User.new("uid-0", nil, nil, - "", nil, {}, [], - nil, ["protect"], @@descr_user_0, false, false) + ['group-2'], + false, ['copy', 'download', 'print'], @@descr_user_3, false, false), + User.new('uid-0', nil, nil, + '', nil, {}, [], + nil, ['protect'], @@descr_user_0, false, false) ] class << self From 5255f0e4628a8066b016b7b77d87682094ef3b3a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:46:08 +0300 Subject: [PATCH 027/176] ruby: Style/SymbolArray correct --- web/documentserver-example/ruby/Gemfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 43adf6cd..656c3256 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -1,6 +1,6 @@ source 'https://rubygems.org' -gem 'byebug', '~> 11.1', :groups => [:development, :test] +gem 'byebug', '~> 11.1', :groups => %i[development test] gem 'coffee-rails', '~> 5.0' gem 'dalli', '~> 3.2', :group => :development gem 'jbuilder', '~> 2.11' @@ -13,12 +13,12 @@ gem 'rubocop', '~> 1.52', :group => :development gem 'sass-rails', '~> 6.0' gem 'sdoc', '~> 2.6', :group => :doc gem 'sorbet-runtime', '~> 0.5.10871' -gem 'test-unit', '~> 3.6', :groups => [:development, :test] +gem 'test-unit', '~> 3.6', :groups => %i[development test] gem 'turbolinks', '~> 5.2' gem 'tzinfo-data', '~> 1.2023' gem 'uglifier', '~> 4.2' gem 'uuid', '~> 2.3' -gem 'web-console', '~> 4.2', :groups => [:development, :test] +gem 'web-console', '~> 4.2', :groups => %i[development test] gem 'webrick', '~> 1.8' # Unfortunately, Sorbet only supports Darwin and Linux-based systems. From 15b905613c0ebc6ce4f8daf45e7a50868982bbd5 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:47:16 +0300 Subject: [PATCH 028/176] ruby: Style/EmptyMethod correct --- .../ruby/app/controllers/home_controller.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index b968b45b..6215583e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -26,8 +26,7 @@ class HomeController < ApplicationController attr_reader :config_manager end - def index - end + def index; end def editor DocumentHelper.init(request.remote_ip, request.base_url) From f5801a7f8cb357c5be433ca73b830d03e72f4376 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 14:53:05 +0300 Subject: [PATCH 029/176] ruby: Style/IfUnlessModifier correct --- .../ruby/app/controllers/home_controller.rb | 36 +++++------------ .../ruby/app/models/document_helper.rb | 20 +++------- .../ruby/app/models/service_converter.rb | 8 +--- .../ruby/app/models/track_helper.rb | 40 +++++-------------- .../ruby/app/models/users.rb | 12 ++---- 5 files changed, 29 insertions(+), 87 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 6215583e..d8c5652e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -52,16 +52,12 @@ class HomeController < ApplicationController cur_size = http_posted_file.size # check if the file size exceeds the maximum file size - if DocumentHelper.file_size_max < cur_size || cur_size <= 0 - raise 'File size is incorrect' - end + raise 'File size is incorrect' if DocumentHelper.file_size_max < cur_size || cur_size <= 0 cur_ext = File.extname(file_name).downcase # check if the file extension is supported by the editor - unless DocumentHelper.file_exts.include? cur_ext - raise 'File type is not supported' - end + raise 'File type is not supported' unless DocumentHelper.file_exts.include? cur_ext # get the correct file name if such a name already exists file_name = DocumentHelper.get_correct_name(file_name, nil) @@ -87,9 +83,7 @@ class HomeController < ApplicationController def convert begin file_data = request.body.read - if file_data == nil || file_data.empty? - return '' - end + return '' if file_data == nil || file_data.empty? body = JSON.parse(file_data) @@ -122,9 +116,7 @@ class HomeController < ApplicationController res = http.request(req) data = res.body - if data == nil - raise 'stream is null' - end + raise 'stream is null' if data == nil # write a file with a new extension, but with the content from the origin file File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| @@ -132,9 +124,7 @@ class HomeController < ApplicationController end old_storage_path = DocumentHelper.storage_path(file_name, nil) - if File.exist?(old_storage_path) - File.delete(old_storage_path) - end + File.delete(old_storage_path) if File.exist?(old_storage_path) file_name = correct_name user = Users.get_user(params[:userId]) @@ -356,9 +346,7 @@ class HomeController < ApplicationController orig_ext = '.' + body['ext'] cur_ext = File.extname(newfilename).downcase - if orig_ext != cur_ext - newfilename += orig_ext - end + newfilename += orig_ext if orig_ext != cur_ext meta = { :title => newfilename @@ -380,9 +368,7 @@ class HomeController < ApplicationController if instanceId == DocumentHelper.get_server_url(false) fileKey = JSON.parse(referenceData['fileKey']) userAddress = fileKey['userAddress'] - if userAddress == DocumentHelper.cur_user_host_address(nil) - fileName = fileKey['fileName'] - end + fileName = fileKey['fileName'] if userAddress == DocumentHelper.cur_user_host_address(nil) end end @@ -408,9 +394,7 @@ class HomeController < ApplicationController if fileName.empty? and body.key?('path') path = File.basename(body['path']) - if File.exist?(DocumentHelper.storage_path(path, nil)) - fileName = path - end + fileName = path if File.exist?(DocumentHelper.storage_path(path, nil)) end if fileName.empty? @@ -431,9 +415,7 @@ class HomeController < ApplicationController :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName } - if JwtHelper.is_enabled - data['token'] = JwtHelper.encode(data) - end + data['token'] = JwtHelper.encode(data) if JwtHelper.is_enabled render plain: data.to_json end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 445deddd..ca954697 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -75,9 +75,7 @@ class DocumentHelper directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) # create a new directory if it doesn't exist - unless File.directory?(directory) - FileUtils.mkdir_p(directory) - end + FileUtils.mkdir_p(directory) unless File.directory?(directory) # put the given file to this directory File.join(directory, File.basename(file_name)) @@ -88,9 +86,7 @@ class DocumentHelper directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) # the directory with host address doesn't exist - unless File.directory?(directory) - return '' - end + return '' unless File.directory?(directory) directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file unless File.directory?(directory) @@ -103,9 +99,7 @@ class DocumentHelper directory = File.join(directory, File.basename(file_name)) # get the path to the given file unless File.file?(directory) - if !create - return '' - end + return '' if !create end return directory.to_s @@ -116,9 +110,7 @@ class DocumentHelper directory = "#{storage_path}-hist" # create history directory if it doesn't exist - unless File.directory?(directory) - FileUtils.mkdir_p(directory) - end + FileUtils.mkdir_p(directory) unless File.directory?(directory) return directory end @@ -130,9 +122,7 @@ class DocumentHelper # get the last file version def get_file_version(hist_dir) - if !Dir.exist?(hist_dir) - return 1 - end + return 1 if !Dir.exist?(hist_dir) ver = 1 Dir.foreach(hist_dir) { |e| # run through all the file versions diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 10bd7169..2200cc16 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -73,9 +73,7 @@ class ServiceConverter res = http.request(req) # get the response status_code = res.code.to_i - if status_code != 200 # checking status code - raise "Conversion service returned status: #{status_code}" - end + raise "Conversion service returned status: #{status_code}" if status_code != 200 # checking status code data = res.body # and take its body rescue Timeout::Error @@ -163,9 +161,7 @@ class ServiceConverter percent_element = file_result['percent'] # get the percentage value - if percent_element != nil - result_percent = percent_element.to_i - end + result_percent = percent_element.to_i if percent_element != nil result_percent = result_percent >= 100 ? 99 : result_percent diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 1b61fe9e..2e436d1a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -35,9 +35,7 @@ class TrackHelper def read_body(request) body = request.body.read - if body == nil || body.empty? - return '' - end + return '' if body == nil || body.empty? file_data = JSON.parse(body) # parse file data @@ -57,15 +55,11 @@ class TrackHelper raise 'Expected JWT' # token missing error message end - if !token || token.eql?('') - raise 'Invalid JWT signature' - end + raise 'Invalid JWT signature' if !token || token.eql?('') file_data = JSON.parse(token) - if inHeader - file_data = file_data['payload'] - end + file_data = file_data['payload'] if inHeader end return file_data @@ -89,9 +83,7 @@ class TrackHelper end home = copied['home'] - if home - copied['home'] = resolve_process_save_body(home) - end + copied['home'] = resolve_process_save_body(home) if home copied end @@ -129,9 +121,7 @@ class TrackHelper saved = 1 data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end + return saved if data.eql?(nil) begin storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file @@ -208,9 +198,7 @@ class TrackHelper saved = 1 data = download_file(download_uri) # download document file - if data.eql?(nil) - return saved - end + return saved if data.eql?(nil) begin is_submit_form = file_data['forcesavetype'].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) @@ -223,9 +211,7 @@ class TrackHelper end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) if new_file_name forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it @@ -255,9 +241,7 @@ class TrackHelper :key => key } - if (meta != nil) - payload.merge!({ :meta => meta }) - end + payload.merge!({ :meta => meta }) if (meta != nil) data = nil begin @@ -298,15 +282,11 @@ class TrackHelper res = http.request(req) # get the response status_code = res.code - if status_code != '200' # checking status code - raise "Document editing service returned status: #{status_code}" - end + raise "Document editing service returned status: #{status_code}" if status_code != '200' # checking status code data = res.body # and take its body - if data == nil - raise 'stream is null' - end + raise 'stream is null' if data == nil data end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 8d85b376..17703e2e 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -116,9 +116,7 @@ class Users def get_user(id) # get a user by id specified for user in @@users do - if user.id.eql?(id) - return user - end + return user if user.id.eql?(id) end return @@users[0] end @@ -126,9 +124,7 @@ class Users def get_users_for_mentions(id) # get a list of users with their names and emails for mentions usersData = [] for user in @@users do - if (!user.id.eql?(id) && user.name != nil && user.email != nil) - usersData.push({ :name => user.name, :email => user.email }) - end + usersData.push({ :name => user.name, :email => user.email }) if (!user.id.eql?(id) && user.name != nil && user.email != nil) end return usersData end @@ -136,9 +132,7 @@ class Users def get_users_for_protect(id) # get a list of users with their id, names and emails for protect users_data = [] for user in @@users do - if (!user.id.eql?(id) && user.name != nil) - users_data.push({ id: user.id, name: user.name, email: user.email }) - end + users_data.push({ id: user.id, name: user.name, email: user.email }) if (!user.id.eql?(id) && user.name != nil) end return users_data end From eb6861059efd414da13193cd6727e31f20d585d8 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 15:00:52 +0300 Subject: [PATCH 030/176] ruby: Style/StringConcatenation correct --- .../ruby/app/controllers/home_controller.rb | 36 +++++++++---------- .../ruby/app/models/document_helper.rb | 28 +++++++-------- .../ruby/app/models/file_model.rb | 24 ++++++------- .../ruby/app/models/service_converter.rb | 2 +- .../ruby/app/models/track_helper.rb | 8 ++--- 5 files changed, 49 insertions(+), 49 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index d8c5652e..6bd15d33 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -73,9 +73,9 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) - render plain: '{ "filename": "' + file_name + '", "documentType": "' + document_type + '"}' # write a new file name to the response + render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" # write a new file name to the response rescue => ex - render plain: '{ "error": "' + ex.message + '"}' # write an error message to the response + render plain: "{ \"error\": \"#{ex.message}\"}" # write an error message to the response end end @@ -100,12 +100,12 @@ class HomeController < ApplicationController # if the conversion isn't completed, write file name and step values to the response if percent != 100 - render plain: '{ "step" : "' + percent.to_s + '", "filename" : "' + file_name + '"}' + render plain: "{ \"step\" : \"#{percent.to_s}\", \"filename\" : \"#{file_name}\"}" return end # get the correct file name if such a name already exists - correct_name = DocumentHelper.get_correct_name(File.basename(file_name, extension) + '.' + new_file_type, nil) + correct_name = DocumentHelper.get_correct_name("#{File.basename(file_name, extension)}.#{new_file_type}", nil) uri = URI.parse(new_file_uri) # create the request url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server @@ -132,9 +132,9 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file end - render plain: '{ "filename" : "' + file_name + '"}' + render plain: "{ \"filename\" : \"#{file_name}\"}" rescue => ex - render plain: '{ "error": "' + ex.message + '"}' + render plain: "{ \"error\": \"#{ex.message}\"}" end end @@ -162,14 +162,14 @@ class HomeController < ApplicationController return end end - hist_path = DocumentHelper.storage_path(file_name, user_address) + '-hist' # or to the original document + hist_path = "#{DocumentHelper.storage_path(file_name, user_address)}-hist" # or to the original document file_path = File.join(hist_path, version, file) # add headers to the response to specify the page parameters response.headers['Content-Length'] = File.size(file_path).to_s response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + ERB::Util.url_encode(file) + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" send_file file_path, :x_sendfile => true rescue => ex @@ -201,13 +201,13 @@ class HomeController < ApplicationController if status == 2 || status == 3 # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file - render plain: '{"error":' + saved.to_s + '}' + render plain: "{\"error\":#{saved.to_s}}" return end if status == 6 || status == 7 # MustForceave, CorruptedForcesave saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file - render plain: '{"error":' + saved.to_s + '}' + render plain: "{\"error\":#{saved.to_s}}" return end @@ -254,7 +254,7 @@ class HomeController < ApplicationController # add headers to the response to specify the page parameters response.headers['Content-Length'] = File.size(csvPath).to_s response.headers['Content-Type'] = MimeMagic.by_path(csvPath).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + ERB::Util.url_encode(file_name) + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" send_file csvPath, :x_sendfile => true end @@ -287,7 +287,7 @@ class HomeController < ApplicationController # add headers to the response to specify the page parameters response.headers['Content-Length'] = File.size(file_path).to_s response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + ERB::Util.url_encode(file_name) + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" send_file file_path, :x_sendfile => true rescue => ex @@ -330,10 +330,10 @@ class HomeController < ApplicationController user = Users.get_user(params[:userId]) DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file - render plain: '{"file" : "' + file_name + '"}' + render plain: "{\"file\" : \"#{file_name}\"}" return rescue => ex - render plain: '{"error":1, "message": "' + ex.message + '"}' + render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" return end end @@ -344,7 +344,7 @@ class HomeController < ApplicationController dockey = body['dockey'] newfilename = body['newfilename'] - orig_ext = '.' + body['ext'] + orig_ext = ".#{body['ext']}" cur_ext = File.extname(newfilename).downcase newfilename += orig_ext if orig_ext != cur_ext @@ -353,7 +353,7 @@ class HomeController < ApplicationController } json_data = TrackHelper.command_request('meta', dockey, meta) - render plain: '{ "result" : "' + JSON.dump(json_data) + '"}' + render plain: "{ \"result\" : \"#{JSON.dump(json_data)}\"}" end # ReferenceData @@ -404,7 +404,7 @@ class HomeController < ApplicationController data = { :fileType => File.extname(fileName).downcase.delete('.'), - :key => ServiceConverter.generate_revision_id("#{DocumentHelper.cur_user_host_address(nil) + '/' + fileName}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), + :key => ServiceConverter.generate_revision_id("#{"#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}"}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), :url => DocumentHelper.get_download_url(fileName), :directUrl => body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, :referenceData => { @@ -412,7 +412,7 @@ class HomeController < ApplicationController :fileKey => { :fileName => fileName, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json }, :path => fileName, - :link => DocumentHelper.get_server_url(false) + '/editor?fileName=' + fileName + :link => "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{fileName}" } data['token'] = JwtHelper.encode(data) if JwtHelper.is_enabled diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index ca954697..e0080689 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -147,7 +147,7 @@ class DocumentHelper index = 1 while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory - name = base_name + ' (' + index.to_s + ')' + ext.downcase # add an index after its base name + name = "#{base_name} (#{index.to_s})#{ext.downcase}" # add an index after its base name index = index + 1 end @@ -209,7 +209,7 @@ class DocumentHelper # get file url def get_file_uri(file_name, for_document_server) - uri = get_server_url(for_document_server) + '/' + DocumentHelper.config_manager.storage_path.to_s + '/' + cur_user_host_address(nil) + '/' + ERB::Util.url_encode(file_name) + uri = "#{get_server_url(for_document_server)}/#{DocumentHelper.config_manager.storage_path.to_s}/#{cur_user_host_address(nil)}/#{ERB::Util.url_encode(file_name)}" return uri end @@ -217,8 +217,8 @@ class DocumentHelper # get history path url def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link - user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : '' - uri = get_server_url(is_serverUrl) + '/downloadhistory/?fileName=' + ERB::Util.url_encode(file_name) + '&ver=' + version.to_s + '&file=' + ERB::Util.url_encode(file) + user_host + user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' + uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version.to_s}&file=#{ERB::Util.url_encode(file)}#{user_host}" return uri end @@ -233,18 +233,18 @@ class DocumentHelper # get callback url def get_callback(file_name) - get_server_url(true) + '/track?fileName=' + ERB::Util.url_encode(file_name) + '&userAddress=' + cur_user_host_address(nil) + "#{get_server_url(true)}/track?fileName=#{ERB::Util.url_encode(file_name)}&userAddress=#{cur_user_host_address(nil)}" end # get url to the created file def get_create_url(document_type) - get_server_url(false) + '/sample?fileExt=' + get_internal_extension(document_type).delete('.') + "#{get_server_url(false)}/sample?fileExt=#{get_internal_extension(document_type).delete('.')}" end # get url to download a file def get_download_url(file_name, is_serverUrl = true) - user_host = is_serverUrl ? '&userAddress=' + cur_user_host_address(nil) : '' - get_server_url(is_serverUrl) + '/download?fileName=' + ERB::Util.url_encode(file_name) + user_host + user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' + "#{get_server_url(is_serverUrl)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" end # get internal file extension by its type @@ -265,16 +265,16 @@ class DocumentHelper # get image url for templates def get_template_image_url(file_type) - path = get_server_url(true) + '/assets/' + path = "#{get_server_url(true)}/assets/" case file_type when 'word' # for word type - full_path = path + 'file_docx.svg' + full_path = "#{path}file_docx.svg" when 'cell' # .xlsx for cell type - full_path = path + 'file_xlsx.svg' + full_path = "#{path}file_xlsx.svg" when 'slide' # .pptx for slide type - full_path = path + 'file_pptx.svg' + full_path = "#{path}file_pptx.svg" else - full_path = path + 'file_docx.svg' # the default value is .docx + full_path = "#{path}file_docx.svg" # the default value is .docx end full_path @@ -286,7 +286,7 @@ class DocumentHelper for fileName in get_stored_files(nil) # run through all the stored files from the folder directory = storage_path(fileName, nil) - uri = cur_user_host_address(nil) + '/' + fileName + uri = "#{cur_user_host_address(nil)}/#{fileName}" # write file parameters to the info object info = { diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index d0b1e531..6de54e57 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -49,7 +49,7 @@ class FileModel # get file uri for document server def file_uri_user - @config_manager.storage_path.absolute? ? download_url + '&dmode=emb' : DocumentHelper.get_file_uri(@file_name, false) + @config_manager.storage_path.absolute? ? "#{download_url}&dmode=emb" : DocumentHelper.get_file_uri(@file_name, false) end # get document type from its name (word, cell or slide) @@ -59,7 +59,7 @@ class FileModel # generate the document key value def key - uri = DocumentHelper.cur_user_host_address(nil) + '/' + @file_name # get current user host address + uri = "#{DocumentHelper.cur_user_host_address(nil)}/#{@file_name}" # get current user host address stat = File.mtime(DocumentHelper.storage_path(@file_name, nil)) # get the modification time of the given file return ServiceConverter.generate_revision_id("#{uri}.#{stat}") end @@ -104,7 +104,7 @@ class FileModel { :image => templatesImageUrl, :title => 'With sample content', - :url => create_url + '&sample=true' + :url => "#{create_url}&sample=true" } ] @@ -294,11 +294,11 @@ class FileModel def get_insert_image insert_image = is_enable_direct_url == true ? { :fileType => 'png', # image file type - :url => DocumentHelper.get_server_url(true) + '/assets/logo.png', # server url to the image - :directUrl => DocumentHelper.get_server_url(false) + '/assets/logo.png' # direct url to the image + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image + :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image } : { :fileType => 'png', # image file type - :url => DocumentHelper.get_server_url(true) + '/assets/logo.png' # server url to the image + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image } if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -312,11 +312,11 @@ class FileModel def dataDocument compare_file = is_enable_direct_url == true ? { :fileType => 'docx', # file type - :url => DocumentHelper.get_server_url(true) + '/asset?fileName=sample.docx', # server url to the compared file - :directUrl => DocumentHelper.get_server_url(false) + '/asset?fileName=sample.docx' # direct url to the compared file + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file + :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file } : { :fileType => 'docx', # file type - :url => DocumentHelper.get_server_url(true) + '/asset?fileName=sample.docx' # server url to the compared file + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file } if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -330,11 +330,11 @@ class FileModel def dataSpreadsheet dataSpreadsheet = is_enable_direct_url == true ? { :fileType => 'csv', # file type - :url => DocumentHelper.get_server_url(true) + '/csv', # server url to the mail merge recipients file - :directUrl => DocumentHelper.get_server_url(false) + '/csv' # direct url to the mail merge recipients file + :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file + :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file } : { :fileType => 'csv', # file type - :url => DocumentHelper.get_server_url(true) + '/csv' # server url to the mail merge recipients file + :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file } if JwtHelper.is_enabled # check if a secret key to generate token exists or not diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 2200cc16..243bbf17 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -123,7 +123,7 @@ class ServiceConverter when 0 # public const int c_nErrorNo = 0 else - error_message = 'ErrorCode = ' + error_code.to_s # default value for the error message + error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message end raise error_message diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 2e436d1a..c1403c06 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -99,7 +99,7 @@ class TrackHelper end new_file_name = file_name - download_ext = '.' + file_data['filetype'] # get the extension of the downloaded file + download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension @@ -174,7 +174,7 @@ class TrackHelper return saved end - download_ext = '.' + file_data['filetype'] # get the extension of the downloaded file + download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file cur_ext = File.extname(file_name).downcase # get current file extension @@ -205,9 +205,9 @@ class TrackHelper if is_submit_form if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + '-form' + download_ext, user_address) # get the correct file name if it already exists + file_name = DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + '-form' + cur_ext, user_address) + file_name = DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else From 519f6d6f3209126c5f0a93c279bff614b48b99dc Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 15:54:50 +0300 Subject: [PATCH 031/176] ruby: Style/NilComparison correct --- .../ruby/app/controllers/home_controller.rb | 8 ++++---- .../ruby/app/models/document_helper.rb | 4 ++-- .../ruby/app/models/service_converter.rb | 6 +++--- .../ruby/app/models/track_helper.rb | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 6bd15d33..7be7789b 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -83,7 +83,7 @@ class HomeController < ApplicationController def convert begin file_data = request.body.read - return '' if file_data == nil || file_data.empty? + return '' if file_data.nil? || file_data.empty? body = JSON.parse(file_data) @@ -116,7 +116,7 @@ class HomeController < ApplicationController res = http.request(req) data = res.body - raise 'stream is null' if data == nil + raise 'stream is null' if data.nil? # write a file with a new extension, but with the content from the origin file File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| @@ -180,7 +180,7 @@ class HomeController < ApplicationController # tracking file changes def track file_data = TrackHelper.read_body(request) # read the request body - if file_data == nil || file_data.empty? + if file_data.nil? || file_data.empty? render plain: '{"error":1}' # an error occurs if the file is empty return end @@ -266,7 +266,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] isEmbedded = params[:dmode] - if JwtHelper.is_enabled && isEmbedded == nil && user_address != nil && JwtHelper.use_for_request + if JwtHelper.is_enabled && isEmbedded.nil? && user_address != nil && JwtHelper.use_for_request jwtHeader = HomeController.config_manager.jwt_header; if request.headers[jwtHeader] hdr = request.headers[jwtHeader] diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index e0080689..c1bea5a5 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -67,7 +67,7 @@ class DocumentHelper # get current user host address def cur_user_host_address(user_address) - (user_address == nil ? @@remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_'); + (user_address.nil? ? @@remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_'); end # get the storage path of the given file @@ -298,7 +298,7 @@ class DocumentHelper 'updated' => File.mtime(directory) } - if file_id == nil # if file id is undefined + if file_id.nil? # if file id is undefined result.push(info) # push info object to the response array else # if file id is defined if file_id.eql?(info['id']) # and it is equal to the document key value diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 243bbf17..d2c66ab7 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -29,11 +29,11 @@ class ServiceConverter class << self # get the url of the converted file def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) - from_ext = from_ext == nil ? File.extname(document_uri).downcase : from_ext # get the current document extension + from_ext = from_ext.nil? ? File.extname(document_uri).downcase : from_ext # get the current document extension # get the current document name or uuid title = File.basename(URI.parse(document_uri).path) - title = title == nil ? UUID.generate.to_s : title + title = title.nil? ? UUID.generate.to_s : title # get the document key document_revision_id = document_revision_id.empty? ? document_uri : document_revision_id @@ -149,7 +149,7 @@ class ServiceConverter file_url_element = file_result['fileUrl'] file_type_element = file_result['fileType'] - if file_url_element == nil # and the file url doesn't exist + if file_url_element.nil? # and the file url doesn't exist raise 'Invalid answer format' # get ann error message end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c1403c06..da26e923 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -35,7 +35,7 @@ class TrackHelper def read_body(request) body = request.body.read - return '' if body == nil || body.empty? + return '' if body.nil? || body.empty? file_data = JSON.parse(body) # parse file data @@ -108,7 +108,7 @@ class TrackHelper key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? + if new_file_uri.nil? || new_file_uri.empty? new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists else download_uri = new_file_uri @@ -185,7 +185,7 @@ class TrackHelper key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file - if new_file_uri == nil || new_file_uri.empty? + if new_file_uri.nil? || new_file_uri.empty? new_file_name = true else download_uri = new_file_uri @@ -286,7 +286,7 @@ class TrackHelper data = res.body # and take its body - raise 'stream is null' if data == nil + raise 'stream is null' if data.nil? data end From 52d72371d5856138f4a035ebda4723e132bff86f Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 15:58:46 +0300 Subject: [PATCH 032/176] ruby: Style/Semicolon correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- .../ruby/app/models/document_helper.rb | 6 +++--- web/documentserver-example/ruby/app/models/users.rb | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 7be7789b..921c66db 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -148,7 +148,7 @@ class HomeController < ApplicationController isEmbedded = params[:dmode] if JwtHelper.is_enabled && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header; + jwtHeader = HomeController.config_manager.jwt_header if request.headers[jwtHeader] hdr = request.headers[jwtHeader] hdr.slice!(0, 'Bearer '.length) @@ -267,7 +267,7 @@ class HomeController < ApplicationController isEmbedded = params[:dmode] if JwtHelper.is_enabled && isEmbedded.nil? && user_address != nil && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header; + jwtHeader = HomeController.config_manager.jwt_header if request.headers[jwtHeader] hdr = request.headers[jwtHeader] hdr.slice!(0, 'Bearer '.length) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index c1bea5a5..271765ac 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -67,7 +67,7 @@ class DocumentHelper # get current user host address def cur_user_host_address(user_address) - (user_address.nil? ? @@remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_'); + (user_address.nil? ? @@remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_') end # get the storage path of the given file @@ -158,7 +158,7 @@ class DocumentHelper def get_stored_files(user_address) directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) - arr = []; + arr = [] if Dir.exist?(directory) Dir.foreach(directory) { |e| # run through all the elements from the folder @@ -282,7 +282,7 @@ class DocumentHelper # get files information def get_files_info(file_id) - result = []; + result = [] for fileName in get_stored_files(nil) # run through all the stored files from the folder directory = storage_path(fileName, nil) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 17703e2e..3c5ed65c 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -45,7 +45,7 @@ class Users 'Can create files from templates using data from the editor', 'Can see the information about all users', 'Has an avatar', - ]; + ] @@descr_user_2 = [ 'Belongs to Group2', @@ -55,7 +55,7 @@ class Users 'Can create new files from the editor', 'Can see the information about users from Group2 and users who don’t belong to any group', 'Has an avatar', - ]; + ] @@descr_user_3 = [ 'Belongs to Group3', @@ -67,7 +67,7 @@ class Users 'Can’t print the file', 'Can create new files from the editor', 'Can see the information about Group2 users', - ]; + ] @@descr_user_0 = [ 'The name is requested when the editor is opened', @@ -82,7 +82,7 @@ class Users "Can't view chat", "Can't protect file", 'View file without collaboration' - ]; + ] @@users = [ User.new('uid-1', 'John Smith', 'smith@example.com', From f9375a74148b50bc93cb2d854fd79e4c7a8c5798 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 15:59:48 +0300 Subject: [PATCH 033/176] ruby: Style/SoleNestedConditional correct --- .../ruby/app/controllers/home_controller.rb | 4 +--- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- web/documentserver-example/ruby/app/models/file_model.rb | 4 +--- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 921c66db..3e87e5a2 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -190,14 +190,12 @@ class HomeController < ApplicationController user_address = params[:userAddress] file_name = File.basename(params[:fileName]) - if status == 1 # editing - if file_data['actions'][0]['type'] == 0 # finished edit + if status == 1 && (file_data['actions'][0]['type'] == 0) # finished edit user = file_data['actions'][0]['userid'] # get the user id if !file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end end - end if status == 2 || status == 3 # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 271765ac..746e921a 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -98,8 +98,8 @@ class DocumentHelper end directory = File.join(directory, File.basename(file_name)) # get the path to the given file - unless File.file?(directory) - return '' if !create + if !File.file?(directory) && !create + return '' end return directory.to_s diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 6de54e57..1d9731cb 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -215,8 +215,7 @@ class FileModel obj['key'] = cur_key obj['version'] = i - if (i == 1) # check if the version number is equal to 1 - if File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists + if (i == 1) && File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it cr_info = JSON.parse(file.read()) # parse the file content @@ -228,7 +227,6 @@ class FileModel } end end - end # get the history data from the previous file version and write key and url information about it dataObj['fileType'] = file_ext[1..file_ext.length] From b630764daf6dbaa43e41d3ca9d045b527eba2fea Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:02:59 +0300 Subject: [PATCH 034/176] ruby: Style/NegatedIf correct --- .../ruby/app/controllers/home_controller.rb | 8 ++++---- .../ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 3e87e5a2..d1d9bf1c 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -192,7 +192,7 @@ class HomeController < ApplicationController if status == 1 && (file_data['actions'][0]['type'] == 0) # finished edit user = file_data['actions'][0]['userid'] # get the user id - if !file_data['users'].index(user) + unless file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end end @@ -216,7 +216,7 @@ class HomeController < ApplicationController # removing a file def remove file_name = File.basename(params[:filename]) # get the file name - if !file_name # if it doesn't exist + unless file_name # if it doesn't exist render plain: '{"success":false}' # report that the operation is unsuccessful return end @@ -372,7 +372,7 @@ class HomeController < ApplicationController link = body['link'] if fileName.empty? and body.key?('link') - if !link.include?(DocumentHelper.get_server_url(false)) + unless link.include?(DocumentHelper.get_server_url(false)) data = { url: link, directUrl: link @@ -384,7 +384,7 @@ class HomeController < ApplicationController url_obj = URI(link) query_params = CGI.parse(url_obj.query) fileName = query_params['fileName'].first - if !File.exist?(DocumentHelper.storage_path(fileName, nil)) + unless File.exist?(DocumentHelper.storage_path(fileName, nil)) render plain: '{ "error": "File is not exist"}' return end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 746e921a..d7271077 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -122,7 +122,7 @@ class DocumentHelper # get the last file version def get_file_version(hist_dir) - return 1 if !Dir.exist?(hist_dir) + return 1 unless Dir.exist?(hist_dir) ver = 1 Dir.foreach(hist_dir) { |e| # run through all the file versions diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 1d9731cb..471f75af 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -349,7 +349,7 @@ class FileModel def get_users_info users_info = [] - if !@user.id.eql?('uid-0') + unless @user.id.eql?('uid-0') Users.get_all_users().each do |user_info| u = { id: user_info.id, From 21d75418c251eb25f8817ea7d52a6474933de826 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:03:32 +0300 Subject: [PATCH 035/176] ruby: Style/MultipleComparison correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index d1d9bf1c..6372fc3f 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -197,13 +197,13 @@ class HomeController < ApplicationController end end - if status == 2 || status == 3 # MustSave, Corrupted + if [2, 3].include?(status) # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file render plain: "{\"error\":#{saved.to_s}}" return end - if status == 6 || status == 7 # MustForceave, CorruptedForcesave + if [6, 7].include?(status) # MustForceave, CorruptedForcesave saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file render plain: "{\"error\":#{saved.to_s}}" return From 23193739f798e6e1672e84472973e45049136475 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:04:41 +0300 Subject: [PATCH 036/176] ruby: Style/NonNilCheck correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- .../ruby/app/models/service_converter.rb | 4 ++-- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 6372fc3f..e4949316 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -264,7 +264,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] isEmbedded = params[:dmode] - if JwtHelper.is_enabled && isEmbedded.nil? && user_address != nil && JwtHelper.use_for_request + if JwtHelper.is_enabled && isEmbedded.nil? && !user_address.nil? && JwtHelper.use_for_request jwtHeader = HomeController.config_manager.jwt_header if request.headers[jwtHeader] hdr = request.headers[jwtHeader] diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index d7271077..b0f1e463 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -308,7 +308,7 @@ class DocumentHelper end end - if file_id != nil + if !file_id.nil? return '"File not found"' else return result diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 471f75af..5d936718 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -379,6 +379,6 @@ class FileModel # get direct url existence flag def is_enable_direct_url - return @direct_url != nil && @direct_url == 'true' + return !@direct_url.nil? && @direct_url == 'true' end end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index d2c66ab7..a53a939a 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -134,7 +134,7 @@ class ServiceConverter file_result = json_data error_element = file_result['error'] - if error_element != nil # if an error occurs + if !error_element.nil? # if an error occurs process_convert_service_responce_error(error_element.to_i) # get an error message end @@ -161,7 +161,7 @@ class ServiceConverter percent_element = file_result['percent'] # get the percentage value - result_percent = percent_element.to_i if percent_element != nil + result_percent = percent_element.to_i if !percent_element.nil? result_percent = result_percent >= 100 ? 99 : result_percent diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index da26e923..097b7c37 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -241,7 +241,7 @@ class TrackHelper :key => key } - payload.merge!({ :meta => meta }) if (meta != nil) + payload.merge!({ :meta => meta }) if (!meta.nil?) data = nil begin diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 3c5ed65c..f5eda73f 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -124,7 +124,7 @@ class Users def get_users_for_mentions(id) # get a list of users with their names and emails for mentions usersData = [] for user in @@users do - usersData.push({ :name => user.name, :email => user.email }) if (!user.id.eql?(id) && user.name != nil && user.email != nil) + usersData.push({ :name => user.name, :email => user.email }) if (!user.id.eql?(id) && !user.name.nil? && !user.email.nil?) end return usersData end @@ -132,7 +132,7 @@ class Users def get_users_for_protect(id) # get a list of users with their id, names and emails for protect users_data = [] for user in @@users do - users_data.push({ id: user.id, name: user.name, email: user.email }) if (!user.id.eql?(id) && user.name != nil) + users_data.push({ id: user.id, name: user.name, email: user.email }) if (!user.id.eql?(id) && !user.name.nil?) end return users_data end From 1989c5f44d0095c87a7a3e2df6ca8665ca036229 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:05:53 +0300 Subject: [PATCH 037/176] ruby: Style/AccessorGrouping correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 3 +-- web/documentserver-example/ruby/app/models/track_helper.rb | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index b0f1e463..eeae3083 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -22,8 +22,7 @@ class DocumentHelper @format_manager = FormatManager.new class << self - attr_reader :config_manager - attr_reader :format_manager + attr_reader :config_manager, :format_manager end @@runtime_cache = {} diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 097b7c37..9759af98 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -24,8 +24,7 @@ class TrackHelper @proxy_manager = ProxyManager.new(config_manager: @config_manager) class << self - attr_reader :config_manager - attr_reader :proxy_manager + attr_reader :config_manager, :proxy_manager end @@document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s From e9b4fce50b67c14ec2fc9f1aa5e8b00037e3f69c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:06:55 +0300 Subject: [PATCH 038/176] ruby: Style/GuardClause correct --- .../ruby/app/models/document_helper.rb | 28 +++++++++---------- .../ruby/app/models/file_model.rb | 4 +-- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index eeae3083..7ea2b0a6 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -89,11 +89,11 @@ class DocumentHelper directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file unless File.directory?(directory) - if create + return '' unless create FileUtils.mkdir_p(directory) # create history directory if it doesn't exist - else - return '' # the history directory doesn't exist and we are not supposed to create it - end + + # the history directory doesn't exist and we are not supposed to create it + end directory = File.join(directory, File.basename(file_name)) # get the path to the given file @@ -223,11 +223,11 @@ class DocumentHelper # get server url def get_server_url(for_document_server) - if for_document_server && DocumentHelper.config_manager.example_uri - return DocumentHelper.config_manager.example_uri.to_s - else + return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri + + return @@base_url - end + end # get callback url @@ -307,19 +307,19 @@ class DocumentHelper end end - if !file_id.nil? - return '"File not found"' - else + return '"File not found"' if !file_id.nil? + + return result - end + end # enable ignore certificate def verify_ssl(file_uri, http) - if file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled + return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session - end + end end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 5d936718..22038f81 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -349,7 +349,7 @@ class FileModel def get_users_info users_info = [] - unless @user.id.eql?('uid-0') + return if @user.id.eql?('uid-0') Users.get_all_users().each do |user_info| u = { id: user_info.id, @@ -369,7 +369,7 @@ class FileModel users_info.push(u) end return users_info - end + end # get users data for protect From 3df552b4b274bd8a0dd2f99231394c6de318f115 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:08:14 +0300 Subject: [PATCH 039/176] ruby: Style/BlockDelimiters correct --- .../ruby/app/models/document_helper.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 7ea2b0a6..ff45ed5f 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -124,14 +124,14 @@ class DocumentHelper return 1 unless Dir.exist?(hist_dir) ver = 1 - Dir.foreach(hist_dir) { |e| # run through all the file versions + Dir.foreach(hist_dir) do |e| # run through all the file versions next if e.eql?('.') next if e.eql?('..') if File.directory?(File.join(hist_dir, e)) ver += 1 # and count them end - } + end return ver end @@ -160,13 +160,13 @@ class DocumentHelper arr = [] if Dir.exist?(directory) - Dir.foreach(directory) { |e| # run through all the elements from the folder + Dir.foreach(directory) do |e| # run through all the elements from the folder next if e.eql?('.') next if e.eql?('..') next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it arr.push(e) # push the file to the array - } + end end return arr From 81a43656b2d411aa07825f8bacbd0792b469b5e2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:08:52 +0300 Subject: [PATCH 040/176] ruby: Style/SelfAssignment correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index ff45ed5f..68ca003b 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -147,7 +147,7 @@ class DocumentHelper while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory name = "#{base_name} (#{index.to_s})#{ext.downcase}" # add an index after its base name - index = index + 1 + index += 1 end name From 3247a75318e173d4766d2256e73d70cbd4ebe74e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:09:49 +0300 Subject: [PATCH 041/176] ruby: Style/ConditionalAssignment correct --- .../ruby/app/models/document_helper.rb | 24 +++++++++---------- .../ruby/app/models/track_helper.rb | 8 +++---- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 68ca003b..7fb0fd65 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -248,16 +248,16 @@ class DocumentHelper # get internal file extension by its type def get_internal_extension(file_type) - case file_type + ext = case file_type when 'word' # .docx for word type - ext = '.docx' + '.docx' when 'cell' # .xlsx for cell type - ext = '.xlsx' + '.xlsx' when 'slide' # .pptx for slide type - ext = '.pptx' + '.pptx' else - ext = '.docx' # the default value is .docx - end + '.docx' # the default value is .docx + end ext end @@ -265,16 +265,16 @@ class DocumentHelper # get image url for templates def get_template_image_url(file_type) path = "#{get_server_url(true)}/assets/" - case file_type + full_path = case file_type when 'word' # for word type - full_path = "#{path}file_docx.svg" + "#{path}file_docx.svg" when 'cell' # .xlsx for cell type - full_path = "#{path}file_xlsx.svg" + "#{path}file_xlsx.svg" when 'slide' # .pptx for slide type - full_path = "#{path}file_pptx.svg" + "#{path}file_pptx.svg" else - full_path = "#{path}file_docx.svg" # the default value is .docx - end + "#{path}file_docx.svg" # the default value is .docx + end full_path end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 9759af98..0e3d2d2d 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -203,11 +203,11 @@ class TrackHelper is_submit_form = file_data['forcesavetype'].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) if is_submit_form - if new_file_name - file_name = DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists + file_name = if new_file_name + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else - file_name = DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) - end + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) + end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) if new_file_name From 5171624adc402153913dbd4dd27231d087dcc649 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:10:50 +0300 Subject: [PATCH 042/176] ruby: Style/IfInsideElse correct --- .../ruby/app/models/document_helper.rb | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 7fb0fd65..826aee30 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -299,11 +299,9 @@ class DocumentHelper if file_id.nil? # if file id is undefined result.push(info) # push info object to the response array - else # if file id is defined - if file_id.eql?(info['id']) # and it is equal to the document key value - result.push(info) # response object will be equal to the info object - return result - end + elsif file_id.eql?(info['id']) # if file id is defined + result.push(info) # response object will be equal to the info object + return result # and it is equal to the document key value end end From 9b010f8315042adad1eb245306a143066b6436f2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:11:23 +0300 Subject: [PATCH 043/176] ruby: Style/MethodCallWithoutArgsParentheses correct --- .../ruby/app/models/file_model.rb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 22038f81..6c2aa1c6 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -109,7 +109,7 @@ class FileModel ] config = { - :type => type(), + :type => type, :documentType => document_type, :document => { :title => @file_name, @@ -190,8 +190,8 @@ class FileModel def get_history file_name = @file_name file_ext = File.extname(file_name).downcase - doc_key = key() - doc_uri = file_uri() + doc_key = key + doc_uri = file_uri hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version @@ -209,7 +209,7 @@ class FileModel cur_key = doc_key if (i != cur_ver) File.open(File.join(ver_dir, 'key.txt'), 'r') do |file| - cur_key = file.read() + cur_key = file.read end end obj['key'] = cur_key @@ -217,7 +217,7 @@ class FileModel if (i == 1) && File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it - cr_info = JSON.parse(file.read()) # parse the file content + cr_info = JSON.parse(file.read) # parse the file content # write information about changes to the object obj['created'] = cr_info['created'] @@ -241,7 +241,7 @@ class FileModel changes = nil change = nil File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| # get the path to the changes.json file - changes = JSON.parse(file.read()) # and parse its content + changes = JSON.parse(file.read) # and parse its content end change = changes['changes'][0] @@ -350,7 +350,7 @@ class FileModel def get_users_info users_info = [] return if @user.id.eql?('uid-0') - Users.get_all_users().each do |user_info| + Users.get_all_users.each do |user_info| u = { id: user_info.id, name: user_info.name, From f3cfdc353ed435e31fd98e1f255cdb1ea8bc1107 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:11:54 +0300 Subject: [PATCH 044/176] ruby: Style/MultilineTernaryOperator correct --- .../ruby/app/models/file_model.rb | 50 +++++++++++++++---- 1 file changed, 40 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 6c2aa1c6..1a1e9961 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -148,10 +148,14 @@ class FileModel :mode => mode, :lang => @lang ? @lang : 'en', :callbackUrl => callback_url, # absolute URL to the document storage service - :coEditing => editorsmode.eql?('view') && @user.id.eql?('uid-0') ? { + :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') + { :mode => 'strict', :change => false - } : nil, + } +else + nil +end, :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, :templates => @user.templates ? templates : nil, :user => { # the user currently viewing or editing the document @@ -253,16 +257,21 @@ class FileModel obj['user'] = change ? change['user'] : nil prev = histData[(i - 2).to_s] # get the history data from the previous file version - dataObj['previous'] = is_enable_direct_url == true ? { # write key and url information about previous file version with optional direct url + # write key and url information about previous file version with optional direct url +dataObj['previous'] = if is_enable_direct_url == true + { # write key and url information about previous file version with optional direct url :fileType => prev['fileType'], :key => prev['key'], :url => prev['url'], :directUrl => prev['directUrl'] - } : { + } +else + { :fileType => prev['fileType'], :key => prev['key'], :url => prev['url'] } +end # write the path to the diff.zip archive with differences in this file version dataObj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') @@ -290,14 +299,21 @@ class FileModel # get image information def get_insert_image - insert_image = is_enable_direct_url == true ? { + # image file type +# server url to the image +# direct url to the image +insert_image = if is_enable_direct_url == true + { :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image - } : { + } +else + { :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image } +end if JwtHelper.is_enabled # check if a secret key to generate token exists or not insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object @@ -308,14 +324,21 @@ class FileModel # get compared file information def dataDocument - compare_file = is_enable_direct_url == true ? { + # file type +# server url to the compared file +# direct url to the compared file +compare_file = if is_enable_direct_url == true + { :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file - } : { + } +else + { :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file } +end if JwtHelper.is_enabled # check if a secret key to generate token exists or not compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object @@ -326,14 +349,21 @@ class FileModel # get mail merge recipients information def dataSpreadsheet - dataSpreadsheet = is_enable_direct_url == true ? { + # file type +# server url to the mail merge recipients file +# direct url to the mail merge recipients file +dataSpreadsheet = if is_enable_direct_url == true + { :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file - } : { + } +else + { :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file } +end if JwtHelper.is_enabled # check if a secret key to generate token exists or not dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object From c350dd022fc52d82979293cd5beacca31ba804bd Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:12:30 +0300 Subject: [PATCH 045/176] ruby: Style/TrailingCommaInHashLiteral correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 1a1e9961..b79f467d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -178,7 +178,7 @@ end, :submitForm => submitForm, # the Submit form button state :goback => { :url => DocumentHelper.get_server_url(false) - }, + } } } } From bd922d202e635f29baa40feef0944ff9b6fe337d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:13:10 +0300 Subject: [PATCH 046/176] ruby: Style/ParenthesesAroundCondition correct --- web/documentserver-example/ruby/app/models/file_model.rb | 6 +++--- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index b79f467d..a5898677 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -200,7 +200,7 @@ end, hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version - if (cur_ver > 0) # if file was modified + if cur_ver > 0 # if file was modified hist = [] histData = {} @@ -211,7 +211,7 @@ end, # get document key cur_key = doc_key - if (i != cur_ver) + if i != cur_ver File.open(File.join(ver_dir, 'key.txt'), 'r') do |file| cur_key = file.read end @@ -241,7 +241,7 @@ end, end dataObj['version'] = i - if (i > 1) # check if the version number is greater than 1 + if i > 1 # check if the version number is greater than 1 changes = nil change = nil File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| # get the path to the changes.json file diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 0e3d2d2d..4679d4b1 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -240,7 +240,7 @@ class TrackHelper :key => key } - payload.merge!({ :meta => meta }) if (!meta.nil?) + payload.merge!({ :meta => meta }) if !meta.nil? data = nil begin diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index f5eda73f..0064e95e 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -124,7 +124,7 @@ class Users def get_users_for_mentions(id) # get a list of users with their names and emails for mentions usersData = [] for user in @@users do - usersData.push({ :name => user.name, :email => user.email }) if (!user.id.eql?(id) && !user.name.nil? && !user.email.nil?) + usersData.push({ :name => user.name, :email => user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end return usersData end @@ -132,7 +132,7 @@ class Users def get_users_for_protect(id) # get a list of users with their id, names and emails for protect users_data = [] for user in @@users do - users_data.push({ id: user.id, name: user.name, email: user.email }) if (!user.id.eql?(id) && !user.name.nil?) + users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? end return users_data end From 26fc316cee8b731c1b941adb06f7e8b31d49e806 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:15:09 +0300 Subject: [PATCH 047/176] ruby: Style/OrAssignment correct --- web/documentserver-example/ruby/app/models/track_helper.rb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 4679d4b1..c78eca5c 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -138,9 +138,7 @@ class TrackHelper save_file(change_data, File.join(ver_dir, 'diff.zip')) # save file with document versions differences hist_data = file_data['changeshistory'] - unless hist_data # if there are no changes in the history - hist_data = file_data['history'].to_json # write the original history information to the history data - end + hist_data ||= file_data['history'].to_json if hist_data File.open(File.join(ver_dir, 'changes.json'), 'wb') do |file| # open the file with document changes file.write(hist_data) # and write history data to this file From 7d6933803f5c3cdf4cecbae09370dbeee7957773 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:17:39 +0300 Subject: [PATCH 048/176] ruby: Style/TrailingCommaInArrayLiteral correct --- web/documentserver-example/ruby/app/models/users.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 0064e95e..5e8f2c61 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -44,7 +44,7 @@ class Users 'The file favorite state is undefined', 'Can create files from templates using data from the editor', 'Can see the information about all users', - 'Has an avatar', + 'Has an avatar' ] @@descr_user_2 = [ @@ -54,7 +54,7 @@ class Users 'This file is marked as favorite', 'Can create new files from the editor', 'Can see the information about users from Group2 and users who don’t belong to any group', - 'Has an avatar', + 'Has an avatar' ] @@descr_user_3 = [ @@ -66,7 +66,7 @@ class Users 'Can’t download the file', 'Can’t print the file', 'Can create new files from the editor', - 'Can see the information about Group2 users', + 'Can see the information about Group2 users' ] @@descr_user_0 = [ From dd3b7ab07755d20903c18bfeff2fb2bc8d05c95a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:18:25 +0300 Subject: [PATCH 049/176] ruby: Style/WordArray correct --- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 5e8f2c61..c3558f97 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -98,12 +98,12 @@ class Users true, [], @@descr_user_2, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { - :view => ['group-3', 'group-2'], + :view => %w[group-3 group-2], :edit => ['group-2'], :remove => [] }, ['group-2'], - false, ['copy', 'download', 'print'], @@descr_user_3, false, false), + false, %w[copy download print], @@descr_user_3, false, false), User.new('uid-0', nil, nil, '', nil, {}, [], nil, ['protect'], @@descr_user_0, false, false) From d06bb98a6120d47e679c1e5947f02234d0d37b1a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:18:58 +0300 Subject: [PATCH 050/176] ruby: Style/DefWithParentheses correct --- web/documentserver-example/ruby/app/models/users.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index c3558f97..83074636 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -110,7 +110,7 @@ class Users ] class << self - def get_all_users() # get a list of all the users + def get_all_users # get a list of all the users @@users end From c0d8e0e339215d988d172c9fe7a232c71b140616 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:52:29 +0300 Subject: [PATCH 051/176] ruby: Layout/IndentationWidth correct --- .../ruby/app/controllers/home_controller.rb | 2 +- .../ruby/app/models/document_helper.rb | 16 +-- .../ruby/app/models/file_model.rb | 110 +++++++++--------- .../ruby/app/models/service_converter.rb | 18 +-- .../ruby/app/models/track_helper.rb | 2 +- 5 files changed, 74 insertions(+), 74 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index e4949316..9c7c6b9a 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -191,7 +191,7 @@ class HomeController < ApplicationController file_name = File.basename(params[:fileName]) if status == 1 && (file_data['actions'][0]['type'] == 0) # finished edit - user = file_data['actions'][0]['userid'] # get the user id + user = file_data['actions'][0]['userid'] # get the user id unless file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 826aee30..58514a94 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -250,13 +250,13 @@ class DocumentHelper def get_internal_extension(file_type) ext = case file_type when 'word' # .docx for word type - '.docx' + '.docx' when 'cell' # .xlsx for cell type - '.xlsx' + '.xlsx' when 'slide' # .pptx for slide type - '.pptx' + '.pptx' else - '.docx' # the default value is .docx + '.docx' # the default value is .docx end ext @@ -267,13 +267,13 @@ class DocumentHelper path = "#{get_server_url(true)}/assets/" full_path = case file_type when 'word' # for word type - "#{path}file_docx.svg" + "#{path}file_docx.svg" when 'cell' # .xlsx for cell type - "#{path}file_xlsx.svg" + "#{path}file_xlsx.svg" when 'slide' # .pptx for slide type - "#{path}file_pptx.svg" + "#{path}file_pptx.svg" else - "#{path}file_docx.svg" # the default value is .docx + "#{path}file_docx.svg" # the default value is .docx end full_path diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index a5898677..8fe62f0f 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -149,10 +149,10 @@ class FileModel :lang => @lang ? @lang : 'en', :callbackUrl => callback_url, # absolute URL to the document storage service :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') - { - :mode => 'strict', - :change => false - } + { + :mode => 'strict', + :change => false + } else nil end, @@ -220,16 +220,16 @@ end, obj['version'] = i if (i == 1) && File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists - File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it - cr_info = JSON.parse(file.read) # parse the file content + File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it + cr_info = JSON.parse(file.read) # parse the file content - # write information about changes to the object - obj['created'] = cr_info['created'] - obj['user'] = { - :id => cr_info['uid'], - :name => cr_info['uname'] - } - end + # write information about changes to the object + obj['created'] = cr_info['created'] + obj['user'] = { + :id => cr_info['uid'], + :name => cr_info['uname'] + } + end end # get the history data from the previous file version and write key and url information about it @@ -259,12 +259,12 @@ end, prev = histData[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true - { # write key and url information about previous file version with optional direct url - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'], - :directUrl => prev['directUrl'] - } + { # write key and url information about previous file version with optional direct url + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'], + :directUrl => prev['directUrl'] + } else { :fileType => prev['fileType'], @@ -302,18 +302,18 @@ end # image file type # server url to the image # direct url to the image -insert_image = if is_enable_direct_url == true - { - :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image - :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image - } -else - { - :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image - } -end + insert_image = if is_enable_direct_url == true + { + :fileType => 'png', # image file type + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image + :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image + } + else + { + :fileType => 'png', # image file type + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image + } + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object @@ -327,18 +327,18 @@ end # file type # server url to the compared file # direct url to the compared file -compare_file = if is_enable_direct_url == true - { - :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file - :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file - } -else - { - :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file - } -end + compare_file = if is_enable_direct_url == true + { + :fileType => 'docx', # file type + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file + :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file + } + else + { + :fileType => 'docx', # file type + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file + } + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object @@ -352,18 +352,18 @@ end # file type # server url to the mail merge recipients file # direct url to the mail merge recipients file -dataSpreadsheet = if is_enable_direct_url == true - { - :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file - :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file - } -else - { - :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file - } -end + dataSpreadsheet = if is_enable_direct_url == true + { + :fileType => 'csv', # file type + :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file + :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file + } + else + { + :fileType => 'csv', # file type + :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file + } + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index a53a939a..18f6b499 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -105,25 +105,25 @@ class ServiceConverter # add an error message to the error message template depending on the error code case error_code when -8 - error_message = 'Error occurred in the ConvertService.ashx: Error document VKey' + error_message = 'Error occurred in the ConvertService.ashx: Error document VKey' when -7 - error_message = 'Error occurred in the ConvertService.ashx: Error document request' + error_message = 'Error occurred in the ConvertService.ashx: Error document request' when -6 - error_message = 'Error occurred in the ConvertService.ashx: Error database' + error_message = 'Error occurred in the ConvertService.ashx: Error database' when -5 - error_message = 'Error occurred in the ConvertService.ashx: Incorrect password' + error_message = 'Error occurred in the ConvertService.ashx: Incorrect password' when -4 - error_message = 'Error occurred in the ConvertService.ashx: Error download error' + error_message = 'Error occurred in the ConvertService.ashx: Error download error' when -3 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation error' + error_message = 'Error occurred in the ConvertService.ashx: Error convertation error' when -2 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation timeout' + error_message = 'Error occurred in the ConvertService.ashx: Error convertation timeout' when -1 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' + error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' when 0 # public const int c_nErrorNo = 0 else - error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message + error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message end raise error_message diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c78eca5c..a72041ab 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -202,7 +202,7 @@ class TrackHelper if is_submit_form file_name = if new_file_name - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end From 42c2c93e8111e99830ab5c00babd0862098fc322 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:53:34 +0300 Subject: [PATCH 052/176] ruby: Layout/EndAlignment correct --- .../ruby/app/controllers/home_controller.rb | 2 +- .../ruby/app/models/file_model.rb | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 9c7c6b9a..1fe090c5 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -195,7 +195,7 @@ class HomeController < ApplicationController unless file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end - end + end if [2, 3].include?(status) # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 8fe62f0f..5c5f1b7f 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -155,7 +155,7 @@ class FileModel } else nil -end, + end, :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, :templates => @user.templates ? templates : nil, :user => { # the user currently viewing or editing the document @@ -230,7 +230,7 @@ end, :name => cr_info['uname'] } end - end + end # get the history data from the previous file version and write key and url information about it dataObj['fileType'] = file_ext[1..file_ext.length] @@ -271,7 +271,7 @@ else :key => prev['key'], :url => prev['url'] } -end + end # write the path to the diff.zip archive with differences in this file version dataObj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') @@ -313,7 +313,7 @@ end :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image } - end + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object @@ -338,7 +338,7 @@ end :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file } - end + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object @@ -363,7 +363,7 @@ end :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file } - end + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object From 97478679356a22ebf9cc7b12d8af9c3bf57c2665 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:54:06 +0300 Subject: [PATCH 053/176] ruby: Layout/CommentIndentation correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- .../ruby/app/models/document_helper.rb | 2 +- .../ruby/app/models/file_model.rb | 14 +++++++------- .../ruby/app/models/jwt_helper.rb | 12 ++++++------ .../ruby/app/models/track_helper.rb | 18 +++++++++--------- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 1fe090c5..fa50be5f 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -336,7 +336,7 @@ class HomeController < ApplicationController end end - # Rename... + # Rename... def rename body = JSON.parse(request.body.read) dockey = body['dockey'] @@ -354,7 +354,7 @@ class HomeController < ApplicationController render plain: "{ \"result\" : \"#{JSON.dump(json_data)}\"}" end - # ReferenceData + # ReferenceData def reference body = JSON.parse(request.body.read) fileName = '' diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 58514a94..6024ffae 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -92,7 +92,7 @@ class DocumentHelper return '' unless create FileUtils.mkdir_p(directory) # create history directory if it doesn't exist - # the history directory doesn't exist and we are not supposed to create it + # the history directory doesn't exist and we are not supposed to create it end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 5c5f1b7f..fb27ce92 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -257,7 +257,7 @@ else obj['user'] = change ? change['user'] : nil prev = histData[(i - 2).to_s] # get the history data from the previous file version - # write key and url information about previous file version with optional direct url +# write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true { # write key and url information about previous file version with optional direct url :fileType => prev['fileType'], @@ -300,8 +300,8 @@ else # get image information def get_insert_image # image file type -# server url to the image -# direct url to the image + # server url to the image + # direct url to the image insert_image = if is_enable_direct_url == true { :fileType => 'png', # image file type @@ -325,8 +325,8 @@ else # get compared file information def dataDocument # file type -# server url to the compared file -# direct url to the compared file + # server url to the compared file + # direct url to the compared file compare_file = if is_enable_direct_url == true { :fileType => 'docx', # file type @@ -350,8 +350,8 @@ else # get mail merge recipients information def dataSpreadsheet # file type -# server url to the mail merge recipients file -# direct url to the mail merge recipients file + # server url to the mail merge recipients file + # direct url to the mail merge recipients file dataSpreadsheet = if is_enable_direct_url == true { :fileType => 'csv', # file type diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 6951c6ce..d50090c7 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -22,30 +22,30 @@ class JwtHelper @token_use_for_request = ConfigurationManager.new.jwt_use_for_request class << self - # check if a secret key to generate token exists or not + # check if a secret key to generate token exists or not def is_enabled return @jwt_secret && !@jwt_secret.empty? ? true : false end - # check if a secret key used for request + # check if a secret key used for request def use_for_request return @token_use_for_request end - # encode a payload object into a token using a secret key + # encode a payload object into a token using a secret key def encode(payload) return JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token end - # decode a token into a payload object using a secret key + # decode a token into a payload object using a secret key def decode(token) begin decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } rescue return '' end - # decoded = Array [ {"data"=>"test"}, # payload - # {"alg"=>"HS256"} # header ] + # decoded = Array [ {"data"=>"test"}, # payload + # {"alg"=>"HS256"} # header ] return decoded[0].to_json # get json payload end end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index a72041ab..d5ab0d6b 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -30,7 +30,7 @@ class TrackHelper @@document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s class << self - # read the request body + # read the request body def read_body(request) body = request.body.read @@ -38,7 +38,7 @@ class TrackHelper file_data = JSON.parse(body) # parse file data - # check if a secret key to generate token exists or not + # check if a secret key to generate token exists or not if JwtHelper.is_enabled && JwtHelper.use_for_request inHeader = false token = nil @@ -87,7 +87,7 @@ class TrackHelper copied end - # file saving process + # file saving process def process_save(raw_file_data, file_name, user_address) file_data = resolve_process_save_body(raw_file_data) @@ -102,7 +102,7 @@ class TrackHelper cur_ext = File.extname(file_name).downcase # get current file extension - # convert downloaded file to the file with the current extension if these extensions aren't equal + # convert downloaded file to the file with the current extension if these extensions aren't equal unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin @@ -163,7 +163,7 @@ class TrackHelper saved end - # file force saving process + # file force saving process def process_force_save(file_data, file_name, user_address) download_uri = file_data['url'] if download_uri.eql?(nil) @@ -177,7 +177,7 @@ class TrackHelper new_file_name = false - # convert downloaded file to the file with the current extension if these extensions aren't equal + # convert downloaded file to the file with the current extension if these extensions aren't equal unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin @@ -230,9 +230,9 @@ class TrackHelper saved end - # send the command request + # send the command request def command_request(method, key, meta = nil) - # create a payload object with the method and key + # create a payload object with the method and key payload = { :c => method, :key => key @@ -267,7 +267,7 @@ class TrackHelper return json_data end - # save file from the url + # save file from the url def download_file(uristr) uri = URI.parse(uristr) # parse the url string http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server From 6ff7b4fa8f8be66682dec0eb202d74ac500e5803 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:56:34 +0300 Subject: [PATCH 054/176] ruby: Layout/EmptyLines correct --- .../ruby/app/controllers/home_controller.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index fa50be5f..1fd3a0c1 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -359,7 +359,6 @@ class HomeController < ApplicationController body = JSON.parse(request.body.read) fileName = '' - if body.key?('referenceData') referenceData = body['referenceData'] instanceId = referenceData['instanceId'] From 8527ac602f315bc0f215ff5d9ce4d153a1fee4dc Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:57:05 +0300 Subject: [PATCH 055/176] ruby: Layout/EmptyLineAfterGuardClause correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 ++ web/documentserver-example/ruby/app/models/file_model.rb | 1 + 2 files changed, 3 insertions(+) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 6024ffae..41b9a5e8 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -90,6 +90,7 @@ class DocumentHelper directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file unless File.directory?(directory) return '' unless create + FileUtils.mkdir_p(directory) # create history directory if it doesn't exist # the history directory doesn't exist and we are not supposed to create it @@ -315,6 +316,7 @@ class DocumentHelper # enable ignore certificate def verify_ssl(file_uri, http) return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled + http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index fb27ce92..3369a6bf 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -380,6 +380,7 @@ else def get_users_info users_info = [] return if @user.id.eql?('uid-0') + Users.get_all_users.each do |user_info| u = { id: user_info.id, From 5259cc19fa0e75184882ba97ead7ecd6ed9ba89e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:57:29 +0300 Subject: [PATCH 056/176] ruby: Layout/IndentationConsistency correct --- .../ruby/app/controllers/home_controller.rb | 6 +- .../ruby/app/models/document_helper.rb | 12 ++-- .../ruby/app/models/file_model.rb | 66 +++++++++---------- 3 files changed, 42 insertions(+), 42 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 1fd3a0c1..caa8354d 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -192,9 +192,9 @@ class HomeController < ApplicationController if status == 1 && (file_data['actions'][0]['type'] == 0) # finished edit user = file_data['actions'][0]['userid'] # get the user id - unless file_data['users'].index(user) - json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command - end + unless file_data['users'].index(user) + json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command + end end if [2, 3].include?(status) # MustSave, Corrupted diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 41b9a5e8..256696bf 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -91,7 +91,7 @@ class DocumentHelper unless File.directory?(directory) return '' unless create - FileUtils.mkdir_p(directory) # create history directory if it doesn't exist + FileUtils.mkdir_p(directory) # create history directory if it doesn't exist # the history directory doesn't exist and we are not supposed to create it @@ -227,7 +227,7 @@ class DocumentHelper return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - return @@base_url + return @@base_url end @@ -302,14 +302,14 @@ class DocumentHelper result.push(info) # push info object to the response array elsif file_id.eql?(info['id']) # if file id is defined result.push(info) # response object will be equal to the info object - return result # and it is equal to the document key value + return result # and it is equal to the document key value end end return '"File not found"' if !file_id.nil? - return result + return result end @@ -317,8 +317,8 @@ class DocumentHelper def verify_ssl(file_uri, http) return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled - http.use_ssl = true - http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session + http.use_ssl = true + http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 3369a6bf..e26a7da5 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -258,20 +258,20 @@ else prev = histData[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url -dataObj['previous'] = if is_enable_direct_url == true - { # write key and url information about previous file version with optional direct url - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'], - :directUrl => prev['directUrl'] - } -else - { - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'] - } - end + dataObj['previous'] = if is_enable_direct_url == true + { # write key and url information about previous file version with optional direct url + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'], + :directUrl => prev['directUrl'] + } + else + { + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'] + } + end # write the path to the diff.zip archive with differences in this file version dataObj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') @@ -381,25 +381,25 @@ else users_info = [] return if @user.id.eql?('uid-0') - Users.get_all_users.each do |user_info| - u = { - id: user_info.id, - name: user_info.name, - email: user_info.email, - group: user_info.group, - reviewGroups: user_info.reviewGroups, - commentGroups: user_info.commentGroups, - userInfoGroups: user_info.userInfoGroups, - favorite: user_info.favorite, - deniedPermissions: user_info.deniedPermissions, - descriptions: user_info.descriptions, - templates: user_info.templates, - avatar: user_info.avatar - } - u['image'] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil - users_info.push(u) - end - return users_info + Users.get_all_users.each do |user_info| + u = { + id: user_info.id, + name: user_info.name, + email: user_info.email, + group: user_info.group, + reviewGroups: user_info.reviewGroups, + commentGroups: user_info.commentGroups, + userInfoGroups: user_info.userInfoGroups, + favorite: user_info.favorite, + deniedPermissions: user_info.deniedPermissions, + descriptions: user_info.descriptions, + templates: user_info.templates, + avatar: user_info.avatar + } + u['image'] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil + users_info.push(u) + end + return users_info end From dccc970fa16baaedd949a06d43a97b10985684f7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:58:00 +0300 Subject: [PATCH 057/176] ruby: Layout/TrailingWhitespace correct --- .../ruby/app/models/document_helper.rb | 18 +++++++++--------- .../ruby/app/models/file_model.rb | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 256696bf..64fa559a 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -92,9 +92,9 @@ class DocumentHelper return '' unless create FileUtils.mkdir_p(directory) # create history directory if it doesn't exist - + # the history directory doesn't exist and we are not supposed to create it - + end directory = File.join(directory, File.basename(file_name)) # get the path to the given file @@ -225,10 +225,10 @@ class DocumentHelper # get server url def get_server_url(for_document_server) return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - - + + return @@base_url - + end # get callback url @@ -307,10 +307,10 @@ class DocumentHelper end return '"File not found"' if !file_id.nil? - - + + return result - + end # enable ignore certificate @@ -319,7 +319,7 @@ class DocumentHelper http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session - + end end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index e26a7da5..5c368705 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -400,7 +400,7 @@ else users_info.push(u) end return users_info - + end # get users data for protect From de5fc508f2d2b3590a2d84b8370500b09ebc4ab2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:58:24 +0300 Subject: [PATCH 058/176] ruby: Layout/CaseIndentation correct --- .../ruby/app/models/document_helper.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 64fa559a..847c4dda 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -250,11 +250,11 @@ class DocumentHelper # get internal file extension by its type def get_internal_extension(file_type) ext = case file_type - when 'word' # .docx for word type + when 'word' # .docx for word type '.docx' - when 'cell' # .xlsx for cell type + when 'cell' # .xlsx for cell type '.xlsx' - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type '.pptx' else '.docx' # the default value is .docx @@ -267,11 +267,11 @@ class DocumentHelper def get_template_image_url(file_type) path = "#{get_server_url(true)}/assets/" full_path = case file_type - when 'word' # for word type + when 'word' # for word type "#{path}file_docx.svg" - when 'cell' # .xlsx for cell type + when 'cell' # .xlsx for cell type "#{path}file_xlsx.svg" - when 'slide' # .pptx for slide type + when 'slide' # .pptx for slide type "#{path}file_pptx.svg" else "#{path}file_docx.svg" # the default value is .docx From 27267e2d5bedc8a8fd85b35560e63ba594cf0cc3 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:58:59 +0300 Subject: [PATCH 059/176] ruby: Layout/ElseAlignment correct --- .../ruby/app/models/document_helper.rb | 4 ++-- .../ruby/app/models/file_model.rb | 10 +++++----- .../ruby/app/models/service_converter.rb | 2 +- .../ruby/app/models/track_helper.rb | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 847c4dda..4db34c64 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -256,7 +256,7 @@ class DocumentHelper '.xlsx' when 'slide' # .pptx for slide type '.pptx' - else + else '.docx' # the default value is .docx end @@ -273,7 +273,7 @@ class DocumentHelper "#{path}file_xlsx.svg" when 'slide' # .pptx for slide type "#{path}file_pptx.svg" - else + else "#{path}file_docx.svg" # the default value is .docx end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 5c368705..6645ab82 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -153,7 +153,7 @@ class FileModel :mode => 'strict', :change => false } -else + else nil end, :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, @@ -265,7 +265,7 @@ else :url => prev['url'], :directUrl => prev['directUrl'] } - else + else { :fileType => prev['fileType'], :key => prev['key'], @@ -308,7 +308,7 @@ else :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image } - else + else { :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image @@ -333,7 +333,7 @@ else :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file } - else + else { :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file @@ -358,7 +358,7 @@ else :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file } - else + else { :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 18f6b499..c325b3be 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -122,7 +122,7 @@ class ServiceConverter error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' when 0 # public const int c_nErrorNo = 0 - else + else error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index d5ab0d6b..83e32577 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -203,7 +203,7 @@ class TrackHelper if is_submit_form file_name = if new_file_name DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists - else + else DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file From 79b98bed53cd4912141814321d13ac544cc29ab0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 16:59:24 +0300 Subject: [PATCH 060/176] ruby: Layout/FirstHashElementIndentation correct --- .../ruby/app/models/file_model.rb | 36 +++++++++---------- .../ruby/app/models/users.rb | 8 ++--- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 6645ab82..4ff4c56a 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -150,9 +150,9 @@ class FileModel :callbackUrl => callback_url, # absolute URL to the document storage service :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') { - :mode => 'strict', + :mode => 'strict', :change => false - } + } else nil end, @@ -260,17 +260,17 @@ class FileModel # write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true { # write key and url information about previous file version with optional direct url - :fileType => prev['fileType'], + :fileType => prev['fileType'], :key => prev['key'], :url => prev['url'], :directUrl => prev['directUrl'] - } + } else { - :fileType => prev['fileType'], + :fileType => prev['fileType'], :key => prev['key'], :url => prev['url'] - } + } end # write the path to the diff.zip archive with differences in this file version @@ -304,15 +304,15 @@ class FileModel # direct url to the image insert_image = if is_enable_direct_url == true { - :fileType => 'png', # image file type + :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image - } + } else { - :fileType => 'png', # image file type + :fileType => 'png', # image file type :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image - } + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -329,15 +329,15 @@ class FileModel # direct url to the compared file compare_file = if is_enable_direct_url == true { - :fileType => 'docx', # file type + :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file - } + } else { - :fileType => 'docx', # file type + :fileType => 'docx', # file type :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file - } + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -354,15 +354,15 @@ class FileModel # direct url to the mail merge recipients file dataSpreadsheet = if is_enable_direct_url == true { - :fileType => 'csv', # file type + :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file - } + } else { - :fileType => 'csv', # file type + :fileType => 'csv', # file type :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file - } + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 83074636..d11934c6 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -90,18 +90,18 @@ class Users nil, [], @@descr_user_1, true, true), User.new('uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', ['group-2', ''], { - :view => '', + :view => '', :edit => ['group-2', ''], :remove => ['group-2'] - }, + }, ['group-2', ''], true, [], @@descr_user_2, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { - :view => %w[group-3 group-2], + :view => %w[group-3 group-2], :edit => ['group-2'], :remove => [] - }, + }, ['group-2'], false, %w[copy download print], @@descr_user_3, false, false), User.new('uid-0', nil, nil, From a17819efb22625533a5b90e3e9a92e725c8c2a37 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:03:09 +0300 Subject: [PATCH 061/176] ruby: Layout/RescueEnsureAlignment correct --- .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/track_helper.rb | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index d50090c7..d206d5fb 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -41,7 +41,7 @@ class JwtHelper def decode(token) begin decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } - rescue + rescue return '' end # decoded = Array [ {"data"=>"test"}, # payload diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 83e32577..a287aa90 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -112,7 +112,7 @@ class TrackHelper else download_uri = new_file_uri end - rescue StandardError => msg + rescue StandardError => msg new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) end end @@ -156,7 +156,7 @@ class TrackHelper end saved = 0 - rescue StandardError => msg + rescue StandardError => msg saved = 1 end @@ -187,7 +187,7 @@ class TrackHelper else download_uri = new_file_uri end - rescue StandardError => msg + rescue StandardError => msg new_file_name = true end end @@ -223,7 +223,7 @@ class TrackHelper end saved = 0 - rescue StandardError => msg + rescue StandardError => msg saved = 1 end @@ -259,7 +259,7 @@ class TrackHelper req.body = payload.to_json # convert the payload object into the json format res = http.request(req) # get the response data = res.body # and take its body - rescue => ex + rescue => ex raise ex.message end From d1b972fb1826abc2c06ab4d403c1779f8b242611 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:03:44 +0300 Subject: [PATCH 062/176] ruby: Layout/HashAlignment correct --- .../ruby/app/models/file_model.rb | 30 +++++++++---------- .../ruby/app/models/track_helper.rb | 2 +- .../ruby/app/models/users.rb | 8 ++--- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 4ff4c56a..bac88328 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -151,7 +151,7 @@ class FileModel :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') { :mode => 'strict', - :change => false + :change => false } else nil @@ -261,15 +261,15 @@ class FileModel dataObj['previous'] = if is_enable_direct_url == true { # write key and url information about previous file version with optional direct url :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'], - :directUrl => prev['directUrl'] + :key => prev['key'], + :url => prev['url'], + :directUrl => prev['directUrl'] } else { :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'] + :key => prev['key'], + :url => prev['url'] } end @@ -305,13 +305,13 @@ class FileModel insert_image = if is_enable_direct_url == true { :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image - :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image + :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image } else { :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image } end @@ -330,13 +330,13 @@ class FileModel compare_file = if is_enable_direct_url == true { :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file - :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file + :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file } else { :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file } end @@ -355,13 +355,13 @@ class FileModel dataSpreadsheet = if is_enable_direct_url == true { :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file - :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file + :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file + :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file } else { :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file + :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file } end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index a287aa90..27113902 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -235,7 +235,7 @@ class TrackHelper # create a payload object with the method and key payload = { :c => method, - :key => key + :key => key } payload.merge!({ :meta => meta }) if !meta.nil? diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index d11934c6..480cd6bc 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -91,16 +91,16 @@ class Users User.new('uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', ['group-2', ''], { :view => '', - :edit => ['group-2', ''], - :remove => ['group-2'] + :edit => ['group-2', ''], + :remove => ['group-2'] }, ['group-2', ''], true, [], @@descr_user_2, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { :view => %w[group-3 group-2], - :edit => ['group-2'], - :remove => [] + :edit => ['group-2'], + :remove => [] }, ['group-2'], false, %w[copy download print], @@descr_user_3, false, false), From bb4e2b3b465f83f863abb9cb6df4eee57271edb0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:04:08 +0300 Subject: [PATCH 063/176] ruby: Layout/ExtraSpacing correct --- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 27113902..59ce970a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -276,7 +276,7 @@ class TrackHelper DocumentHelper.verify_ssl(uristr, http) req = Net::HTTP::Get.new(uri) - res = http.request(req) # get the response + res = http.request(req) # get the response status_code = res.code raise "Document editing service returned status: #{status_code}" if status_code != '200' # checking status code From 4e685d9eabff68181587e94b7f020005e4400c09 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:04:34 +0300 Subject: [PATCH 064/176] ruby: Layout/ArrayAlignment correct --- .../ruby/app/models/users.rb | 102 +++++++++--------- 1 file changed, 51 insertions(+), 51 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 480cd6bc..85a019a0 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -38,75 +38,75 @@ end class Users @@descr_user_1 = [ 'File author by default', - 'Doesn’t belong to any group', - 'Can review all the changes', - 'Can perform all actions with comments', - 'The file favorite state is undefined', - 'Can create files from templates using data from the editor', - 'Can see the information about all users', - 'Has an avatar' + 'Doesn’t belong to any group', + 'Can review all the changes', + 'Can perform all actions with comments', + 'The file favorite state is undefined', + 'Can create files from templates using data from the editor', + 'Can see the information about all users', + 'Has an avatar' ] @@descr_user_2 = [ 'Belongs to Group2', - 'Can review only his own changes or changes made by users with no group', - 'Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only', - 'This file is marked as favorite', - 'Can create new files from the editor', - 'Can see the information about users from Group2 and users who don’t belong to any group', - 'Has an avatar' + 'Can review only his own changes or changes made by users with no group', + 'Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only', + 'This file is marked as favorite', + 'Can create new files from the editor', + 'Can see the information about users from Group2 and users who don’t belong to any group', + 'Has an avatar' ] @@descr_user_3 = [ 'Belongs to Group3', - 'Can review changes made by Group2 users', - 'Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users', - 'This file isn’t marked as favorite', - 'Can’t copy data from the file to clipboard', - 'Can’t download the file', - 'Can’t print the file', - 'Can create new files from the editor', - 'Can see the information about Group2 users' + 'Can review changes made by Group2 users', + 'Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users', + 'This file isn’t marked as favorite', + 'Can’t copy data from the file to clipboard', + 'Can’t download the file', + 'Can’t print the file', + 'Can create new files from the editor', + 'Can see the information about Group2 users' ] @@descr_user_0 = [ 'The name is requested when the editor is opened', - 'Doesn’t belong to any group', - 'Can review all the changes', - 'Can perform all actions with comments', - 'The file favorite state is undefined', - "Can't mention others in comments", - "Can't create new files from the editor", - 'Can’t see anyone’s information', - "Can't rename files from the editor", - "Can't view chat", - "Can't protect file", - 'View file without collaboration' + 'Doesn’t belong to any group', + 'Can review all the changes', + 'Can perform all actions with comments', + 'The file favorite state is undefined', + "Can't mention others in comments", + "Can't create new files from the editor", + 'Can’t see anyone’s information', + "Can't rename files from the editor", + "Can't view chat", + "Can't protect file", + 'View file without collaboration' ] @@users = [ User.new('uid-1', 'John Smith', 'smith@example.com', '', nil, {}, nil, nil, [], @@descr_user_1, true, true), - User.new('uid-2', 'Mark Pottato', 'pottato@example.com', - 'group-2', ['group-2', ''], { - :view => '', - :edit => ['group-2', ''], - :remove => ['group-2'] - }, - ['group-2', ''], - true, [], @@descr_user_2, false, true), - User.new('uid-3', 'Hamish Mitchell', nil, - 'group-3', ['group-2'], { - :view => %w[group-3 group-2], - :edit => ['group-2'], - :remove => [] - }, - ['group-2'], - false, %w[copy download print], @@descr_user_3, false, false), - User.new('uid-0', nil, nil, - '', nil, {}, [], - nil, ['protect'], @@descr_user_0, false, false) + User.new('uid-2', 'Mark Pottato', 'pottato@example.com', + 'group-2', ['group-2', ''], { + :view => '', + :edit => ['group-2', ''], + :remove => ['group-2'] + }, + ['group-2', ''], + true, [], @@descr_user_2, false, true), + User.new('uid-3', 'Hamish Mitchell', nil, + 'group-3', ['group-2'], { + :view => %w[group-3 group-2], + :edit => ['group-2'], + :remove => [] + }, + ['group-2'], + false, %w[copy download print], @@descr_user_3, false, false), + User.new('uid-0', nil, nil, + '', nil, {}, [], + nil, ['protect'], @@descr_user_0, false, false) ] class << self From 4c92c1c750d9bd4e44a28028b14d3fa17ea1ce0e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:08:38 +0300 Subject: [PATCH 065/176] ruby: Layout/IndentationWidth correct --- .../ruby/app/models/document_helper.rb | 16 ++++----- .../ruby/app/models/file_model.rb | 36 +++++++++---------- .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/track_helper.rb | 12 +++---- 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 4db34c64..a3a6d9f4 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -251,13 +251,13 @@ class DocumentHelper def get_internal_extension(file_type) ext = case file_type when 'word' # .docx for word type - '.docx' + '.docx' when 'cell' # .xlsx for cell type - '.xlsx' + '.xlsx' when 'slide' # .pptx for slide type - '.pptx' + '.pptx' else - '.docx' # the default value is .docx + '.docx' # the default value is .docx end ext @@ -268,13 +268,13 @@ class DocumentHelper path = "#{get_server_url(true)}/assets/" full_path = case file_type when 'word' # for word type - "#{path}file_docx.svg" + "#{path}file_docx.svg" when 'cell' # .xlsx for cell type - "#{path}file_xlsx.svg" + "#{path}file_xlsx.svg" when 'slide' # .pptx for slide type - "#{path}file_pptx.svg" + "#{path}file_pptx.svg" else - "#{path}file_docx.svg" # the default value is .docx + "#{path}file_docx.svg" # the default value is .docx end full_path diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index bac88328..764bf5cc 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -154,7 +154,7 @@ class FileModel :change => false } else - nil + nil end, :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, :templates => @user.templates ? templates : nil, @@ -266,11 +266,11 @@ class FileModel :directUrl => prev['directUrl'] } else - { - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'] - } + { + :fileType => prev['fileType'], + :key => prev['key'], + :url => prev['url'] + } end # write the path to the diff.zip archive with differences in this file version @@ -309,10 +309,10 @@ class FileModel :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image } else - { - :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image - } + { + :fileType => 'png', # image file type + :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -334,10 +334,10 @@ class FileModel :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file } else - { - :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file - } + { + :fileType => 'docx', # file type + :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not @@ -359,10 +359,10 @@ class FileModel :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file } else - { - :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file - } + { + :fileType => 'csv', # file type + :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file + } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index d206d5fb..a31e8b02 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -42,7 +42,7 @@ class JwtHelper begin decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } rescue - return '' + return '' end # decoded = Array [ {"data"=>"test"}, # payload # {"alg"=>"HS256"} # header ] diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 59ce970a..4920631c 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -113,7 +113,7 @@ class TrackHelper download_uri = new_file_uri end rescue StandardError => msg - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) end end @@ -157,7 +157,7 @@ class TrackHelper saved = 0 rescue StandardError => msg - saved = 1 + saved = 1 end saved @@ -188,7 +188,7 @@ class TrackHelper download_uri = new_file_uri end rescue StandardError => msg - new_file_name = true + new_file_name = true end end @@ -204,7 +204,7 @@ class TrackHelper file_name = if new_file_name DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else @@ -224,7 +224,7 @@ class TrackHelper saved = 0 rescue StandardError => msg - saved = 1 + saved = 1 end saved @@ -260,7 +260,7 @@ class TrackHelper res = http.request(req) # get the response data = res.body # and take its body rescue => ex - raise ex.message + raise ex.message end json_data = JSON.parse(data) # convert the response body into the json format From 12aba3d66d4917a88ca047616033e94dc40e10f4 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:12:39 +0300 Subject: [PATCH 066/176] ruby: Layout/EmptyLines correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index a3a6d9f4..613973e1 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -226,7 +226,6 @@ class DocumentHelper def get_server_url(for_document_server) return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - return @@base_url end @@ -308,7 +307,6 @@ class DocumentHelper return '"File not found"' if !file_id.nil? - return result end From 986eeefb4d405dacce709417e115ce6fc0a06eec Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:13:28 +0300 Subject: [PATCH 067/176] ruby: Layout/EmptyLinesAroundMethodBody correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 3 --- web/documentserver-example/ruby/app/models/file_model.rb | 1 - 2 files changed, 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 613973e1..f259e747 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -227,7 +227,6 @@ class DocumentHelper return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri return @@base_url - end # get callback url @@ -308,7 +307,6 @@ class DocumentHelper return '"File not found"' if !file_id.nil? return result - end # enable ignore certificate @@ -317,7 +315,6 @@ class DocumentHelper http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session - end end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 764bf5cc..12388a0c 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -400,7 +400,6 @@ class FileModel users_info.push(u) end return users_info - end # get users data for protect From 44445de6e7d528a2546dab186a3c217e5fa5eb25 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 14 Nov 2023 17:17:04 +0300 Subject: [PATCH 068/176] ruby: Layout/CommentIndentation correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- web/documentserver-example/ruby/app/models/service_converter.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 12388a0c..1d314efe 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -257,7 +257,7 @@ class FileModel obj['user'] = change ? change['user'] : nil prev = histData[(i - 2).to_s] # get the history data from the previous file version -# write key and url information about previous file version with optional direct url + # write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true { # write key and url information about previous file version with optional direct url :fileType => prev['fileType'], diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index c325b3be..690e557a 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -121,7 +121,7 @@ class ServiceConverter when -1 error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' when 0 - # public const int c_nErrorNo = 0 + # public const int c_nErrorNo = 0 else error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message end From 286fb47fb86af04a87114d9f257fab6e013a878b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 10:44:48 +0300 Subject: [PATCH 069/176] ruby: Lint/RedundantStringCoercion correct --- .../ruby/app/controllers/home_controller.rb | 6 +++--- .../ruby/app/models/document_helper.rb | 6 +++--- .../ruby/app/models/service_converter.rb | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index caa8354d..46bc638c 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -100,7 +100,7 @@ class HomeController < ApplicationController # if the conversion isn't completed, write file name and step values to the response if percent != 100 - render plain: "{ \"step\" : \"#{percent.to_s}\", \"filename\" : \"#{file_name}\"}" + render plain: "{ \"step\" : \"#{percent}\", \"filename\" : \"#{file_name}\"}" return end @@ -199,13 +199,13 @@ class HomeController < ApplicationController if [2, 3].include?(status) # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file - render plain: "{\"error\":#{saved.to_s}}" + render plain: "{\"error\":#{saved}}" return end if [6, 7].include?(status) # MustForceave, CorruptedForcesave saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file - render plain: "{\"error\":#{saved.to_s}}" + render plain: "{\"error\":#{saved}}" return end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index f259e747..cbe4141b 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -147,7 +147,7 @@ class DocumentHelper index = 1 while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory - name = "#{base_name} (#{index.to_s})#{ext.downcase}" # add an index after its base name + name = "#{base_name} (#{index})#{ext.downcase}" # add an index after its base name index += 1 end @@ -209,7 +209,7 @@ class DocumentHelper # get file url def get_file_uri(file_name, for_document_server) - uri = "#{get_server_url(for_document_server)}/#{DocumentHelper.config_manager.storage_path.to_s}/#{cur_user_host_address(nil)}/#{ERB::Util.url_encode(file_name)}" + uri = "#{get_server_url(for_document_server)}/#{DocumentHelper.config_manager.storage_path}/#{cur_user_host_address(nil)}/#{ERB::Util.url_encode(file_name)}" return uri end @@ -218,7 +218,7 @@ class DocumentHelper def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' - uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version.to_s}&file=#{ERB::Util.url_encode(file)}#{user_host}" + uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}&file=#{ERB::Util.url_encode(file)}#{user_host}" return uri end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 690e557a..e4111907 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -123,7 +123,7 @@ class ServiceConverter when 0 # public const int c_nErrorNo = 0 else - error_message = "ErrorCode = #{error_code.to_s}" # default value for the error message + error_message = "ErrorCode = #{error_code}" # default value for the error message end raise error_message From 3197702d7bb5b52ce15193bd48f18dd326b5586c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 10:51:15 +0300 Subject: [PATCH 070/176] ruby: Style/CommentedKeyword correct --- web/documentserver-example/ruby/app/models/users.rb | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 85a019a0..3b886a27 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -110,26 +110,29 @@ class Users ] class << self - def get_all_users # get a list of all the users + def get_all_users @@users end - def get_user(id) # get a user by id specified + # get a user by id specified + def get_user(id) for user in @@users do return user if user.id.eql?(id) end return @@users[0] end - def get_users_for_mentions(id) # get a list of users with their names and emails for mentions + # get a list of users with their names and emails for mentions + def get_users_for_mentions(id) usersData = [] for user in @@users do usersData.push({ :name => user.name, :email => user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end return usersData end - - def get_users_for_protect(id) # get a list of users with their id, names and emails for protect + + # get a list of users with their id, names and emails for protect + def get_users_for_protect(id) users_data = [] for user in @@users do users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? From 6525c29107b02edcfb5a872c40caf9abe4aacd48 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 10:59:58 +0300 Subject: [PATCH 071/176] ruby: Style/NumericPredicate correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 46bc638c..c7a6b4aa 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -190,7 +190,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] file_name = File.basename(params[:fileName]) - if status == 1 && (file_data['actions'][0]['type'] == 0) # finished edit + if status == 1 && ((file_data['actions'][0]['type']).zero?) # finished edit user = file_data['actions'][0]['userid'] # get the user id unless file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 1d314efe..337ab367 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -200,7 +200,7 @@ class FileModel hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version - if cur_ver > 0 # if file was modified + if cur_ver.positive? # if file was modified hist = [] histData = {} From 56e96eeac169f92e1490d665c997b1047f512284 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 11:01:38 +0300 Subject: [PATCH 072/176] ruby: Style/Redundant correct --- .../ruby/app/controllers/home_controller.rb | 28 +++++++++---------- .../ruby/app/models/document_helper.rb | 18 ++++++------ .../ruby/app/models/file_model.rb | 26 ++++++++--------- .../ruby/app/models/jwt_helper.rb | 8 +++--- .../ruby/app/models/service_converter.rb | 4 +-- .../ruby/app/models/track_helper.rb | 4 +-- .../ruby/app/models/users.rb | 6 ++-- 7 files changed, 47 insertions(+), 47 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index c7a6b4aa..3170a988 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -81,15 +81,15 @@ class HomeController < ApplicationController # converting a file def convert - begin + file_data = request.body.read return '' if file_data.nil? || file_data.empty? body = JSON.parse(file_data) file_name = File.basename(body['filename']) - lang = cookies[:ulang] ? cookies[:ulang] : 'en' - file_pass = body['filePass'] ? body['filePass'] : nil + lang = cookies[:ulang] || 'en' + file_pass = body['filePass'] || nil file_uri = DocumentHelper.get_download_url(file_name) extension = File.extname(file_name).downcase internal_extension = 'ooxml' @@ -135,12 +135,12 @@ class HomeController < ApplicationController render plain: "{ \"filename\" : \"#{file_name}\"}" rescue => ex render plain: "{ \"error\": \"#{ex.message}\"}" - end + end # downloading a history file from public def downloadhistory - begin + file_name = File.basename(params[:fileName]) user_address = params[:userAddress] version = params[:ver] @@ -174,7 +174,7 @@ class HomeController < ApplicationController send_file file_path, :x_sendfile => true rescue => ex render plain: '{ "error": "File not found"}' - end + end # tracking file changes @@ -210,7 +210,7 @@ class HomeController < ApplicationController end render plain: '{"error":0}' - return + nil end # removing a file @@ -234,7 +234,7 @@ class HomeController < ApplicationController end render plain: '{"success":true}' # report that the operation is successful - return + nil end # getting files information @@ -259,7 +259,7 @@ class HomeController < ApplicationController # downloading a file def download - begin + file_name = File.basename(params[:fileName]) user_address = params[:userAddress] isEmbedded = params[:dmode] @@ -290,12 +290,12 @@ class HomeController < ApplicationController send_file file_path, :x_sendfile => true rescue => ex render plain: '{ "error": "File not found"}' - end + end # Save Copy as... def saveas - begin + body = JSON.parse(request.body.read) file_url = body['url'] title = body['title'] @@ -329,11 +329,11 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file render plain: "{\"file\" : \"#{file_name}\"}" - return + nil rescue => ex render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" - return - end + nil + end # Rename... diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index cbe4141b..fa1adcbb 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -102,7 +102,7 @@ class DocumentHelper return '' end - return directory.to_s + directory.to_s end # get the path to the file history @@ -112,12 +112,12 @@ class DocumentHelper # create history directory if it doesn't exist FileUtils.mkdir_p(directory) unless File.directory?(directory) - return directory + directory end # get the path to the specified file version def version_dir(hist_dir, ver) - return File.join(hist_dir, ver.to_s) + File.join(hist_dir, ver.to_s) end # get the last file version @@ -134,7 +134,7 @@ class DocumentHelper end end - return ver + ver end # get the correct file name if such a name already exists @@ -170,7 +170,7 @@ class DocumentHelper end end - return arr + arr end # create file meta information @@ -211,7 +211,7 @@ class DocumentHelper def get_file_uri(file_name, for_document_server) uri = "#{get_server_url(for_document_server)}/#{DocumentHelper.config_manager.storage_path}/#{cur_user_host_address(nil)}/#{ERB::Util.url_encode(file_name)}" - return uri + uri end # get history path url @@ -219,14 +219,14 @@ class DocumentHelper # for redirection to my link user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}&file=#{ERB::Util.url_encode(file)}#{user_host}" - return uri + uri end # get server url def get_server_url(for_document_server) return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - return @@base_url + @@base_url end # get callback url @@ -306,7 +306,7 @@ class DocumentHelper return '"File not found"' if !file_id.nil? - return result + result end # enable ignore certificate diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 337ab367..8f16e0fb 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -34,7 +34,7 @@ class FileModel end def type - @type ? @type : 'desktop' # the default platform type is desktop + @type || 'desktop' # the default platform type is desktop end # get file extension from its name @@ -61,7 +61,7 @@ class FileModel def key uri = "#{DocumentHelper.cur_user_host_address(nil)}/#{@file_name}" # get current user host address stat = File.mtime(DocumentHelper.storage_path(@file_name, nil)) # get the modification time of the given file - return ServiceConverter.generate_revision_id("#{uri}.#{stat}") + ServiceConverter.generate_revision_id("#{uri}.#{stat}") end # get callback url @@ -86,7 +86,7 @@ class FileModel # get config parameters def get_config - editorsmode = @mode ? @mode : 'edit' # mode: view/edit/review/comment/fillForms/embedded + editorsmode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited if (!canEdit && editorsmode.eql?('edit') || editorsmode.eql?('fillForms')) && DocumentHelper.fill_forms_exts.include?(file_ext) editorsmode = 'fillForms' @@ -146,7 +146,7 @@ class FileModel :editorConfig => { :actionLink => @action_data ? JSON.parse(@action_data) : nil, :mode => mode, - :lang => @lang ? @lang : 'en', + :lang => @lang || 'en', :callbackUrl => callback_url, # absolute URL to the document storage service :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') { @@ -187,7 +187,7 @@ class FileModel config['token'] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config end - return config + config end # get document history @@ -294,7 +294,7 @@ class FileModel } end - return nil + nil end # get image information @@ -319,7 +319,7 @@ class FileModel insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object end - return insert_image.to_json.tr('{', '').tr('}', '') + insert_image.to_json.tr('{', '').tr('}', '') end # get compared file information @@ -344,7 +344,7 @@ class FileModel compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object end - return compare_file + compare_file end # get mail merge recipients information @@ -369,12 +369,12 @@ class FileModel dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object end - return dataSpreadsheet + dataSpreadsheet end # get users data for mentions def get_users_mentions - return !@user.id.eql?('uid-0') ? Users.get_users_for_mentions(@user.id) : nil + !@user.id.eql?('uid-0') ? Users.get_users_for_mentions(@user.id) : nil end def get_users_info @@ -399,16 +399,16 @@ class FileModel u['image'] = user_info.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{user_info.id}.png" : nil users_info.push(u) end - return users_info + users_info end # get users data for protect def get_users_protect - return !@user.id.eql?('uid-0') ? Users.get_users_for_protect(@user.id) : nil + !@user.id.eql?('uid-0') ? Users.get_users_for_protect(@user.id) : nil end # get direct url existence flag def is_enable_direct_url - return !@direct_url.nil? && @direct_url == 'true' + !@direct_url.nil? && @direct_url == 'true' end end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index a31e8b02..bdf2ea9a 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -24,17 +24,17 @@ class JwtHelper class << self # check if a secret key to generate token exists or not def is_enabled - return @jwt_secret && !@jwt_secret.empty? ? true : false + @jwt_secret && !@jwt_secret.empty? ? true : false end # check if a secret key used for request def use_for_request - return @token_use_for_request + @token_use_for_request end # encode a payload object into a token using a secret key def encode(payload) - return JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token + JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token end # decode a token into a payload object using a secret key @@ -46,7 +46,7 @@ class JwtHelper end # decoded = Array [ {"data"=>"test"}, # payload # {"alg"=>"HS256"} # header ] - return decoded[0].to_json # get json payload + decoded[0].to_json # get json payload end end end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index e4111907..6d51af98 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -83,7 +83,7 @@ class ServiceConverter end json_data = JSON.parse(data) # parse response body - return get_response_data(json_data) # get response url + get_response_data(json_data) # get response url end # generate the document key value @@ -167,7 +167,7 @@ class ServiceConverter end - return result_percent, response_uri, response_file_type + [result_percent, response_uri, response_file_type] end end end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 4920631c..88e94d52 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -61,7 +61,7 @@ class TrackHelper file_data = file_data['payload'] if inHeader end - return file_data + file_data end def resolve_process_save_body(body) @@ -264,7 +264,7 @@ class TrackHelper end json_data = JSON.parse(data) # convert the response body into the json format - return json_data + json_data end # save file from the url diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 3b886a27..719a9a24 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -119,7 +119,7 @@ class Users for user in @@users do return user if user.id.eql?(id) end - return @@users[0] + @@users[0] end # get a list of users with their names and emails for mentions @@ -128,7 +128,7 @@ class Users for user in @@users do usersData.push({ :name => user.name, :email => user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end - return usersData + usersData end # get a list of users with their id, names and emails for protect @@ -137,7 +137,7 @@ class Users for user in @@users do users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? end - return users_data + users_data end end end From 821df5c700a812fc57048bd31a509c15c8e432a1 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 11:03:48 +0300 Subject: [PATCH 073/176] ruby: Style/RescueStandardError correct --- .../ruby/app/controllers/home_controller.rb | 12 ++++++------ .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/service_converter.rb | 2 +- .../ruby/app/models/track_helper.rb | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 3170a988..4ccf358e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -74,7 +74,7 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" # write a new file name to the response - rescue => ex + rescue StandardError => ex render plain: "{ \"error\": \"#{ex.message}\"}" # write an error message to the response end end @@ -133,7 +133,7 @@ class HomeController < ApplicationController end render plain: "{ \"filename\" : \"#{file_name}\"}" - rescue => ex + rescue StandardError => ex render plain: "{ \"error\": \"#{ex.message}\"}" end @@ -172,7 +172,7 @@ class HomeController < ApplicationController response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" send_file file_path, :x_sendfile => true - rescue => ex + rescue StandardError => ex render plain: '{ "error": "File not found"}' end @@ -288,7 +288,7 @@ class HomeController < ApplicationController response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" send_file file_path, :x_sendfile => true - rescue => ex + rescue StandardError => ex render plain: '{ "error": "File not found"}' end @@ -330,7 +330,7 @@ class HomeController < ApplicationController render plain: "{\"file\" : \"#{file_name}\"}" nil - rescue => ex + rescue StandardError => ex render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" nil @@ -477,7 +477,7 @@ class HomeController < ApplicationController error: nil, success: true } - rescue => error + rescue StandardError => error response.status = :internal_server_error render json: { error: error.message, diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index bdf2ea9a..f97ebe80 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -41,7 +41,7 @@ class JwtHelper def decode(token) begin decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } - rescue + rescue StandardError return '' end # decoded = Array [ {"data"=>"test"}, # payload diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 6d51af98..9d33397f 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -78,7 +78,7 @@ class ServiceConverter data = res.body # and take its body rescue Timeout::Error # try again - rescue => ex + rescue StandardError => ex raise ex.message end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 88e94d52..6ed25308 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -259,7 +259,7 @@ class TrackHelper req.body = payload.to_json # convert the payload object into the json format res = http.request(req) # get the response data = res.body # and take its body - rescue => ex + rescue StandardError => ex raise ex.message end From b29b0c3fa59abb84ca5dedc1a2d60d3e3ee103c7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 11:05:19 +0300 Subject: [PATCH 074/176] ruby: Style/AndOr correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 4ccf358e..76501b7b 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -370,7 +370,7 @@ class HomeController < ApplicationController end link = body['link'] - if fileName.empty? and body.key?('link') + if fileName.empty? && body.key?('link') unless link.include?(DocumentHelper.get_server_url(false)) data = { url: link, @@ -389,7 +389,7 @@ class HomeController < ApplicationController end end - if fileName.empty? and body.key?('path') + if fileName.empty? && body.key?('path') path = File.basename(body['path']) fileName = path if File.exist?(DocumentHelper.storage_path(path, nil)) end From a407b2b9c77d9f350fa58cab1997c662ccc42c7a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 11:06:03 +0300 Subject: [PATCH 075/176] ruby: Style/For correct --- .../ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index fa1adcbb..fd65c842 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -282,7 +282,7 @@ class DocumentHelper def get_files_info(file_id) result = [] - for fileName in get_stored_files(nil) # run through all the stored files from the folder + get_stored_files(nil).each do |fileName| # run through all the stored files from the folder directory = storage_path(fileName, nil) uri = "#{cur_user_host_address(nil)}/#{fileName}" diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 8f16e0fb..2473427d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -204,7 +204,7 @@ class FileModel hist = [] histData = {} - for i in 1..cur_ver # run through all the file versions + (1..cur_ver).each do |i| # run through all the file versions obj = {} dataObj = {} ver_dir = DocumentHelper.version_dir(hist_dir, i) # get the path to the given file version diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 719a9a24..85fb40df 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -116,7 +116,7 @@ class Users # get a user by id specified def get_user(id) - for user in @@users do + @@users.each do |user| return user if user.id.eql?(id) end @@users[0] @@ -125,7 +125,7 @@ class Users # get a list of users with their names and emails for mentions def get_users_for_mentions(id) usersData = [] - for user in @@users do + @@users.each do |user| usersData.push({ :name => user.name, :email => user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end usersData @@ -134,7 +134,7 @@ class Users # get a list of users with their id, names and emails for protect def get_users_for_protect(id) users_data = [] - for user in @@users do + @@users.each do |user| users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? end users_data From 83843342d4e3926972a5b0759d49eb61855a61e3 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 11:07:09 +0300 Subject: [PATCH 076/176] ruby: Style/HashSyntax correct --- web/documentserver-example/ruby/Gemfile | 16 +- .../ruby/app/controllers/home_controller.rb | 36 ++-- .../ruby/app/models/document_helper.rb | 6 +- .../ruby/app/models/file_model.rb | 184 +++++++++--------- .../ruby/app/models/service_converter.rb | 18 +- .../ruby/app/models/track_helper.rb | 8 +- .../ruby/app/models/users.rb | 14 +- 7 files changed, 141 insertions(+), 141 deletions(-) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 656c3256..a31eca56 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -1,24 +1,24 @@ source 'https://rubygems.org' -gem 'byebug', '~> 11.1', :groups => %i[development test] +gem 'byebug', '~> 11.1', groups: %i[development test] gem 'coffee-rails', '~> 5.0' -gem 'dalli', '~> 3.2', :group => :development +gem 'dalli', '~> 3.2', group: :development gem 'jbuilder', '~> 2.11' gem 'jquery-rails', '~> 4.5' gem 'jwt', '~> 2.7' gem 'mimemagic', github: 'mimemagicrb/mimemagic', ref: '01f92d86d15d85cfd0f20dabd025dcbd36a8a60f' gem 'rack-cors', '~> 2.0' gem 'rails', '~> 7.0.8' -gem 'rubocop', '~> 1.52', :group => :development +gem 'rubocop', '~> 1.52', group: :development gem 'sass-rails', '~> 6.0' -gem 'sdoc', '~> 2.6', :group => :doc +gem 'sdoc', '~> 2.6', group: :doc gem 'sorbet-runtime', '~> 0.5.10871' -gem 'test-unit', '~> 3.6', :groups => %i[development test] +gem 'test-unit', '~> 3.6', groups: %i[development test] gem 'turbolinks', '~> 5.2' gem 'tzinfo-data', '~> 1.2023' gem 'uglifier', '~> 4.2' gem 'uuid', '~> 2.3' -gem 'web-console', '~> 4.2', :groups => %i[development test] +gem 'web-console', '~> 4.2', groups: %i[development test] gem 'webrick', '~> 1.8' # Unfortunately, Sorbet only supports Darwin and Linux-based systems. @@ -28,6 +28,6 @@ gem 'webrick', '~> 1.8' # https://github.com/sorbet/sorbet/issues/4011 # https://github.com/sorbet/sorbet/issues/4119 install_if -> { RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /x86_64/ } do - gem 'sorbet', '~> 0.5.10871', :group => :development - gem 'tapioca', '~> 0.11.6', :group => :development + gem 'sorbet', '~> 0.5.10871', group: :development + gem 'tapioca', '~> 0.11.6', group: :development end diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 76501b7b..246759ba 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -31,7 +31,7 @@ class HomeController < ApplicationController def editor DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) - @file = FileModel.new(:file_name => File.basename(params[:fileName]), :mode => params[:editorsMode], :type => params[:editorsType], :user_ip => request.remote_ip, :lang => cookies[:ulang], :user => user, :action_data => params[:actionLink], :direct_url => params[:directUrl]) + @file = FileModel.new(file_name: File.basename(params[:fileName]), mode: params[:editorsMode], type: params[:editorsType], user_ip: request.remote_ip, lang: cookies[:ulang], user:, action_data: params[:actionLink], direct_url: params[:directUrl]) end # creating a sample document @@ -39,7 +39,7 @@ class HomeController < ApplicationController DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) file_name = DocumentHelper.create_demo(params[:fileExt], params[:sample], user) - redirect_to :controller => 'home', :action => 'editor', :fileName => file_name, :userId => user.id + redirect_to controller: 'home', action: 'editor', fileName: file_name, userId: user.id end # uploading a file @@ -154,11 +154,11 @@ class HomeController < ApplicationController hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) if !token || token.eql?('') - render plain: 'JWT validation failed', :status => 403 + render plain: 'JWT validation failed', status: 403 return end else - render plain: 'JWT validation failed', :status => 403 + render plain: 'JWT validation failed', status: 403 return end end @@ -171,7 +171,7 @@ class HomeController < ApplicationController response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" - send_file file_path, :x_sendfile => true + send_file file_path, x_sendfile: true rescue StandardError => ex render plain: '{ "error": "File not found"}' @@ -254,7 +254,7 @@ class HomeController < ApplicationController response.headers['Content-Type'] = MimeMagic.by_path(csvPath).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file csvPath, :x_sendfile => true + send_file csvPath, x_sendfile: true end # downloading a file @@ -272,7 +272,7 @@ class HomeController < ApplicationController token = JwtHelper.decode(hdr) end if !token || token.eql?('') - render plain: 'JWT validation failed', :status => 403 + render plain: 'JWT validation failed', status: 403 return end end @@ -287,7 +287,7 @@ class HomeController < ApplicationController response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file file_path, :x_sendfile => true + send_file file_path, x_sendfile: true rescue StandardError => ex render plain: '{ "error": "File not found"}' @@ -347,7 +347,7 @@ class HomeController < ApplicationController newfilename += orig_ext if orig_ext != cur_ext meta = { - :title => newfilename + title: newfilename } json_data = TrackHelper.command_request('meta', dockey, meta) @@ -400,16 +400,16 @@ class HomeController < ApplicationController end data = { - :fileType => File.extname(fileName).downcase.delete('.'), - :key => ServiceConverter.generate_revision_id("#{"#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}"}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), - :url => DocumentHelper.get_download_url(fileName), - :directUrl => body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, - :referenceData => { - :instanceId => DocumentHelper.get_server_url(false), - :fileKey => { :fileName => fileName, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json + fileType: File.extname(fileName).downcase.delete('.'), + key: ServiceConverter.generate_revision_id("#{"#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}"}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), + url: DocumentHelper.get_download_url(fileName), + directUrl: body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, + referenceData: { + instanceId: DocumentHelper.get_server_url(false), + fileKey: { fileName:, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json }, - :path => fileName, - :link => "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{fileName}" + path: fileName, + link: "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{fileName}" } data['token'] = JwtHelper.encode(data) if JwtHelper.is_enabled diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index fd65c842..96f9146e 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -179,9 +179,9 @@ class DocumentHelper # write user name, user uid and the creation time to the json object json = { - :created => Time.now.to_formatted_s(:db), - :uid => uid, - :uname => uname + created: Time.now.to_formatted_s(:db), + uid:, + uname: } # write file meta information to the createdInfo.json file diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 2473427d..b64825fe 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -97,87 +97,87 @@ class FileModel templatesImageUrl = DocumentHelper.get_template_image_url(document_type) # templates image url in the "From Template" section templates = [ { - :image => '', - :title => 'Blank', - :url => create_url + image: '', + title: 'Blank', + url: create_url }, { - :image => templatesImageUrl, - :title => 'With sample content', - :url => "#{create_url}&sample=true" + image: templatesImageUrl, + title: 'With sample content', + url: "#{create_url}&sample=true" } ] config = { - :type => type, - :documentType => document_type, - :document => { - :title => @file_name, - :url => download_url, - :directUrl => is_enable_direct_url ? download_url(false) : '', - :fileType => file_ext.delete('.'), - :key => key, - :info => { - :owner => 'Me', - :uploaded => Time.now.to_s, - :favorite => @user.favorite + type:, + documentType: document_type, + document: { + title: @file_name, + url: download_url, + directUrl: is_enable_direct_url ? download_url(false) : '', + fileType: file_ext.delete('.'), + key:, + info: { + owner: 'Me', + uploaded: Time.now.to_s, + favorite: @user.favorite }, - :permissions => { # the permission for the document to be edited and downloaded or not - :comment => !editorsmode.eql?('view') && !editorsmode.eql?('fillForms') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), - :copy => !@user.deniedPermissions.include?('copy'), - :download => !@user.deniedPermissions.include?('download'), - :edit => canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('view') || editorsmode.eql?('filter') || editorsmode.eql?('blockcontent')), - :print => !@user.deniedPermissions.include?('print'), - :fillForms => !editorsmode.eql?('view') && !editorsmode.eql?('comment') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), - :modifyFilter => !editorsmode.eql?('filter'), - :modifyContentControl => !editorsmode.eql?('blockcontent'), - :review => canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('review')), - :chat => !@user.id.eql?('uid-0'), - :reviewGroups => @user.reviewGroups, - :commentGroups => @user.commentGroups, - :userInfoGroups => @user.userInfoGroups, - :protect => !@user.deniedPermissions.include?('protect') + permissions: { # the permission for the document to be edited and downloaded or not + comment: !editorsmode.eql?('view') && !editorsmode.eql?('fillForms') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + copy: !@user.deniedPermissions.include?('copy'), + download: !@user.deniedPermissions.include?('download'), + edit: canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('view') || editorsmode.eql?('filter') || editorsmode.eql?('blockcontent')), + print: !@user.deniedPermissions.include?('print'), + fillForms: !editorsmode.eql?('view') && !editorsmode.eql?('comment') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + modifyFilter: !editorsmode.eql?('filter'), + modifyContentControl: !editorsmode.eql?('blockcontent'), + review: canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('review')), + chat: !@user.id.eql?('uid-0'), + reviewGroups: @user.reviewGroups, + commentGroups: @user.commentGroups, + userInfoGroups: @user.userInfoGroups, + protect: !@user.deniedPermissions.include?('protect') }, - :referenceData => { - :instanceId => DocumentHelper.get_server_url(false), - :fileKey => !@user.id.eql?('uid-0') ? { :fileName => @file_name, :userAddress => DocumentHelper.cur_user_host_address(nil) }.to_json : nil + referenceData: { + instanceId: DocumentHelper.get_server_url(false), + fileKey: !@user.id.eql?('uid-0') ? { fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json : nil } }, - :editorConfig => { - :actionLink => @action_data ? JSON.parse(@action_data) : nil, - :mode => mode, - :lang => @lang || 'en', - :callbackUrl => callback_url, # absolute URL to the document storage service - :coEditing => if editorsmode.eql?('view') && @user.id.eql?('uid-0') + editorConfig: { + actionLink: @action_data ? JSON.parse(@action_data) : nil, + mode:, + lang: @lang || 'en', + callbackUrl: callback_url, # absolute URL to the document storage service + coEditing: if editorsmode.eql?('view') && @user.id.eql?('uid-0') { - :mode => 'strict', - :change => false + mode: 'strict', + change: false } else nil end, - :createUrl => !@user.id.eql?('uid-0') ? create_url : nil, - :templates => @user.templates ? templates : nil, - :user => { # the user currently viewing or editing the document - :id => !@user.id.eql?('uid-0') ? @user.id : nil, - :name => @user.name, - :group => @user.group, - :image => @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil + createUrl: !@user.id.eql?('uid-0') ? create_url : nil, + templates: @user.templates ? templates : nil, + user: { # the user currently viewing or editing the document + id: !@user.id.eql?('uid-0') ? @user.id : nil, + name: @user.name, + group: @user.group, + image: @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil }, - :embedded => { # the parameters for the embedded document type - :saveUrl => download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer - :embedUrl => download_url(false), # the absolute URL to the document serving as a source file for the document embedded into the web page - :shareUrl => download_url(false), # the absolute URL that will allow other users to share this document - :toolbarDocked => 'top' # the place for the embedded viewer toolbar (top or bottom) + embedded: { # the parameters for the embedded document type + saveUrl: download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer + embedUrl: download_url(false), # the absolute URL to the document serving as a source file for the document embedded into the web page + shareUrl: download_url(false), # the absolute URL that will allow other users to share this document + toolbarDocked: 'top' # the place for the embedded viewer toolbar (top or bottom) }, - :customization => { # the parameters for the editor interface - :about => true, # the About section display - :comments => true, - :feedback => true, # the Feedback & Support menu button display - :forcesave => false, # adding the request for the forced file saving to the callback handler - :submitForm => submitForm, # the Submit form button state - :goback => { - :url => DocumentHelper.get_server_url(false) + customization: { # the parameters for the editor interface + about: true, # the About section display + comments: true, + feedback: true, # the Feedback & Support menu button display + forcesave: false, # adding the request for the forced file saving to the callback handler + submitForm:, # the Submit form button state + goback: { + url: DocumentHelper.get_server_url(false) } } } @@ -226,8 +226,8 @@ class FileModel # write information about changes to the object obj['created'] = cr_info['created'] obj['user'] = { - :id => cr_info['uid'], - :name => cr_info['uname'] + id: cr_info['uid'], + name: cr_info['uname'] } end end @@ -260,16 +260,16 @@ class FileModel # write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true { # write key and url information about previous file version with optional direct url - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'], - :directUrl => prev['directUrl'] + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'], + directUrl: prev['directUrl'] } else { - :fileType => prev['fileType'], - :key => prev['key'], - :url => prev['url'] + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'] } end @@ -286,11 +286,11 @@ class FileModel end return { - :hist => { # write history information about the current file version to the hist - :currentVersion => cur_ver, - :history => hist + hist: { # write history information about the current file version to the hist + currentVersion: cur_ver, + history: hist }, - :histData => histData + histData: } end @@ -304,14 +304,14 @@ class FileModel # direct url to the image insert_image = if is_enable_direct_url == true { - :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image - :directUrl => "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image + fileType: 'png', # image file type + url: "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image + directUrl: "#{DocumentHelper.get_server_url(false)}/assets/logo.png" # direct url to the image } else { - :fileType => 'png', # image file type - :url => "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image + fileType: 'png', # image file type + url: "#{DocumentHelper.get_server_url(true)}/assets/logo.png" # server url to the image } end @@ -329,14 +329,14 @@ class FileModel # direct url to the compared file compare_file = if is_enable_direct_url == true { - :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file - :directUrl => "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file + fileType: 'docx', # file type + url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file + directUrl: "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file } else { - :fileType => 'docx', # file type - :url => "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file + fileType: 'docx', # file type + url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file } end @@ -354,14 +354,14 @@ class FileModel # direct url to the mail merge recipients file dataSpreadsheet = if is_enable_direct_url == true { - :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file - :directUrl => "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file + fileType: 'csv', # file type + url: "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file + directUrl: "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file } else { - :fileType => 'csv', # file type - :url => "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file + fileType: 'csv', # file type + url: "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file } end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 9d33397f..4df9605d 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -40,14 +40,14 @@ class ServiceConverter document_revision_id = generate_revision_id(document_revision_id) payload = { # write all the conversion parameters to the payload - :async => is_async ? true : false, - :url => document_uri, - :outputtype => to_ext.delete('.'), - :filetype => from_ext.delete('.'), - :title => title, - :key => document_revision_id, - :password => file_pass, - :region => lang + async: is_async ? true : false, + url: document_uri, + outputtype: to_ext.delete('.'), + filetype: from_ext.delete('.'), + title:, + key: document_revision_id, + password: file_pass, + region: lang } data = nil @@ -66,7 +66,7 @@ class ServiceConverter if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") # set it to the request with the Bearer prefix end req.body = payload.to_json diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 6ed25308..8f874986 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -234,11 +234,11 @@ class TrackHelper def command_request(method, key, meta = nil) # create a payload object with the method and key payload = { - :c => method, - :key => key + c: method, + key: } - payload.merge!({ :meta => meta }) if !meta.nil? + payload.merge!({ meta: }) if !meta.nil? data = nil begin @@ -253,7 +253,7 @@ class TrackHelper if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ :payload => payload })}") # set it to the request with the Bearer prefix + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") # set it to the request with the Bearer prefix end req.body = payload.to_json # convert the payload object into the json format diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 85fb40df..0f1d4e71 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -90,17 +90,17 @@ class Users nil, [], @@descr_user_1, true, true), User.new('uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', ['group-2', ''], { - :view => '', - :edit => ['group-2', ''], - :remove => ['group-2'] + view: '', + edit: ['group-2', ''], + remove: ['group-2'] }, ['group-2', ''], true, [], @@descr_user_2, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { - :view => %w[group-3 group-2], - :edit => ['group-2'], - :remove => [] + view: %w[group-3 group-2], + edit: ['group-2'], + remove: [] }, ['group-2'], false, %w[copy download print], @@descr_user_3, false, false), @@ -126,7 +126,7 @@ class Users def get_users_for_mentions(id) usersData = [] @@users.each do |user| - usersData.push({ :name => user.name, :email => user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? + usersData.push({ name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end usersData end From 7d09d87891403460c065658f300b9f390226f8c4 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 13:47:18 +0300 Subject: [PATCH 077/176] ruby: Layout/LineLength correct --- .../ruby/app/controllers/home_controller.rb | 295 ++++++++++-------- .../ruby/app/models/document_helper.rb | 31 +- .../ruby/app/models/file_model.rb | 86 +++-- .../ruby/app/models/service_converter.rb | 6 +- .../ruby/app/models/track_helper.rb | 59 +++- .../ruby/app/models/users.rb | 8 +- 6 files changed, 286 insertions(+), 199 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 246759ba..d331e595 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -31,7 +31,16 @@ class HomeController < ApplicationController def editor DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) - @file = FileModel.new(file_name: File.basename(params[:fileName]), mode: params[:editorsMode], type: params[:editorsType], user_ip: request.remote_ip, lang: cookies[:ulang], user:, action_data: params[:actionLink], direct_url: params[:directUrl]) + @file = FileModel.new( + file_name: File.basename(params[:fileName]), + mode: params[:editorsMode], + type: params[:editorsType], + user_ip: request.remote_ip, + lang: cookies[:ulang], + user:, + action_data: params[:actionLink], + direct_url: params[:directUrl] + ) end # creating a sample document @@ -73,7 +82,8 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) - render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" # write a new file name to the response + # write a new file name to the response + render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" rescue StandardError => ex render plain: "{ \"error\": \"#{ex.message}\"}" # write an error message to the response end @@ -81,100 +91,105 @@ class HomeController < ApplicationController # converting a file def convert - - file_data = request.body.read - return '' if file_data.nil? || file_data.empty? + file_data = request.body.read + return '' if file_data.nil? || file_data.empty? - body = JSON.parse(file_data) + body = JSON.parse(file_data) - file_name = File.basename(body['filename']) - lang = cookies[:ulang] || 'en' - file_pass = body['filePass'] || nil - file_uri = DocumentHelper.get_download_url(file_name) - extension = File.extname(file_name).downcase - internal_extension = 'ooxml' + file_name = File.basename(body['filename']) + lang = cookies[:ulang] || 'en' + file_pass = body['filePass'] || nil + file_uri = DocumentHelper.get_download_url(file_name) + extension = File.extname(file_name).downcase + internal_extension = 'ooxml' - if DocumentHelper.convert_exts.include?(extension) # check if the file with such an extension can be converted - key = ServiceConverter.generate_revision_id(file_uri) # generate document key - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(file_uri, extension.delete('.'), internal_extension.delete('.'), key, true, file_pass, lang) # get the url and file type of the converted file and the conversion percentage + if DocumentHelper.convert_exts.include?(extension) # check if the file with such an extension can be converted + key = ServiceConverter.generate_revision_id(file_uri) # generate document key + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data( + file_uri, + extension.delete('.'), + internal_extension.delete('.'), + key, + true, + file_pass, + lang + ) # get the url and file type of the converted file and the conversion percentage - # if the conversion isn't completed, write file name and step values to the response - if percent != 100 - render plain: "{ \"step\" : \"#{percent}\", \"filename\" : \"#{file_name}\"}" - return - end - - # get the correct file name if such a name already exists - correct_name = DocumentHelper.get_correct_name("#{File.basename(file_name, extension)}.#{new_file_type}", nil) - - uri = URI.parse(new_file_uri) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - - DocumentHelper.verify_ssl(new_file_uri, http) - - req = Net::HTTP::Get.new(uri.request_uri) # create the get requets - res = http.request(req) - data = res.body - - raise 'stream is null' if data.nil? - - # write a file with a new extension, but with the content from the origin file - File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| - file.write(data) - end - - old_storage_path = DocumentHelper.storage_path(file_name, nil) - File.delete(old_storage_path) if File.exist?(old_storage_path) - - file_name = correct_name - user = Users.get_user(params[:userId]) - - DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file + # if the conversion isn't completed, write file name and step values to the response + if percent != 100 + render plain: "{ \"step\" : \"#{percent}\", \"filename\" : \"#{file_name}\"}" + return end - render plain: "{ \"filename\" : \"#{file_name}\"}" - rescue StandardError => ex - render plain: "{ \"error\": \"#{ex.message}\"}" - + # get the correct file name if such a name already exists + correct_name = DocumentHelper.get_correct_name("#{File.basename(file_name, extension)}.#{new_file_type}", nil) + + uri = URI.parse(new_file_uri) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + + DocumentHelper.verify_ssl(new_file_uri, http) + + req = Net::HTTP::Get.new(uri.request_uri) # create the get requets + res = http.request(req) + data = res.body + + raise 'stream is null' if data.nil? + + # write a file with a new extension, but with the content from the origin file + File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| + file.write(data) + end + + old_storage_path = DocumentHelper.storage_path(file_name, nil) + File.delete(old_storage_path) if File.exist?(old_storage_path) + + file_name = correct_name + user = Users.get_user(params[:userId]) + + DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file + end + + render plain: "{ \"filename\" : \"#{file_name}\"}" + rescue StandardError => ex + render plain: "{ \"error\": \"#{ex.message}\"}" end # downloading a history file from public def downloadhistory - - file_name = File.basename(params[:fileName]) - user_address = params[:userAddress] - version = params[:ver] - file = params[:file] - isEmbedded = params[:dmode] + file_name = File.basename(params[:fileName]) + user_address = params[:userAddress] + version = params[:ver] + file = params[:file] + isEmbedded = params[:dmode] - if JwtHelper.is_enabled && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header - if request.headers[jwtHeader] - hdr = request.headers[jwtHeader] - hdr.slice!(0, 'Bearer '.length) - token = JwtHelper.decode(hdr) - if !token || token.eql?('') - render plain: 'JWT validation failed', status: 403 - return - end - else + if JwtHelper.is_enabled && JwtHelper.use_for_request + jwtHeader = HomeController.config_manager.jwt_header + if request.headers[jwtHeader] + hdr = request.headers[jwtHeader] + hdr.slice!(0, 'Bearer '.length) + token = JwtHelper.decode(hdr) + if !token || token.eql?('') render plain: 'JWT validation failed', status: 403 return end + else + render plain: 'JWT validation failed', status: 403 + return end - hist_path = "#{DocumentHelper.storage_path(file_name, user_address)}-hist" # or to the original document + end + hist_path = "#{DocumentHelper.storage_path(file_name, user_address)}-hist" # or to the original document - file_path = File.join(hist_path, version, file) + file_path = File.join(hist_path, version, file) - # add headers to the response to specify the page parameters - response.headers['Content-Length'] = File.size(file_path).to_s - response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" + # add headers to the response to specify the page parameters + response.headers['Content-Length'] = File.size(file_path).to_s + response.headers['Content-Type'] = + MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" - send_file file_path, x_sendfile: true - rescue StandardError => ex - render plain: '{ "error": "File not found"}' - + send_file file_path, x_sendfile: true + rescue StandardError => ex + render plain: '{ "error": "File not found"}' end # tracking file changes @@ -259,81 +274,82 @@ class HomeController < ApplicationController # downloading a file def download - - file_name = File.basename(params[:fileName]) - user_address = params[:userAddress] - isEmbedded = params[:dmode] + file_name = File.basename(params[:fileName]) + user_address = params[:userAddress] + isEmbedded = params[:dmode] - if JwtHelper.is_enabled && isEmbedded.nil? && !user_address.nil? && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header - if request.headers[jwtHeader] - hdr = request.headers[jwtHeader] - hdr.slice!(0, 'Bearer '.length) - token = JwtHelper.decode(hdr) - end - if !token || token.eql?('') - render plain: 'JWT validation failed', status: 403 - return - end + if JwtHelper.is_enabled && isEmbedded.nil? && !user_address.nil? && JwtHelper.use_for_request + jwtHeader = HomeController.config_manager.jwt_header + if request.headers[jwtHeader] + hdr = request.headers[jwtHeader] + hdr.slice!(0, 'Bearer '.length) + token = JwtHelper.decode(hdr) end - - file_path = DocumentHelper.forcesave_path(file_name, user_address, false) # get the path to the force saved document version - if file_path.eql?('') - file_path = DocumentHelper.storage_path(file_name, user_address) # or to the original document + if !token || token.eql?('') + render plain: 'JWT validation failed', status: 403 + return end + end - # add headers to the response to specify the page parameters - response.headers['Content-Length'] = File.size(file_path).to_s - response.headers['Content-Type'] = MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" + # get the path to the force saved document version + file_path = DocumentHelper.forcesave_path(file_name, user_address, false) + if file_path.eql?('') + file_path = DocumentHelper.storage_path(file_name, user_address) # or to the original document + end - send_file file_path, x_sendfile: true - rescue StandardError => ex - render plain: '{ "error": "File not found"}' - + # add headers to the response to specify the page parameters + response.headers['Content-Length'] = File.size(file_path).to_s + response.headers['Content-Type'] = + MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" + + send_file file_path, x_sendfile: true + rescue StandardError => ex + render plain: '{ "error": "File not found"}' end # Save Copy as... def saveas - - body = JSON.parse(request.body.read) - file_url = body['url'] - title = body['title'] - file_name = DocumentHelper.get_correct_name(title, nil) - extension = File.extname(file_name).downcase - all_exts = DocumentHelper.convert_exts + DocumentHelper.edited_exts + DocumentHelper.viewed_exts + DocumentHelper.fill_forms_exts + body = JSON.parse(request.body.read) + file_url = body['url'] + title = body['title'] + file_name = DocumentHelper.get_correct_name(title, nil) + extension = File.extname(file_name).downcase + all_exts = DocumentHelper.convert_exts + + DocumentHelper.edited_exts + + DocumentHelper.viewed_exts + + DocumentHelper.fill_forms_exts - unless all_exts.include?(extension) - render plain: '{"error": "File type is not supported"}' - return - end + unless all_exts.include?(extension) + render plain: '{"error": "File type is not supported"}' + return + end - uri = URI.parse(file_url) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + uri = URI.parse(file_url) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - DocumentHelper.verify_ssl(file_url, http) + DocumentHelper.verify_ssl(file_url, http) - req = Net::HTTP::Get.new(uri.request_uri) # create the get requets - res = http.request(req) - data = res.body + req = Net::HTTP::Get.new(uri.request_uri) # create the get requets + res = http.request(req) + data = res.body - if data.size <= 0 || data.size > HomeController.config_manager.maximum_file_size - render plain: '{"error": "File size is incorrect"}' - return - end + if data.size <= 0 || data.size > HomeController.config_manager.maximum_file_size + render plain: '{"error": "File size is incorrect"}' + return + end - File.open(DocumentHelper.storage_path(file_name, nil), 'wb') do |file| - file.write(data) - end - user = Users.get_user(params[:userId]) - DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file + File.open(DocumentHelper.storage_path(file_name, nil), 'wb') do |file| + file.write(data) + end + user = Users.get_user(params[:userId]) + DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file - render plain: "{\"file\" : \"#{file_name}\"}" - nil - rescue StandardError => ex - render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" - nil - + render plain: "{\"file\" : \"#{file_name}\"}" + nil + rescue StandardError => ex + render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" + nil end # Rename... @@ -401,7 +417,10 @@ class HomeController < ApplicationController data = { fileType: File.extname(fileName).downcase.delete('.'), - key: ServiceConverter.generate_revision_id("#{"#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}"}.#{File.mtime(DocumentHelper.storage_path(fileName, nil))}"), + key: ServiceConverter.generate_revision_id( + "#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}" \ + ".#{File.mtime(DocumentHelper.storage_path(fileName, nil))}" + ), url: DocumentHelper.get_download_url(fileName), directUrl: body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, referenceData: { diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 96f9146e..e160abe8 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -87,7 +87,8 @@ class DocumentHelper # the directory with host address doesn't exist return '' unless File.directory?(directory) - directory = File.join(directory, "#{File.basename(file_name)}-hist") # get the path to the history of the given file + # get the path to the history of the given file + directory = File.join(directory, "#{File.basename(file_name)}-hist") unless File.directory?(directory) return '' unless create @@ -146,7 +147,8 @@ class DocumentHelper name = base_name + ext.downcase # get full file name index = 1 - while File.exist?(storage_path(name, user_address)) # if the file with such a name already exists in this directory + # if the file with such a name already exists in this directory + while File.exist?(storage_path(name, user_address)) name = "#{base_name} (#{index})#{ext.downcase}" # add an index after its base name index += 1 end @@ -195,7 +197,8 @@ class DocumentHelper demo_name = (sample == 'true' ? 'sample.' : 'new.') + file_ext file_name = get_correct_name(demo_name, nil) # get the correct file name if such a name already exists - src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) # save sample document of a necessary extension to the storage directory + # save sample document of a necessary extension to the storage directory + src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) dest = storage_path file_name, nil FileUtils.cp src, dest @@ -209,8 +212,10 @@ class DocumentHelper # get file url def get_file_uri(file_name, for_document_server) - uri = "#{get_server_url(for_document_server)}/#{DocumentHelper.config_manager.storage_path}/#{cur_user_host_address(nil)}/#{ERB::Util.url_encode(file_name)}" - + uri = "#{get_server_url(for_document_server)}/" \ + "#{DocumentHelper.config_manager.storage_path}/" \ + "#{cur_user_host_address(nil)}/" \ + "#{ERB::Util.url_encode(file_name)}" uri end @@ -218,20 +223,27 @@ class DocumentHelper def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' - uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}&file=#{ERB::Util.url_encode(file)}#{user_host}" + uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ + "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ + "&file=#{ERB::Util.url_encode(file)}#{user_host}" uri end # get server url def get_server_url(for_document_server) - return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri + return DocumentHelper.config_manager.example_uri.to_s if ( + for_document_server && + DocumentHelper.config_manager.example_uri + ) @@base_url end # get callback url def get_callback(file_name) - "#{get_server_url(true)}/track?fileName=#{ERB::Util.url_encode(file_name)}&userAddress=#{cur_user_host_address(nil)}" + "#{get_server_url(true)}/track?" \ + "fileName=#{ERB::Util.url_encode(file_name)}&" \ + "userAddress=#{cur_user_host_address(nil)}" end # get url to the created file @@ -314,7 +326,8 @@ class DocumentHelper return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled http.use_ssl = true - http.verify_mode = OpenSSL::SSL::VERIFY_NONE # set the flags for the server certificate verification at the beginning of SSL session + # set the flags for the server certificate verification at the beginning of SSL session + http.verify_mode = OpenSSL::SSL::VERIFY_NONE end end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index b64825fe..55e04179 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -49,7 +49,8 @@ class FileModel # get file uri for document server def file_uri_user - @config_manager.storage_path.absolute? ? "#{download_url}&dmode=emb" : DocumentHelper.get_file_uri(@file_name, false) + @config_manager.storage_path.absolute? ? "#{download_url}&dmode=emb" : DocumentHelper.get_file_uri(@file_name, + false) end # get document type from its name (word, cell or slide) @@ -88,13 +89,15 @@ class FileModel def get_config editorsmode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited - if (!canEdit && editorsmode.eql?('edit') || editorsmode.eql?('fillForms')) && DocumentHelper.fill_forms_exts.include?(file_ext) + if (!canEdit && editorsmode.eql?('edit') || editorsmode.eql?('fillForms')) && + DocumentHelper.fill_forms_exts.include?(file_ext) editorsmode = 'fillForms' canEdit = true end submitForm = editorsmode.eql?('fillForms') && @user.id.eql?('uid-1') && false # the Submit form button state mode = canEdit && !editorsmode.eql?('view') ? 'edit' : 'view' - templatesImageUrl = DocumentHelper.get_template_image_url(document_type) # templates image url in the "From Template" section + # templates image url in the "From Template" section + templatesImageUrl = DocumentHelper.get_template_image_url(document_type) templates = [ { image: '', @@ -123,12 +126,12 @@ class FileModel favorite: @user.favorite }, permissions: { # the permission for the document to be edited and downloaded or not - comment: !editorsmode.eql?('view') && !editorsmode.eql?('fillForms') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + comment: !%w[view fillForms embedded blockcontent].include?(editorsmode), copy: !@user.deniedPermissions.include?('copy'), download: !@user.deniedPermissions.include?('download'), - edit: canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('view') || editorsmode.eql?('filter') || editorsmode.eql?('blockcontent')), + edit: canEdit && %w[edit view filter blockcontent].include?(editorsmode), print: !@user.deniedPermissions.include?('print'), - fillForms: !editorsmode.eql?('view') && !editorsmode.eql?('comment') && !editorsmode.eql?('embedded') && !editorsmode.eql?('blockcontent'), + fillForms: !%w[view comment embedded blockcontent].include?(editorsmode), modifyFilter: !editorsmode.eql?('filter'), modifyContentControl: !editorsmode.eql?('blockcontent'), review: canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('review')), @@ -140,7 +143,8 @@ class FileModel }, referenceData: { instanceId: DocumentHelper.get_server_url(false), - fileKey: !@user.id.eql?('uid-0') ? { fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json : nil + fileKey: !@user.id.eql?('uid-0') ? { fileName: @file_name, + userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json : nil } }, editorConfig: { @@ -149,13 +153,13 @@ class FileModel lang: @lang || 'en', callbackUrl: callback_url, # absolute URL to the document storage service coEditing: if editorsmode.eql?('view') && @user.id.eql?('uid-0') - { - mode: 'strict', - change: false - } - else - nil - end, + { + mode: 'strict', + change: false + } + else + nil + end, createUrl: !@user.id.eql?('uid-0') ? create_url : nil, templates: @user.templates ? templates : nil, user: { # the user currently viewing or editing the document @@ -165,9 +169,12 @@ class FileModel image: @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil }, embedded: { # the parameters for the embedded document type - saveUrl: download_url(false), # the absolute URL that will allow the document to be saved onto the user personal computer - embedUrl: download_url(false), # the absolute URL to the document serving as a source file for the document embedded into the web page - shareUrl: download_url(false), # the absolute URL that will allow other users to share this document + # the absolute URL that will allow the document to be saved onto the user personal computer + saveUrl: download_url(false), + # the absolute URL to the document serving as a source file for the document embedded into the web page + embedUrl: download_url(false), + # the absolute URL that will allow other users to share this document + shareUrl: download_url(false), toolbarDocked: 'top' # the place for the embedded viewer toolbar (top or bottom) }, customization: { # the parameters for the editor interface @@ -197,7 +204,8 @@ class FileModel doc_key = key doc_uri = file_uri - hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) # get the path to the file history + # get the path to the file history + hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) cur_ver = DocumentHelper.get_file_version(hist_dir) # get the file version if cur_ver.positive? # if file was modified @@ -219,7 +227,8 @@ class FileModel obj['key'] = cur_key obj['version'] = i - if (i == 1) && File.file?(File.join(hist_dir, 'createdInfo.json')) # check if the createdInfo.json file with meta data exists + # check if the createdInfo.json file with meta data exists + if (i == 1) && File.file?(File.join(hist_dir, 'createdInfo.json')) File.open(File.join(hist_dir, 'createdInfo.json'), 'r') do |file| # open it cr_info = JSON.parse(file.read) # parse the file content @@ -237,14 +246,17 @@ class FileModel dataObj['key'] = cur_key dataObj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") if is_enable_direct_url == true - dataObj['directUrl'] = i == cur_ver ? download_url(false) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) + dataObj['directUrl'] = + i == cur_ver ? download_url(false) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", + false) end dataObj['version'] = i if i > 1 # check if the version number is greater than 1 changes = nil change = nil - File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| # get the path to the changes.json file + # get the path to the changes.json file + File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| changes = JSON.parse(file.read) # and parse its content end @@ -259,7 +271,7 @@ class FileModel prev = histData[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url dataObj['previous'] = if is_enable_direct_url == true - { # write key and url information about previous file version with optional direct url + { # write key and url information about previous file version with optional directUrl fileType: prev['fileType'], key: prev['key'], url: prev['url'], @@ -278,7 +290,8 @@ class FileModel end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataObj['token'] = JwtHelper.encode(dataObj) # encode a payload object into a token and write it to the data object + # encode a payload object into a token and write it to the data object + dataObj['token'] = JwtHelper.encode(dataObj) end hist.push(obj) # add object dictionary to the hist list @@ -316,7 +329,8 @@ class FileModel end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - insert_image['token'] = JwtHelper.encode(insert_image) # encode a payload object into a token and write it to the insert_image object + # encode a payload object into a token and write it to the insert_image object + insert_image['token'] = JwtHelper.encode(insert_image) end insert_image.to_json.tr('{', '').tr('}', '') @@ -330,18 +344,22 @@ class FileModel compare_file = if is_enable_direct_url == true { fileType: 'docx', # file type - url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", # server url to the compared file - directUrl: "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" # direct url to the compared file + # server url to the compared file + url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx", + # direct url to the compared file + directUrl: "#{DocumentHelper.get_server_url(false)}/asset?fileName=sample.docx" } else { fileType: 'docx', # file type - url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" # server url to the compared file + # server url to the compared file + url: "#{DocumentHelper.get_server_url(true)}/asset?fileName=sample.docx" } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - compare_file['token'] = JwtHelper.encode(compare_file) # encode a payload object into a token and write it to the compare_file object + # encode a payload object into a token and write it to the compare_file object + compare_file['token'] = JwtHelper.encode(compare_file) end compare_file @@ -355,18 +373,22 @@ class FileModel dataSpreadsheet = if is_enable_direct_url == true { fileType: 'csv', # file type - url: "#{DocumentHelper.get_server_url(true)}/csv", # server url to the mail merge recipients file - directUrl: "#{DocumentHelper.get_server_url(false)}/csv" # direct url to the mail merge recipients file + # server url to the mail merge recipients file + url: "#{DocumentHelper.get_server_url(true)}/csv", + # direct url to the mail merge recipients file + directUrl: "#{DocumentHelper.get_server_url(false)}/csv" } else { fileType: 'csv', # file type - url: "#{DocumentHelper.get_server_url(true)}/csv" # server url to the mail merge recipients file + # server url to the mail merge recipients file + url: "#{DocumentHelper.get_server_url(true)}/csv" } end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) # encode a payload object into a token and write it to the dataSpreadsheet object + # encode a payload object into a token and write it to the dataSpreadsheet object + dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) end dataSpreadsheet diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 4df9605d..f307c675 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -66,7 +66,8 @@ class ServiceConverter if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") # set it to the request with the Bearer prefix + # set it to the request with the Bearer prefix + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") end req.body = payload.to_json @@ -91,7 +92,8 @@ class ServiceConverter require 'zlib' if expected_key.length > 20 # check if the expected key length is greater than 20 - expected_key = (Zlib.crc32 expected_key).to_s # calculate 32-bit crc value from the expected key and turn it into the string + # calculate 32-bit crc value from the expected key and turn it into the string + expected_key = (Zlib.crc32 expected_key).to_s end key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 8f874986..c6ef6148 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -106,14 +106,25 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data( + download_uri, + download_ext.delete('.'), + cur_ext.delete('.'), + key, + false, + nil + ) # get the url of the converted file if new_file_uri.nil? || new_file_uri.empty? - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) # get the correct file name if it already exists + new_file_name = DocumentHelper.get_correct_name( + File.basename(file_name, cur_ext) + download_ext, + user_address + ) # get the correct file name if it already exists else download_uri = new_file_uri end rescue StandardError => msg - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) + new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, + user_address) end end @@ -123,14 +134,17 @@ class TrackHelper return saved if data.eql?(nil) begin - storage_path = DocumentHelper.storage_path(new_file_name, user_address) # get the storage directory of the new file + # get the storage directory of the new file + storage_path = DocumentHelper.storage_path(new_file_name, user_address) hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file - ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) # get the path to the specified file version + # get the path to the specified file version + ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist - FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) # move the file from the storage directory to the previous file version directory + # move the file from the storage directory to the previous file version directory + FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) save_file(data, storage_path) # save the downloaded file to the storage directory @@ -150,7 +164,8 @@ class TrackHelper file.write(file_data['key']) end - forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) # get the path to the forcesaved file + # get the path to the forcesaved file + forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) unless forcesave_path.eql?('') # if this path is empty File.delete(forcesave_path) # remove it end @@ -181,7 +196,14 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data(download_uri, download_ext.delete('.'), cur_ext.delete('.'), key, false, nil) # get the url of the converted file + percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data( + download_uri, + download_ext.delete('.'), + cur_ext.delete('.'), + key, + false, + nil + ) # get the url of the converted file if new_file_uri.nil? || new_file_uri.empty? new_file_name = true else @@ -198,20 +220,25 @@ class TrackHelper return saved if data.eql?(nil) begin - is_submit_form = file_data['forcesavetype'].to_i == 3 # check if the forcesave type is equal to 3 (the form was submitted) + # check if the forcesave type is equal to 3 (the form was submitted) + is_submit_form = file_data['forcesavetype'].to_i == 3 if is_submit_form file_name = if new_file_name - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", + user_address) # get the correct file name if it already exists else - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) + DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", + user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, + user_address) if new_file_name forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it + # if the path to the new file doesn't exist, create it + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) end end @@ -219,7 +246,8 @@ class TrackHelper if is_submit_form uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) # create file meta information with the Filling form tag instead of user name + # create file meta information with the Filling form tag instead of user name + DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) end saved = 0 @@ -253,7 +281,8 @@ class TrackHelper if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") # set it to the request with the Bearer prefix + # set it to the request with the Bearer prefix + req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") end req.body = payload.to_json # convert the payload object into the json format diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 0f1d4e71..d2189723 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -50,7 +50,8 @@ class Users @@descr_user_2 = [ 'Belongs to Group2', 'Can review only his own changes or changes made by users with no group', - 'Can view comments, edit his own comments and comments left by users with no group. Can remove his own comments only', + 'Can view comments, edit his own comments, and comments left by users with no group. ' \ + 'Can remove his own comments only', 'This file is marked as favorite', 'Can create new files from the editor', 'Can see the information about users from Group2 and users who don’t belong to any group', @@ -126,11 +127,12 @@ class Users def get_users_for_mentions(id) usersData = [] @@users.each do |user| - usersData.push({ name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? + usersData.push({ name: user.name, + email: user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? end usersData end - + # get a list of users with their id, names and emails for protect def get_users_for_protect(id) users_data = [] From f47f9bf897625f77b6e0e4e581f443c001fc6417 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:11:19 +0300 Subject: [PATCH 078/176] ruby: Style/FrozenStringLiteralComment correct --- web/documentserver-example/ruby/Gemfile | 1 + web/documentserver-example/ruby/Rakefile | 1 + .../ruby/app/controllers/application_controller.rb | 1 + .../ruby/app/controllers/home_controller.rb | 1 + .../ruby/app/helpers/application_helper.rb | 1 + web/documentserver-example/ruby/app/helpers/home_helper.rb | 1 + web/documentserver-example/ruby/app/models/document_helper.rb | 1 + web/documentserver-example/ruby/app/models/file_model.rb | 1 + web/documentserver-example/ruby/app/models/file_utility.rb | 1 + web/documentserver-example/ruby/app/models/jwt_helper.rb | 1 + web/documentserver-example/ruby/app/models/service_converter.rb | 1 + web/documentserver-example/ruby/app/models/track_helper.rb | 1 + web/documentserver-example/ruby/app/models/users.rb | 1 + web/documentserver-example/ruby/config.ru | 1 + web/documentserver-example/ruby/config/application.rb | 1 + web/documentserver-example/ruby/config/boot.rb | 1 + 16 files changed, 16 insertions(+) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index a31eca56..45e26a0c 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -1,3 +1,4 @@ +# frozen_string_literal: true source 'https://rubygems.org' gem 'byebug', '~> 11.1', groups: %i[development test] diff --git a/web/documentserver-example/ruby/Rakefile b/web/documentserver-example/ruby/Rakefile index 3c3cea86..bb892095 100644 --- a/web/documentserver-example/ruby/Rakefile +++ b/web/documentserver-example/ruby/Rakefile @@ -1,3 +1,4 @@ +# frozen_string_literal: true require 'rake/testtask' require_relative 'config/application' diff --git a/web/documentserver-example/ruby/app/controllers/application_controller.rb b/web/documentserver-example/ruby/app/controllers/application_controller.rb index 32ce5cfd..b6d3299e 100644 --- a/web/documentserver-example/ruby/app/controllers/application_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/application_controller.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index d331e595..81e8b0a6 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/helpers/application_helper.rb b/web/documentserver-example/ruby/app/helpers/application_helper.rb index d17fe1b8..3e7976e0 100644 --- a/web/documentserver-example/ruby/app/helpers/application_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/application_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/helpers/home_helper.rb b/web/documentserver-example/ruby/app/helpers/home_helper.rb index a0e2faf0..421fa078 100644 --- a/web/documentserver-example/ruby/app/helpers/home_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/home_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index e160abe8..0971ab72 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 55e04179..f29efeb8 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/file_utility.rb b/web/documentserver-example/ruby/app/models/file_utility.rb index 204dbcac..5e7965a8 100644 --- a/web/documentserver-example/ruby/app/models/file_utility.rb +++ b/web/documentserver-example/ruby/app/models/file_utility.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index f97ebe80..842c89f2 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index f307c675..89717134 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c6ef6148..aee64911 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index d2189723..6d178dcd 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/config.ru b/web/documentserver-example/ruby/config.ru index e906496b..edb2b97b 100644 --- a/web/documentserver-example/ruby/config.ru +++ b/web/documentserver-example/ruby/config.ru @@ -1,3 +1,4 @@ +# frozen_string_literal: true require_relative 'config/application' Rails.application.initialize! diff --git a/web/documentserver-example/ruby/config/application.rb b/web/documentserver-example/ruby/config/application.rb index ae55c78c..6f8a36e1 100644 --- a/web/documentserver-example/ruby/config/application.rb +++ b/web/documentserver-example/ruby/config/application.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true require_relative 'boot' require 'active_model/railtie' diff --git a/web/documentserver-example/ruby/config/boot.rb b/web/documentserver-example/ruby/config/boot.rb index 5cea2ab2..3ceeeffe 100644 --- a/web/documentserver-example/ruby/config/boot.rb +++ b/web/documentserver-example/ruby/config/boot.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) require 'bundler/setup' From 5f053de539f417c9b32c25d1d3cddaa32d5ac13d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:12:42 +0300 Subject: [PATCH 079/176] ruby: Style/RedundantParentheses correct --- .../ruby/app/controllers/home_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 81e8b0a6..86a5a7e2 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -206,7 +206,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] file_name = File.basename(params[:fileName]) - if status == 1 && ((file_data['actions'][0]['type']).zero?) # finished edit + if status == 1 && (file_data['actions'][0]['type']).zero? # finished edit user = file_data['actions'][0]['userid'] # get the user id unless file_data['users'].index(user) json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command From a809af8ecab51f9da8457e993195eb54b3fc2ee3 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:14:55 +0300 Subject: [PATCH 080/176] ruby: Style/IfUnlessModifier correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 0971ab72..5a8570a6 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -100,9 +100,7 @@ class DocumentHelper end directory = File.join(directory, File.basename(file_name)) # get the path to the given file - if !File.file?(directory) && !create - return '' - end + return '' if !File.file?(directory) && !create directory.to_s end From 2477fb21c55661ac677b14927d8cbb8f31a7b14b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:15:41 +0300 Subject: [PATCH 081/176] ruby: Style/RedundantAssignment correct --- .../ruby/app/models/document_helper.rb | 16 ++++++++-------- .../ruby/app/models/track_helper.rb | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 5a8570a6..31da281a 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -211,21 +211,21 @@ class DocumentHelper # get file url def get_file_uri(file_name, for_document_server) - uri = "#{get_server_url(for_document_server)}/" \ + "#{get_server_url(for_document_server)}/" \ "#{DocumentHelper.config_manager.storage_path}/" \ "#{cur_user_host_address(nil)}/" \ "#{ERB::Util.url_encode(file_name)}" - uri + end # get history path url def get_historypath_uri(file_name, version, file, is_serverUrl = true) # for redirection to my link user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' - uri = "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ + "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ "&file=#{ERB::Util.url_encode(file)}#{user_host}" - uri + end # get server url @@ -258,7 +258,7 @@ class DocumentHelper # get internal file extension by its type def get_internal_extension(file_type) - ext = case file_type + case file_type when 'word' # .docx for word type '.docx' when 'cell' # .xlsx for cell type @@ -269,13 +269,13 @@ class DocumentHelper '.docx' # the default value is .docx end - ext + end # get image url for templates def get_template_image_url(file_type) path = "#{get_server_url(true)}/assets/" - full_path = case file_type + case file_type when 'word' # for word type "#{path}file_docx.svg" when 'cell' # .xlsx for cell type @@ -286,7 +286,7 @@ class DocumentHelper "#{path}file_docx.svg" # the default value is .docx end - full_path + end # get files information diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index aee64911..804d7412 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -293,8 +293,8 @@ class TrackHelper raise ex.message end - json_data = JSON.parse(data) # convert the response body into the json format - json_data + JSON.parse(data) # convert the response body into the json format + end # save file from the url From 498268a7a3c93206cfb5ca682e01c649a0ef5c1e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:18:54 +0300 Subject: [PATCH 082/176] ruby: Style/ParenthesesAroundCondition correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 31da281a..460efe63 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -230,10 +230,10 @@ class DocumentHelper # get server url def get_server_url(for_document_server) - return DocumentHelper.config_manager.example_uri.to_s if ( + return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - ) + @@base_url end From 24ff9ce804e4c66e0b3d0de4594ea03ca1d5570c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:21:29 +0300 Subject: [PATCH 083/176] ruby: Style/NegatedIf correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- .../ruby/app/models/service_converter.rb | 4 ++-- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 460efe63..e73bf1a2 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -315,7 +315,7 @@ class DocumentHelper end end - return '"File not found"' if !file_id.nil? + return '"File not found"' unless file_id.nil? result end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 89717134..a598fa90 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -137,7 +137,7 @@ class ServiceConverter file_result = json_data error_element = file_result['error'] - if !error_element.nil? # if an error occurs + unless error_element.nil? # if an error occurs process_convert_service_responce_error(error_element.to_i) # get an error message end @@ -164,7 +164,7 @@ class ServiceConverter percent_element = file_result['percent'] # get the percentage value - result_percent = percent_element.to_i if !percent_element.nil? + result_percent = percent_element.to_i unless percent_element.nil? result_percent = result_percent >= 100 ? 99 : result_percent diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 804d7412..72fdb5b3 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -267,7 +267,7 @@ class TrackHelper key: } - payload.merge!({ meta: }) if !meta.nil? + payload.merge!({ meta: }) unless meta.nil? data = nil begin From 9cbb946c8f26a7860c032930c9c968a7d7b7f026 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:24:36 +0300 Subject: [PATCH 084/176] ruby: Style/MultilineTernaryOperator correct --- .../ruby/app/models/file_model.rb | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index f29efeb8..99b92aeb 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -50,8 +50,12 @@ class FileModel # get file uri for document server def file_uri_user - @config_manager.storage_path.absolute? ? "#{download_url}&dmode=emb" : DocumentHelper.get_file_uri(@file_name, + if @config_manager.storage_path.absolute? + "#{download_url}&dmode=emb" +else + DocumentHelper.get_file_uri(@file_name, false) +end end # get document type from its name (word, cell or slide) @@ -144,8 +148,12 @@ class FileModel }, referenceData: { instanceId: DocumentHelper.get_server_url(false), - fileKey: !@user.id.eql?('uid-0') ? { fileName: @file_name, - userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json : nil + fileKey: if !@user.id.eql?('uid-0') + { fileName: @file_name, + userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json +else + nil +end } }, editorConfig: { @@ -248,8 +256,12 @@ class FileModel dataObj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") if is_enable_direct_url == true dataObj['directUrl'] = - i == cur_ver ? download_url(false) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", + if i == cur_ver + download_url(false) +else + DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) +end end dataObj['version'] = i From 0728a71f010a292f914d90957daa84960f1cdf4b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:25:19 +0300 Subject: [PATCH 085/176] ruby: Style/EmptyElse correct --- web/documentserver-example/ruby/app/models/file_model.rb | 4 ---- 1 file changed, 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 99b92aeb..f39ece39 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -151,8 +151,6 @@ end fileKey: if !@user.id.eql?('uid-0') { fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json -else - nil end } }, @@ -166,8 +164,6 @@ end mode: 'strict', change: false } - else - nil end, createUrl: !@user.id.eql?('uid-0') ? create_url : nil, templates: @user.templates ? templates : nil, From f4d838710c3e03144dda4ddf69aa175ac1b5aa13 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:25:59 +0300 Subject: [PATCH 086/176] ruby: Style/MultilineIfModifier correct --- web/documentserver-example/ruby/app/models/track_helper.rb | 6 ++++-- web/documentserver-example/ruby/app/models/users.rb | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 72fdb5b3..c833ee45 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -234,8 +234,10 @@ class TrackHelper end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, - user_address) if new_file_name + if new_file_name + file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, + user_address) + end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') # if the path to the new file doesn't exist, create it diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 6d178dcd..e66c942f 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -128,8 +128,10 @@ class Users def get_users_for_mentions(id) usersData = [] @@users.each do |user| - usersData.push({ name: user.name, - email: user.email }) if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? + if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? + usersData.push({ name: user.name, + email: user.email }) + end end usersData end From 684fa89c1354020f37c8fe40181d23abd7b55b23 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 14:57:15 +0300 Subject: [PATCH 087/176] ruby: Style/EmptyLineAfterMagicComment correct --- web/documentserver-example/ruby/Gemfile | 1 + web/documentserver-example/ruby/Rakefile | 1 + .../ruby/app/controllers/application_controller.rb | 1 + .../ruby/app/controllers/home_controller.rb | 1 + .../ruby/app/helpers/application_helper.rb | 1 + web/documentserver-example/ruby/app/helpers/home_helper.rb | 1 + web/documentserver-example/ruby/app/models/document_helper.rb | 1 + web/documentserver-example/ruby/app/models/file_model.rb | 1 + web/documentserver-example/ruby/app/models/file_utility.rb | 1 + web/documentserver-example/ruby/app/models/jwt_helper.rb | 1 + web/documentserver-example/ruby/app/models/service_converter.rb | 1 + web/documentserver-example/ruby/app/models/track_helper.rb | 1 + web/documentserver-example/ruby/app/models/users.rb | 1 + web/documentserver-example/ruby/config.ru | 1 + web/documentserver-example/ruby/config/application.rb | 1 + web/documentserver-example/ruby/config/boot.rb | 1 + 16 files changed, 16 insertions(+) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 45e26a0c..753e0bdf 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -1,4 +1,5 @@ # frozen_string_literal: true + source 'https://rubygems.org' gem 'byebug', '~> 11.1', groups: %i[development test] diff --git a/web/documentserver-example/ruby/Rakefile b/web/documentserver-example/ruby/Rakefile index bb892095..fd960c20 100644 --- a/web/documentserver-example/ruby/Rakefile +++ b/web/documentserver-example/ruby/Rakefile @@ -1,4 +1,5 @@ # frozen_string_literal: true + require 'rake/testtask' require_relative 'config/application' diff --git a/web/documentserver-example/ruby/app/controllers/application_controller.rb b/web/documentserver-example/ruby/app/controllers/application_controller.rb index b6d3299e..7f694b6c 100644 --- a/web/documentserver-example/ruby/app/controllers/application_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/application_controller.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 86a5a7e2..56a2a6f7 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/helpers/application_helper.rb b/web/documentserver-example/ruby/app/helpers/application_helper.rb index 3e7976e0..8e77b5bd 100644 --- a/web/documentserver-example/ruby/app/helpers/application_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/application_helper.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/helpers/home_helper.rb b/web/documentserver-example/ruby/app/helpers/home_helper.rb index 421fa078..de869727 100644 --- a/web/documentserver-example/ruby/app/helpers/home_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/home_helper.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index e73bf1a2..78bd7e16 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index f39ece39..ed2b53fa 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/file_utility.rb b/web/documentserver-example/ruby/app/models/file_utility.rb index 5e7965a8..b25c3d3b 100644 --- a/web/documentserver-example/ruby/app/models/file_utility.rb +++ b/web/documentserver-example/ruby/app/models/file_utility.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 842c89f2..1ca70519 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index a598fa90..3990af67 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c833ee45..4582f25a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index e66c942f..9ce9730e 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + # # (c) Copyright Ascensio System SIA 2023 # diff --git a/web/documentserver-example/ruby/config.ru b/web/documentserver-example/ruby/config.ru index edb2b97b..ff628ad7 100644 --- a/web/documentserver-example/ruby/config.ru +++ b/web/documentserver-example/ruby/config.ru @@ -1,4 +1,5 @@ # frozen_string_literal: true + require_relative 'config/application' Rails.application.initialize! diff --git a/web/documentserver-example/ruby/config/application.rb b/web/documentserver-example/ruby/config/application.rb index 6f8a36e1..94076a0f 100644 --- a/web/documentserver-example/ruby/config/application.rb +++ b/web/documentserver-example/ruby/config/application.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + require_relative 'boot' require 'active_model/railtie' diff --git a/web/documentserver-example/ruby/config/boot.rb b/web/documentserver-example/ruby/config/boot.rb index 3ceeeffe..2d46de4c 100644 --- a/web/documentserver-example/ruby/config/boot.rb +++ b/web/documentserver-example/ruby/config/boot.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) require 'bundler/setup' From f87fc045d331fad3a83af45a40ec2a33a3e40ea7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 15:00:09 +0300 Subject: [PATCH 088/176] ruby: Lint/UselessAssignment correct --- .../ruby/app/controllers/home_controller.rb | 8 ++++---- .../ruby/app/models/file_model.rb | 2 +- .../ruby/app/models/track_helper.rb | 12 ++++++------ 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 56a2a6f7..154d64f1 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -162,7 +162,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] version = params[:ver] file = params[:file] - isEmbedded = params[:dmode] + params[:dmode] if JwtHelper.is_enabled && JwtHelper.use_for_request jwtHeader = HomeController.config_manager.jwt_header @@ -190,7 +190,7 @@ class HomeController < ApplicationController response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" send_file file_path, x_sendfile: true - rescue StandardError => ex + rescue StandardError render plain: '{ "error": "File not found"}' end @@ -210,7 +210,7 @@ class HomeController < ApplicationController if status == 1 && (file_data['actions'][0]['type']).zero? # finished edit user = file_data['actions'][0]['userid'] # get the user id unless file_data['users'].index(user) - json_data = TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command + TrackHelper.command_request('forcesave', file_data['key']) # call the forcesave command end end @@ -306,7 +306,7 @@ class HomeController < ApplicationController response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" send_file file_path, x_sendfile: true - rescue StandardError => ex + rescue StandardError render plain: '{ "error": "File not found"}' end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index ed2b53fa..164b199e 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -264,7 +264,7 @@ end if i > 1 # check if the version number is greater than 1 changes = nil - change = nil + nil # get the path to the changes.json file File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| changes = JSON.parse(file.read) # and parse its content diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 4582f25a..c97b1276 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -108,7 +108,7 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data( + _, new_file_uri, _ = ServiceConverter.get_converted_data( download_uri, download_ext.delete('.'), cur_ext.delete('.'), @@ -124,7 +124,7 @@ class TrackHelper else download_uri = new_file_uri end - rescue StandardError => msg + rescue StandardError new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) end @@ -173,7 +173,7 @@ class TrackHelper end saved = 0 - rescue StandardError => msg + rescue StandardError saved = 1 end @@ -198,7 +198,7 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - percent, new_file_uri, new_file_type = ServiceConverter.get_converted_data( + _, new_file_uri, _ = ServiceConverter.get_converted_data( download_uri, download_ext.delete('.'), cur_ext.delete('.'), @@ -211,7 +211,7 @@ class TrackHelper else download_uri = new_file_uri end - rescue StandardError => msg + rescue StandardError new_file_name = true end end @@ -255,7 +255,7 @@ class TrackHelper end saved = 0 - rescue StandardError => msg + rescue StandardError saved = 1 end From c0135c52c5db8c465d88cede93d47b1419283b60 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 15:02:01 +0300 Subject: [PATCH 089/176] ruby: Layout/TrailingWhitespace correct --- .../ruby/app/models/document_helper.rb | 45 ++++++++----------- .../ruby/app/models/file_model.rb | 26 +++++------ .../ruby/app/models/track_helper.rb | 1 - 3 files changed, 32 insertions(+), 40 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 78bd7e16..6f21b61f 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -216,7 +216,6 @@ class DocumentHelper "#{DocumentHelper.config_manager.storage_path}/" \ "#{cur_user_host_address(nil)}/" \ "#{ERB::Util.url_encode(file_name)}" - end # get history path url @@ -226,15 +225,13 @@ class DocumentHelper "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ "&file=#{ERB::Util.url_encode(file)}#{user_host}" - end # get server url def get_server_url(for_document_server) - return DocumentHelper.config_manager.example_uri.to_s if + return DocumentHelper.config_manager.example_uri.to_s if for_document_server && DocumentHelper.config_manager.example_uri - @@base_url end @@ -260,34 +257,30 @@ class DocumentHelper # get internal file extension by its type def get_internal_extension(file_type) case file_type - when 'word' # .docx for word type - '.docx' - when 'cell' # .xlsx for cell type - '.xlsx' - when 'slide' # .pptx for slide type - '.pptx' - else - '.docx' # the default value is .docx - end - - + when 'word' # .docx for word type + '.docx' + when 'cell' # .xlsx for cell type + '.xlsx' + when 'slide' # .pptx for slide type + '.pptx' + else + '.docx' # the default value is .docx + end end # get image url for templates def get_template_image_url(file_type) path = "#{get_server_url(true)}/assets/" case file_type - when 'word' # for word type - "#{path}file_docx.svg" - when 'cell' # .xlsx for cell type - "#{path}file_xlsx.svg" - when 'slide' # .pptx for slide type - "#{path}file_pptx.svg" - else - "#{path}file_docx.svg" # the default value is .docx - end - - + when 'word' # for word type + "#{path}file_docx.svg" + when 'cell' # .xlsx for cell type + "#{path}file_xlsx.svg" + when 'slide' # .pptx for slide type + "#{path}file_pptx.svg" + else + "#{path}file_docx.svg" # the default value is .docx + end end # get files information diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 164b199e..b9ffbc70 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -52,11 +52,11 @@ class FileModel # get file uri for document server def file_uri_user if @config_manager.storage_path.absolute? - "#{download_url}&dmode=emb" -else - DocumentHelper.get_file_uri(@file_name, - false) -end + "#{download_url}&dmode=emb" + else + DocumentHelper.get_file_uri(@file_name, + false) + end end # get document type from its name (word, cell or slide) @@ -150,9 +150,9 @@ end referenceData: { instanceId: DocumentHelper.get_server_url(false), fileKey: if !@user.id.eql?('uid-0') - { fileName: @file_name, - userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json -end + { fileName: @file_name, + userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json + end } }, editorConfig: { @@ -254,11 +254,11 @@ end if is_enable_direct_url == true dataObj['directUrl'] = if i == cur_ver - download_url(false) -else - DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", - false) -end + download_url(false) + else + DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", + false) + end end dataObj['version'] = i diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c97b1276..65885d46 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -297,7 +297,6 @@ class TrackHelper end JSON.parse(data) # convert the response body into the json format - end # save file from the url From ea15f12551a56dfeb342c86812290f040527524c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Wed, 15 Nov 2023 18:18:56 +0300 Subject: [PATCH 090/176] ruby: Style/TrailingUnderscoreVariable correct --- web/documentserver-example/ruby/app/models/track_helper.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 65885d46..c0b77908 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -108,7 +108,7 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - _, new_file_uri, _ = ServiceConverter.get_converted_data( + _, new_file_uri, = ServiceConverter.get_converted_data( download_uri, download_ext.delete('.'), cur_ext.delete('.'), @@ -198,7 +198,7 @@ class TrackHelper unless cur_ext.eql?(download_ext) key = ServiceConverter.generate_revision_id(download_uri) # get the document key begin - _, new_file_uri, _ = ServiceConverter.get_converted_data( + _, new_file_uri, = ServiceConverter.get_converted_data( download_uri, download_ext.delete('.'), cur_ext.delete('.'), From c639ba42877ae1a86cb4666ba9d32f5dc11380ff Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 10:15:11 +0300 Subject: [PATCH 091/176] ruby: Style/NegatedIf correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index b9ffbc70..533207f8 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -149,7 +149,7 @@ class FileModel }, referenceData: { instanceId: DocumentHelper.get_server_url(false), - fileKey: if !@user.id.eql?('uid-0') + fileKey: unless @user.id.eql?('uid-0') { fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json end From c5315de84f035349602ad9a67e5ee3b94e1921a8 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 10:16:22 +0300 Subject: [PATCH 092/176] ruby: Lint/Void correct --- web/documentserver-example/ruby/app/models/file_model.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 533207f8..9a2c3c28 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -264,7 +264,6 @@ class FileModel if i > 1 # check if the version number is greater than 1 changes = nil - nil # get the path to the changes.json file File.open(File.join(DocumentHelper.version_dir(hist_dir, i - 1), 'changes.json'), 'r') do |file| changes = JSON.parse(file.read) # and parse its content From acdb60dd3b938d2652ab38fa3f07520ce08c392c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 11:48:56 +0300 Subject: [PATCH 093/176] ruby: Style/ClassVars correct --- .../ruby/app/models/document_helper.rb | 14 +++++----- .../ruby/app/models/service_converter.rb | 10 +++---- .../ruby/app/models/track_helper.rb | 6 ++-- .../ruby/app/models/users.rb | 28 +++++++++---------- 4 files changed, 29 insertions(+), 29 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 6f21b61f..279efe07 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -27,14 +27,14 @@ class DocumentHelper attr_reader :config_manager, :format_manager end - @@runtime_cache = {} - @@remote_ip = nil - @@base_url = nil + @runtime_cache = {} + @remote_ip = nil + @base_url = nil class << self def init(ip, url) - @@remote_ip = ip - @@base_url = url + @remote_ip = ip + @base_url = url end # define max file size @@ -68,7 +68,7 @@ class DocumentHelper # get current user host address def cur_user_host_address(user_address) - (user_address.nil? ? @@remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_') + (user_address.nil? ? @remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_') end # get the storage path of the given file @@ -233,7 +233,7 @@ class DocumentHelper for_document_server && DocumentHelper.config_manager.example_uri - @@base_url + @base_url end # get callback url diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 3990af67..832e0964 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -25,8 +25,8 @@ class ServiceConverter attr_reader :config_manager end - @@convert_timeout = ServiceConverter.config_manager.convertation_timeout - @@document_converter_url = ServiceConverter.config_manager.document_server_converter_uri.to_s + @convert_timeout = ServiceConverter.config_manager.convertation_timeout + @document_converter_url = ServiceConverter.config_manager.document_server_converter_uri.to_s class << self # get the url of the converted file @@ -54,12 +54,12 @@ class ServiceConverter data = nil begin - uri = URI.parse(@@document_converter_url) # create the request url + uri = URI.parse(@document_converter_url) # create the request url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - DocumentHelper.verify_ssl(@@document_converter_url, http) + DocumentHelper.verify_ssl(@document_converter_url, http) - http.read_timeout = @@convert_timeout + http.read_timeout = @convert_timeout http.open_timeout = 5 req = Net::HTTP::Post.new(uri.request_uri) # create the post request req.add_field('Accept', 'application/json') # set headers diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index c0b77908..d900867b 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -29,7 +29,7 @@ class TrackHelper attr_reader :config_manager, :proxy_manager end - @@document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s + @document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s class << self # read the request body @@ -274,10 +274,10 @@ class TrackHelper data = nil begin - uri = URI.parse(@@document_command_url) # parse the document command url + uri = URI.parse(@document_command_url) # parse the document command url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - DocumentHelper.verify_ssl(@@document_command_url, http) + DocumentHelper.verify_ssl(@document_command_url, http) req = Net::HTTP::Post.new(uri.request_uri) # create the post request req.add_field('Content-Type', 'application/json') # set headers diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 9ce9730e..146dee2c 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -38,7 +38,7 @@ class User end class Users - @@descr_user_1 = [ + @descr_user_1 = [ 'File author by default', 'Doesn’t belong to any group', 'Can review all the changes', @@ -49,7 +49,7 @@ class Users 'Has an avatar' ] - @@descr_user_2 = [ + @descr_user_2 = [ 'Belongs to Group2', 'Can review only his own changes or changes made by users with no group', 'Can view comments, edit his own comments, and comments left by users with no group. ' \ @@ -60,7 +60,7 @@ class Users 'Has an avatar' ] - @@descr_user_3 = [ + @descr_user_3 = [ 'Belongs to Group3', 'Can review changes made by Group2 users', 'Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users', @@ -72,7 +72,7 @@ class Users 'Can see the information about Group2 users' ] - @@descr_user_0 = [ + @descr_user_0 = [ 'The name is requested when the editor is opened', 'Doesn’t belong to any group', 'Can review all the changes', @@ -87,10 +87,10 @@ class Users 'View file without collaboration' ] - @@users = [ + @users = [ User.new('uid-1', 'John Smith', 'smith@example.com', '', nil, {}, nil, - nil, [], @@descr_user_1, true, true), + nil, [], @descr_user_1, true, true), User.new('uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', ['group-2', ''], { view: '', @@ -98,7 +98,7 @@ class Users remove: ['group-2'] }, ['group-2', ''], - true, [], @@descr_user_2, false, true), + true, [], @descr_user_2, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { view: %w[group-3 group-2], @@ -106,29 +106,29 @@ class Users remove: [] }, ['group-2'], - false, %w[copy download print], @@descr_user_3, false, false), + false, %w[copy download print], @descr_user_3, false, false), User.new('uid-0', nil, nil, '', nil, {}, [], - nil, ['protect'], @@descr_user_0, false, false) + nil, ['protect'], @descr_user_0, false, false) ] class << self def get_all_users - @@users + @users end # get a user by id specified def get_user(id) - @@users.each do |user| + @users.each do |user| return user if user.id.eql?(id) end - @@users[0] + @users[0] end # get a list of users with their names and emails for mentions def get_users_for_mentions(id) usersData = [] - @@users.each do |user| + @users.each do |user| if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? usersData.push({ name: user.name, email: user.email }) @@ -140,7 +140,7 @@ class Users # get a list of users with their id, names and emails for protect def get_users_for_protect(id) users_data = [] - @@users.each do |user| + @users.each do |user| users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? end users_data From 4536f83d105527206b06f2a18e2ed4e4f32dc9ba Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 12:26:27 +0300 Subject: [PATCH 094/176] ruby: Style/OptionalBooleanParameter correct --- .../ruby/app/controllers/home_controller.rb | 2 +- .../ruby/app/models/document_helper.rb | 4 ++-- .../ruby/app/models/file_model.rb | 14 +++++++------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 154d64f1..3a90bdd6 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -424,7 +424,7 @@ class HomeController < ApplicationController ".#{File.mtime(DocumentHelper.storage_path(fileName, nil))}" ), url: DocumentHelper.get_download_url(fileName), - directUrl: body['directUrl'] ? DocumentHelper.get_download_url(fileName, false) : nil, + directUrl: body['directUrl'] ? DocumentHelper.get_download_url(fileName, is_serverUrl: false) : nil, referenceData: { instanceId: DocumentHelper.get_server_url(false), fileKey: { fileName:, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 279efe07..b31fec82 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -219,7 +219,7 @@ class DocumentHelper end # get history path url - def get_historypath_uri(file_name, version, file, is_serverUrl = true) + def get_historypath_uri(file_name, version, file, is_serverUrl: true) # for redirection to my link user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ @@ -249,7 +249,7 @@ class DocumentHelper end # get url to download a file - def get_download_url(file_name, is_serverUrl = true) + def get_download_url(file_name, is_serverUrl: true) user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' "#{get_server_url(is_serverUrl)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 9a2c3c28..04f316dc 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -82,8 +82,8 @@ class FileModel end # get url to download a file - def download_url(is_serverUrl = true) - DocumentHelper.get_download_url(@file_name, is_serverUrl) + def download_url(is_serverUrl: true) + DocumentHelper.get_download_url(@file_name, is_serverUrl:) end # get current user host address @@ -123,7 +123,7 @@ class FileModel document: { title: @file_name, url: download_url, - directUrl: is_enable_direct_url ? download_url(false) : '', + directUrl: is_enable_direct_url ? download_url(is_serverUrl: false) : '', fileType: file_ext.delete('.'), key:, info: { @@ -176,11 +176,11 @@ class FileModel }, embedded: { # the parameters for the embedded document type # the absolute URL that will allow the document to be saved onto the user personal computer - saveUrl: download_url(false), + saveUrl: download_url(is_serverUrl: false), # the absolute URL to the document serving as a source file for the document embedded into the web page - embedUrl: download_url(false), + embedUrl: download_url(is_serverUrl: false), # the absolute URL that will allow other users to share this document - shareUrl: download_url(false), + shareUrl: download_url(is_serverUrl: false), toolbarDocked: 'top' # the place for the embedded viewer toolbar (top or bottom) }, customization: { # the parameters for the editor interface @@ -254,7 +254,7 @@ class FileModel if is_enable_direct_url == true dataObj['directUrl'] = if i == cur_ver - download_url(false) + download_url(is_serverUrl: false) else DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) From 1cd457c5c6656253bbe68f8937b4689a5e279f59 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 13:35:06 +0300 Subject: [PATCH 095/176] ruby: Lint/DuplicateMethods correct --- web/documentserver-example/ruby/app/models/file_model.rb | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 04f316dc..fab5a02f 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -26,7 +26,7 @@ class FileModel def initialize(attributes = {}) @file_name = attributes[:file_name] @mode = attributes[:mode] - @type = attributes[:type] + @type = attributes[:type] || 'desktop' # the default platform type is desktop @user_ip = attributes[:user_ip] @lang = attributes[:lang] @user = attributes[:user] @@ -35,10 +35,6 @@ class FileModel @config_manager = ConfigurationManager.new end - def type - @type || 'desktop' # the default platform type is desktop - end - # get file extension from its name def file_ext File.extname(@file_name).downcase From 902ad1341cc24ca1bbfbfeb585f4e2043f7aa731 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 16 Nov 2023 15:16:47 +0300 Subject: [PATCH 096/176] ruby: Naming/RescuedExceptionsVariableName correct --- .../ruby/app/controllers/home_controller.rb | 16 ++++++++-------- .../ruby/app/models/service_converter.rb | 4 ++-- .../ruby/app/models/track_helper.rb | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 3a90bdd6..7f1e5c09 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -86,8 +86,8 @@ class HomeController < ApplicationController # write a new file name to the response render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" - rescue StandardError => ex - render plain: "{ \"error\": \"#{ex.message}\"}" # write an error message to the response + rescue StandardError => e + render plain: "{ \"error\": \"#{e.message}\"}" # write an error message to the response end end @@ -152,8 +152,8 @@ class HomeController < ApplicationController end render plain: "{ \"filename\" : \"#{file_name}\"}" - rescue StandardError => ex - render plain: "{ \"error\": \"#{ex.message}\"}" + rescue StandardError => e + render plain: "{ \"error\": \"#{e.message}\"}" end # downloading a history file from public @@ -349,8 +349,8 @@ class HomeController < ApplicationController render plain: "{\"file\" : \"#{file_name}\"}" nil - rescue StandardError => ex - render plain: "{\"error\":1, \"message\": \"#{ex.message}\"}" + rescue StandardError => e + render plain: "{\"error\":1, \"message\": \"#{e.message}\"}" nil end @@ -498,10 +498,10 @@ class HomeController < ApplicationController error: nil, success: true } - rescue StandardError => error + rescue StandardError => e response.status = :internal_server_error render json: { - error: error.message, + error: e.message, success: false } end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 832e0964..15db3f25 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -81,8 +81,8 @@ class ServiceConverter data = res.body # and take its body rescue Timeout::Error # try again - rescue StandardError => ex - raise ex.message + rescue StandardError => e + raise e.message end json_data = JSON.parse(data) # parse response body diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index d900867b..558850dd 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -292,8 +292,8 @@ class TrackHelper req.body = payload.to_json # convert the payload object into the json format res = http.request(req) # get the response data = res.body # and take its body - rescue StandardError => ex - raise ex.message + rescue StandardError => e + raise e.message end JSON.parse(data) # convert the response body into the json format From dafc66d5d842b3338d6d5bca215a0264c30d1a71 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Sun, 19 Nov 2023 02:38:42 +0300 Subject: [PATCH 097/176] ruby: Style/Documentation correct --- .../ruby/app/configuration/configuration.rb | 1 + .../app/configuration/configuration_tests.rb | 16 ++++++++++++++++ .../ruby/app/controllers/home_controller.rb | 1 + .../ruby/app/format/format.rb | 2 ++ .../ruby/app/format/format_tests.rb | 9 +++++++++ .../ruby/app/helpers/application_helper.rb | 1 + .../ruby/app/helpers/home_helper.rb | 1 + .../ruby/app/models/document_helper.rb | 1 + .../ruby/app/models/file_model.rb | 1 + .../ruby/app/models/file_utility.rb | 1 + .../ruby/app/models/jwt_helper.rb | 1 + .../ruby/app/models/service_converter.rb | 1 + .../ruby/app/models/track_helper.rb | 1 + .../ruby/app/models/users.rb | 2 ++ .../ruby/app/proxy/proxy.rb | 1 + .../ruby/app/proxy/proxy_tests.rb | 6 ++++++ .../ruby/config/application.rb | 1 + 17 files changed, 47 insertions(+) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index c2c1846f..c4efd7fe 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -22,6 +22,7 @@ require 'pathname' require 'sorbet-runtime' require 'uri' +# ConfigurationManager manages configuration settings for the application. class ConfigurationManager extend T::Sig diff --git a/web/documentserver-example/ruby/app/configuration/configuration_tests.rb b/web/documentserver-example/ruby/app/configuration/configuration_tests.rb index d98e8977..ccf94cdf 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration_tests.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration_tests.rb @@ -20,6 +20,7 @@ require 'test/unit' require_relative 'configuration' +# Enviroment module provides a mechanism for capturing and restoring the environment. module Enviroment def initialize(name) @env = ENV.to_hash @@ -31,6 +32,7 @@ module Enviroment end end +# For testing the ConfigurationManager class. class ConfigurationManagerTests < Test::Unit::TestCase def test_corresponds_the_latest_version config_manager = ConfigurationManager.new @@ -38,6 +40,7 @@ class ConfigurationManagerTests < Test::Unit::TestCase end end +# For testing the example_uri method of ConfigurationManager. class ConfigurationManagerExampleURITests < Test::Unit::TestCase include Enviroment @@ -55,6 +58,7 @@ class ConfigurationManagerExampleURITests < Test::Unit::TestCase end end +# For testing the document_server_public_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerPublicURITests < Test::Unit::TestCase include Enviroment @@ -72,6 +76,7 @@ class ConfigurationManagerDocumentServerPublicURITests < Test::Unit::TestCase end end +# For testing the document_server_private_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerPrivateURITests < Test::Unit::TestCase include Enviroment @@ -89,6 +94,7 @@ class ConfigurationManagerDocumentServerPrivateURITests < Test::Unit::TestCase end end +# For testing the document_server_api_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerAPIURITests < Test::Unit::TestCase include Enviroment @@ -112,6 +118,7 @@ class ConfigurationManagerDocumentServerAPIURITests < Test::Unit::TestCase end end +# For testing the document_server_preloader_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerPreloaderURITests < Test::Unit::TestCase include Enviroment @@ -135,6 +142,7 @@ class ConfigurationManagerDocumentServerPreloaderURITests < Test::Unit::TestCase end end +# For testing the document_server_command_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerCommandURITests < Test::Unit::TestCase include Enviroment @@ -158,6 +166,7 @@ class ConfigurationManagerDocumentServerCommandURITests < Test::Unit::TestCase end end +# For testing the document_server_converter_uri method of ConfigurationManager. class ConfigurationManagerDocumentServerConverterURITests < Test::Unit::TestCase include Enviroment @@ -181,6 +190,7 @@ class ConfigurationManagerDocumentServerConverterURITests < Test::Unit::TestCase end end +# For testing the jwt_secret method of ConfigurationManager. class ConfigurationManagerJWTSecretTests < Test::Unit::TestCase include Enviroment @@ -198,6 +208,7 @@ class ConfigurationManagerJWTSecretTests < Test::Unit::TestCase end end +# For testing the jwt_header method of ConfigurationManager. class ConfigurationManagerJWTHeaderTests < Test::Unit::TestCase include Enviroment @@ -215,6 +226,7 @@ class ConfigurationManagerJWTHeaderTests < Test::Unit::TestCase end end +# For testing the jwt_use_for_request method of ConfigurationManager. class ConfigurationManagerJWTUseForRequest < Test::Unit::TestCase include Enviroment @@ -232,6 +244,7 @@ class ConfigurationManagerJWTUseForRequest < Test::Unit::TestCase end end +# For testing the ssl_verify_peer_mode_enabled method of ConfigurationManager. class ConfigurationManagerSSLTests < Test::Unit::TestCase include Enviroment @@ -249,6 +262,7 @@ class ConfigurationManagerSSLTests < Test::Unit::TestCase end end +# For testing the storage_path method of ConfigurationManager. class ConfigurationManagerStoragePathTests < Test::Unit::TestCase include Enviroment @@ -275,6 +289,7 @@ class ConfigurationManagerStoragePathTests < Test::Unit::TestCase end end +# For testing the maximum_file_size method of ConfigurationManager. class ConfigurationManagerMaximumFileSizeTests < Test::Unit::TestCase include Enviroment @@ -292,6 +307,7 @@ class ConfigurationManagerMaximumFileSizeTests < Test::Unit::TestCase end end +# For testing the convertation_timeout method of ConfigurationManager. class ConfigurationManagerConversionTimeoutTests < Test::Unit::TestCase def test_assigns_a_default_value config_manager = ConfigurationManager.new diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 7f1e5c09..fb1dcbd6 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -21,6 +21,7 @@ require 'net/http' require 'mimemagic' require_relative '../configuration/configuration' +# Handling requests controller class HomeController < ApplicationController @config_manager = ConfigurationManager.new diff --git a/web/documentserver-example/ruby/app/format/format.rb b/web/documentserver-example/ruby/app/format/format.rb index 59bb56ea..03f1a04e 100644 --- a/web/documentserver-example/ruby/app/format/format.rb +++ b/web/documentserver-example/ruby/app/format/format.rb @@ -20,6 +20,7 @@ require 'pathname' require 'sorbet-runtime' +# Struct representing a document format with properties. class Format < T::Struct extend T::Sig @@ -40,6 +41,7 @@ class Format < T::Struct end end +# FormatManager is responsible for managing document formats and providing various lists of supported extensions. class FormatManager extend T::Sig diff --git a/web/documentserver-example/ruby/app/format/format_tests.rb b/web/documentserver-example/ruby/app/format/format_tests.rb index 62fba266..8f199c24 100644 --- a/web/documentserver-example/ruby/app/format/format_tests.rb +++ b/web/documentserver-example/ruby/app/format/format_tests.rb @@ -21,6 +21,7 @@ require 'json' require 'test/unit' require_relative 'format' +# Test case for the Format class. class FormatTests < Test::Unit::TestCase def test_generates_extension content = @@ -39,6 +40,7 @@ class FormatTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "all" formats. class FormatManagerAllTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -46,6 +48,7 @@ class FormatManagerAllTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "documents" formats. class FormatManagerDocumentsTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -53,6 +56,7 @@ class FormatManagerDocumentsTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "presentations" formats. class FormatManagerPresentationsTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -60,6 +64,7 @@ class FormatManagerPresentationsTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "spreadsheets" formats. class FormatManagerSpreadsheetsTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -67,6 +72,7 @@ class FormatManagerSpreadsheetsTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "all convertible" formats. class FormatManagerConvertibleTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -74,6 +80,7 @@ class FormatManagerConvertibleTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "all editable" formats. class FormatManagerEditableTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -81,6 +88,7 @@ class FormatManagerEditableTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "all viewable" formats. class FormatManagerViewableTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new @@ -88,6 +96,7 @@ class FormatManagerViewableTests < Test::Unit::TestCase end end +# Test case for the FormatManager class, checks availability "all filable" formats. class FormatManagerFilableTests < Test::Unit::TestCase def test_loads format_manager = FormatManager.new diff --git a/web/documentserver-example/ruby/app/helpers/application_helper.rb b/web/documentserver-example/ruby/app/helpers/application_helper.rb index 8e77b5bd..4715a54e 100644 --- a/web/documentserver-example/ruby/app/helpers/application_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/application_helper.rb @@ -16,5 +16,6 @@ # limitations under the License. # +# Helper for application module ApplicationHelper end diff --git a/web/documentserver-example/ruby/app/helpers/home_helper.rb b/web/documentserver-example/ruby/app/helpers/home_helper.rb index de869727..71cde17a 100644 --- a/web/documentserver-example/ruby/app/helpers/home_helper.rb +++ b/web/documentserver-example/ruby/app/helpers/home_helper.rb @@ -16,5 +16,6 @@ # limitations under the License. # +# Helper for home module HomeHelper end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index b31fec82..e1cc3495 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -19,6 +19,7 @@ require_relative '../configuration/configuration' require_relative '../format/format' +# Class that provides various utility methods related to documents. class DocumentHelper @config_manager = ConfigurationManager.new @format_manager = FormatManager.new diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index fab5a02f..afd86c1f 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -18,6 +18,7 @@ require_relative '../configuration/configuration' +# Class for handling file-related operations and information. class FileModel attr_accessor :file_name, :mode, :type, :user_ip, :lang, :user, :action_data, :direct_url attr_reader :config_manager diff --git a/web/documentserver-example/ruby/app/models/file_utility.rb b/web/documentserver-example/ruby/app/models/file_utility.rb index b25c3d3b..52551f2a 100644 --- a/web/documentserver-example/ruby/app/models/file_utility.rb +++ b/web/documentserver-example/ruby/app/models/file_utility.rb @@ -18,6 +18,7 @@ require_relative '../format/format' +# Determination file type based on extensions, utilizing `@format_manager` for format management. class FileUtility @format_manager = FormatManager.new diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 1ca70519..1a76b114 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -19,6 +19,7 @@ require 'jwt' require_relative '../configuration/configuration' +# Helper class for JSON Web Token (JWT) operations, including encoding and decoding. class JwtHelper @jwt_secret = ConfigurationManager.new.jwt_secret @token_use_for_request = ConfigurationManager.new.jwt_use_for_request diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 15db3f25..c5475d6c 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -18,6 +18,7 @@ require_relative '../configuration/configuration' +# Class responsible for converting documents using a document conversion service. class ServiceConverter @config_manager = ConfigurationManager.new diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 558850dd..a396ccd2 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -21,6 +21,7 @@ require 'uri' require_relative '../configuration/configuration' require_relative '../proxy/proxy' +# Helper class for managing document tracking functionalities, such as saving and processing documents. class TrackHelper @config_manager = ConfigurationManager.new @proxy_manager = ProxyManager.new(config_manager: @config_manager) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 146dee2c..cb58a04e 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -16,6 +16,7 @@ # limitations under the License. # +# Represents a user with various attributes class User attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, :deniedPermissions, :descriptions, :templates, :avatar @@ -37,6 +38,7 @@ class User end end +# Manages user-related data and operations. class Users @descr_user_1 = [ 'File author by default', diff --git a/web/documentserver-example/ruby/app/proxy/proxy.rb b/web/documentserver-example/ruby/app/proxy/proxy.rb index fd5a364c..8fee7df3 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy.rb @@ -21,6 +21,7 @@ require 'sorbet-runtime' require 'uri' require_relative '../configuration/configuration' +# Class manages URI resolution, redirecting public URLs to private ones based on the configuration. class ProxyManager extend T::Sig diff --git a/web/documentserver-example/ruby/app/proxy/proxy_tests.rb b/web/documentserver-example/ruby/app/proxy/proxy_tests.rb index e51d69d8..2240d09b 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy_tests.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy_tests.rb @@ -20,7 +20,9 @@ require 'test/unit' require_relative 'proxy' +# Test case for ProxyManager resolving URIs that refer to public and non-public URLs. class ProxyManagerRefersTests < Test::Unit::TestCase + # Mocked configuration manager for testing. class MockedConfigurationManager < ConfigurationManager def document_server_public_uri URI('http://localhost') @@ -31,6 +33,7 @@ class ProxyManagerRefersTests < Test::Unit::TestCase end end + # Test case to ensure resolving a URI that refers to the public URI. def test_resolves_a_uri_that_refers_to_the_public_uri config_manager = MockedConfigurationManager.new proxy_manager = ProxyManager.new(config_manager:) @@ -43,13 +46,16 @@ class ProxyManagerRefersTests < Test::Unit::TestCase end end +# Test case for ProxyManager resolving a URL that does not refer to the public URL. class ProxyManagerDoesNotRefersTests < Test::Unit::TestCase + # Mocked configuration manager for testing. class MockedConfigurationManager < ConfigurationManager def document_server_public_uri URI('http://localhost') end end + # Test case to ensure resolving a URL that does not refer to the public URL. def test_resolves_a_url_that_does_not_refers_to_the_public_url config_manager = MockedConfigurationManager.new proxy_manager = ProxyManager.new(config_manager:) diff --git a/web/documentserver-example/ruby/config/application.rb b/web/documentserver-example/ruby/config/application.rb index 94076a0f..f9c59aa3 100644 --- a/web/documentserver-example/ruby/config/application.rb +++ b/web/documentserver-example/ruby/config/application.rb @@ -11,6 +11,7 @@ Bundler.require(*Rails.groups) require 'securerandom' +# Configuration for the Rails application. class Application < Rails::Application config.middleware.insert_before 0, Rack::Cors do allow do From 9b0d3e1a2090cc561ef440ed962a03733c848a0a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Sun, 19 Nov 2023 23:39:10 +0300 Subject: [PATCH 098/176] ruby: Naming/VariableName correct --- .../ruby/app/controllers/home_controller.rb | 70 ++++---- .../ruby/app/models/document_helper.rb | 24 +-- .../ruby/app/models/file_model.rb | 156 +++++++++--------- .../ruby/app/models/service_converter.rb | 4 +- .../ruby/app/models/track_helper.rb | 16 +- .../ruby/app/models/users.rb | 23 ++- 6 files changed, 146 insertions(+), 147 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index fb1dcbd6..4e5ae852 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -166,9 +166,9 @@ class HomeController < ApplicationController params[:dmode] if JwtHelper.is_enabled && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header - if request.headers[jwtHeader] - hdr = request.headers[jwtHeader] + jwt_header = HomeController.config_manager.jwt_header + if request.headers[jwt_header] + hdr = request.headers[jwt_header] hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) if !token || token.eql?('') @@ -258,33 +258,33 @@ class HomeController < ApplicationController # getting files information def files file_id = params[:fileId] - filesInfo = DocumentHelper.get_files_info(file_id) # get the information about the file specified by a file id - render json: filesInfo + files_info = DocumentHelper.get_files_info(file_id) # get the information about the file specified by a file id + render json: files_info end # downloading a csv file def csv file_name = 'csv.csv' - csvPath = Rails.root.join('assets', 'document-templates', 'sample', file_name) + csv_path = Rails.root.join('assets', 'document-templates', 'sample', file_name) # add headers to the response to specify the page parameters - response.headers['Content-Length'] = File.size(csvPath).to_s - response.headers['Content-Type'] = MimeMagic.by_path(csvPath).type + response.headers['Content-Length'] = File.size(csv_path).to_s + response.headers['Content-Type'] = MimeMagic.by_path(csv_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file csvPath, x_sendfile: true + send_file csv_path, x_sendfile: true end # downloading a file def download file_name = File.basename(params[:fileName]) user_address = params[:userAddress] - isEmbedded = params[:dmode] + is_embedded = params[:dmode] - if JwtHelper.is_enabled && isEmbedded.nil? && !user_address.nil? && JwtHelper.use_for_request - jwtHeader = HomeController.config_manager.jwt_header - if request.headers[jwtHeader] - hdr = request.headers[jwtHeader] + if JwtHelper.is_enabled && is_embedded.nil? && !user_address.nil? && JwtHelper.use_for_request + jwt_header = HomeController.config_manager.jwt_header + if request.headers[jwt_header] + hdr = request.headers[jwt_header] hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) end @@ -376,20 +376,20 @@ class HomeController < ApplicationController # ReferenceData def reference body = JSON.parse(request.body.read) - fileName = '' + file_name = '' if body.key?('referenceData') - referenceData = body['referenceData'] - instanceId = referenceData['instanceId'] - if instanceId == DocumentHelper.get_server_url(false) - fileKey = JSON.parse(referenceData['fileKey']) - userAddress = fileKey['userAddress'] - fileName = fileKey['fileName'] if userAddress == DocumentHelper.cur_user_host_address(nil) + reference_data = body['referenceData'] + instance_id = reference_data['instanceId'] + if instance_id == DocumentHelper.get_server_url(false) + file_key = JSON.parse(reference_data['fileKey']) + user_address = file_key['userAddress'] + file_name = file_key['fileName'] if user_address == DocumentHelper.cur_user_host_address(nil) end end link = body['link'] - if fileName.empty? && body.key?('link') + if file_name.empty? && body.key?('link') unless link.include?(DocumentHelper.get_server_url(false)) data = { url: link, @@ -401,37 +401,37 @@ class HomeController < ApplicationController url_obj = URI(link) query_params = CGI.parse(url_obj.query) - fileName = query_params['fileName'].first - unless File.exist?(DocumentHelper.storage_path(fileName, nil)) + file_name = query_params['fileName'].first + unless File.exist?(DocumentHelper.storage_path(file_name, nil)) render plain: '{ "error": "File is not exist"}' return end end - if fileName.empty? && body.key?('path') + if file_name.empty? && body.key?('path') path = File.basename(body['path']) - fileName = path if File.exist?(DocumentHelper.storage_path(path, nil)) + file_name = path if File.exist?(DocumentHelper.storage_path(path, nil)) end - if fileName.empty? + if file_name.empty? render plain: '{ "error": "File not found"}' return end data = { - fileType: File.extname(fileName).downcase.delete('.'), + fileType: File.extname(file_name).downcase.delete('.'), key: ServiceConverter.generate_revision_id( - "#{DocumentHelper.cur_user_host_address(nil)}/#{fileName}" \ - ".#{File.mtime(DocumentHelper.storage_path(fileName, nil))}" + "#{DocumentHelper.cur_user_host_address(nil)}/#{file_name}" \ + ".#{File.mtime(DocumentHelper.storage_path(file_name, nil))}" ), - url: DocumentHelper.get_download_url(fileName), - directUrl: body['directUrl'] ? DocumentHelper.get_download_url(fileName, is_serverUrl: false) : nil, + url: DocumentHelper.get_download_url(file_name), + directUrl: body['directUrl'] ? DocumentHelper.get_download_url(file_name, is_serverUrl: false) : nil, referenceData: { instanceId: DocumentHelper.get_server_url(false), - fileKey: { fileName:, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json + fileKey: { fileName: file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json }, - path: fileName, - link: "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{fileName}" + path: file_name, + link: "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{file_name}" } data['token'] = JwtHelper.encode(data) if JwtHelper.is_enabled diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index e1cc3495..fa469917 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -141,10 +141,10 @@ class DocumentHelper # get the correct file name if such a name already exists def get_correct_name(file_name, user_address) - maxName = 50 + max_name = 50 ext = File.extname(file_name) # get file extension # get file name without extension - base_name = File.basename(file_name, ext)[0...maxName] + (file_name.length > maxName ? '[...]' : '') + base_name = File.basename(file_name, ext)[0...max_name] + (file_name.length > max_name ? '[...]' : '') name = base_name + ext.downcase # get full file name index = 1 @@ -220,10 +220,10 @@ class DocumentHelper end # get history path url - def get_historypath_uri(file_name, version, file, is_serverUrl: true) + def get_historypath_uri(file_name, version, file, is_server_url: true) # for redirection to my link - user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' - "#{get_server_url(is_serverUrl)}/downloadhistory/?"\ + user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' + "#{get_server_url(is_server_url)}/downloadhistory/?"\ "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ "&file=#{ERB::Util.url_encode(file)}#{user_host}" end @@ -250,9 +250,9 @@ class DocumentHelper end # get url to download a file - def get_download_url(file_name, is_serverUrl: true) - user_host = is_serverUrl ? "&userAddress=#{cur_user_host_address(nil)}" : '' - "#{get_server_url(is_serverUrl)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" + def get_download_url(file_name, is_server_url: true) + user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' + "#{get_server_url(is_server_url)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" end # get internal file extension by its type @@ -288,9 +288,9 @@ class DocumentHelper def get_files_info(file_id) result = [] - get_stored_files(nil).each do |fileName| # run through all the stored files from the folder - directory = storage_path(fileName, nil) - uri = "#{cur_user_host_address(nil)}/#{fileName}" + get_stored_files(nil).each do |file_name| # run through all the stored files from the folder + directory = storage_path(file_name, nil) + uri = "#{cur_user_host_address(nil)}/#{file_name}" # write file parameters to the info object info = { @@ -298,7 +298,7 @@ class DocumentHelper 'id' => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), 'contentLength' => "#{(File.size(directory) / 1024.0).round(2)} KB", 'pureContentLength' => File.size(directory), - 'title' => fileName, + 'title' => file_name, 'updated' => File.mtime(directory) } diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index afd86c1f..ea6d7745 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -79,8 +79,8 @@ class FileModel end # get url to download a file - def download_url(is_serverUrl: true) - DocumentHelper.get_download_url(@file_name, is_serverUrl:) + def download_url(is_server_url: true) + DocumentHelper.get_download_url(@file_name, is_server_url:) end # get current user host address @@ -90,17 +90,17 @@ class FileModel # get config parameters def get_config - editorsmode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded - canEdit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited - if (!canEdit && editorsmode.eql?('edit') || editorsmode.eql?('fillForms')) && + editors_mode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded + can_edit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited + if (!can_edit && editors_mode.eql?('edit') || editors_mode.eql?('fillForms')) && DocumentHelper.fill_forms_exts.include?(file_ext) - editorsmode = 'fillForms' - canEdit = true + editors_mode = 'fillForms' + can_edit = true end - submitForm = editorsmode.eql?('fillForms') && @user.id.eql?('uid-1') && false # the Submit form button state - mode = canEdit && !editorsmode.eql?('view') ? 'edit' : 'view' + submit_form = editors_mode.eql?('fillForms') && @user.id.eql?('uid-1') && false # the Submit form button state + mode = can_edit && !editors_mode.eql?('view') ? 'edit' : 'view' # templates image url in the "From Template" section - templatesImageUrl = DocumentHelper.get_template_image_url(document_type) + templates_image_url = DocumentHelper.get_template_image_url(document_type) templates = [ { image: '', @@ -108,7 +108,7 @@ class FileModel url: create_url }, { - image: templatesImageUrl, + image: templates_image_url, title: 'With sample content', url: "#{create_url}&sample=true" } @@ -120,7 +120,7 @@ class FileModel document: { title: @file_name, url: download_url, - directUrl: is_enable_direct_url ? download_url(is_serverUrl: false) : '', + directUrl: is_enable_direct_url ? download_url(is_server_url: false) : '', fileType: file_ext.delete('.'), key:, info: { @@ -129,20 +129,20 @@ class FileModel favorite: @user.favorite }, permissions: { # the permission for the document to be edited and downloaded or not - comment: !%w[view fillForms embedded blockcontent].include?(editorsmode), - copy: !@user.deniedPermissions.include?('copy'), - download: !@user.deniedPermissions.include?('download'), - edit: canEdit && %w[edit view filter blockcontent].include?(editorsmode), - print: !@user.deniedPermissions.include?('print'), - fillForms: !%w[view comment embedded blockcontent].include?(editorsmode), - modifyFilter: !editorsmode.eql?('filter'), - modifyContentControl: !editorsmode.eql?('blockcontent'), - review: canEdit && (editorsmode.eql?('edit') || editorsmode.eql?('review')), + comment: !%w[view fillForms embedded blockcontent].include?(editors_mode), + copy: !@user.denied_permissions.include?('copy'), + download: !@user.denied_permissions.include?('download'), + edit: can_edit && %w[edit view filter blockcontent].include?(editors_mode), + print: !@user.denied_permissions.include?('print'), + fillForms: !%w[view comment embedded blockcontent].include?(editors_mode), + modifyFilter: !editors_mode.eql?('filter'), + modifyContentControl: !editors_mode.eql?('blockcontent'), + review: can_edit && (editors_mode.eql?('edit') || editors_mode.eql?('review')), chat: !@user.id.eql?('uid-0'), - reviewGroups: @user.reviewGroups, - commentGroups: @user.commentGroups, - userInfoGroups: @user.userInfoGroups, - protect: !@user.deniedPermissions.include?('protect') + reviewGroups: @user.review_groups, + commentGroups: @user.comment_groups, + userInfoGroups: @user.user_info_groups, + protect: !@user.denied_permissions.include?('protect') }, referenceData: { instanceId: DocumentHelper.get_server_url(false), @@ -157,7 +157,7 @@ class FileModel mode:, lang: @lang || 'en', callbackUrl: callback_url, # absolute URL to the document storage service - coEditing: if editorsmode.eql?('view') && @user.id.eql?('uid-0') + coEditing: if editors_mode.eql?('view') && @user.id.eql?('uid-0') { mode: 'strict', change: false @@ -173,11 +173,11 @@ class FileModel }, embedded: { # the parameters for the embedded document type # the absolute URL that will allow the document to be saved onto the user personal computer - saveUrl: download_url(is_serverUrl: false), + saveUrl: download_url(is_server_url: false), # the absolute URL to the document serving as a source file for the document embedded into the web page - embedUrl: download_url(is_serverUrl: false), + embedUrl: download_url(is_server_url: false), # the absolute URL that will allow other users to share this document - shareUrl: download_url(is_serverUrl: false), + shareUrl: download_url(is_server_url: false), toolbarDocked: 'top' # the place for the embedded viewer toolbar (top or bottom) }, customization: { # the parameters for the editor interface @@ -185,7 +185,7 @@ class FileModel comments: true, feedback: true, # the Feedback & Support menu button display forcesave: false, # adding the request for the forced file saving to the callback handler - submitForm:, # the Submit form button state + submitForm: submit_form, # the Submit form button state goback: { url: DocumentHelper.get_server_url(false) } @@ -213,11 +213,11 @@ class FileModel if cur_ver.positive? # if file was modified hist = [] - histData = {} + hist_data = {} (1..cur_ver).each do |i| # run through all the file versions obj = {} - dataObj = {} + data_obj = {} ver_dir = DocumentHelper.version_dir(hist_dir, i) # get the path to the given file version # get document key @@ -245,19 +245,19 @@ class FileModel end # get the history data from the previous file version and write key and url information about it - dataObj['fileType'] = file_ext[1..file_ext.length] - dataObj['key'] = cur_key - dataObj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") + data_obj['fileType'] = file_ext[1..file_ext.length] + data_obj['key'] = cur_key + data_obj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") if is_enable_direct_url == true - dataObj['directUrl'] = + data_obj['directUrl'] = if i == cur_ver - download_url(is_serverUrl: false) + download_url(is_server_url: false) else DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", false) end end - dataObj['version'] = i + data_obj['version'] = i if i > 1 # check if the version number is greater than 1 changes = nil @@ -274,34 +274,34 @@ class FileModel obj['created'] = change ? change['created'] : nil obj['user'] = change ? change['user'] : nil - prev = histData[(i - 2).to_s] # get the history data from the previous file version + prev = hist_data[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url - dataObj['previous'] = if is_enable_direct_url == true - { # write key and url information about previous file version with optional directUrl - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'], - directUrl: prev['directUrl'] - } - else - { - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'] - } - end + data obj['previous'] = if is_enable_direct_url == true + { # write key and url information about previous file version with optional directUrl + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'], + directUrl: prev['directUrl'] + } + else + { + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'] + } + end # write the path to the diff.zip archive with differences in this file version - dataObj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') + data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') end if JwtHelper.is_enabled # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the data object - dataObj['token'] = JwtHelper.encode(dataObj) + data_obj['token'] = JwtHelper.encode(data_obj) end hist.push(obj) # add object dictionary to the hist list - histData[(i - 1).to_s] = dataObj # write data object information to the history data + hist_data[(i - 1).to_s] = data_obj # write data object information to the history data end return { @@ -309,7 +309,7 @@ class FileModel currentVersion: cur_ver, history: hist }, - histData: + histData: hist_data } end @@ -376,28 +376,28 @@ class FileModel # file type # server url to the mail merge recipients file # direct url to the mail merge recipients file - dataSpreadsheet = if is_enable_direct_url == true - { - fileType: 'csv', # file type - # server url to the mail merge recipients file - url: "#{DocumentHelper.get_server_url(true)}/csv", - # direct url to the mail merge recipients file - directUrl: "#{DocumentHelper.get_server_url(false)}/csv" - } - else - { - fileType: 'csv', # file type - # server url to the mail merge recipients file - url: "#{DocumentHelper.get_server_url(true)}/csv" - } - end + data_spreadsheet = if is_enable_direct_url == true + { + fileType: 'csv', # file type + # server url to the mail merge recipients file + url: "#{DocumentHelper.get_server_url(true)}/csv", + # direct url to the mail merge recipients file + directUrl: "#{DocumentHelper.get_server_url(false)}/csv" + } + else + { + fileType: 'csv', # file type + # server url to the mail merge recipients file + url: "#{DocumentHelper.get_server_url(true)}/csv" + } + end if JwtHelper.is_enabled # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the dataSpreadsheet object - dataSpreadsheet['token'] = JwtHelper.encode(dataSpreadsheet) + data_spreadsheet['token'] = JwtHelper.encode(data_spreadsheet) end - dataSpreadsheet + data_spreadsheet end # get users data for mentions @@ -415,11 +415,11 @@ class FileModel name: user_info.name, email: user_info.email, group: user_info.group, - reviewGroups: user_info.reviewGroups, - commentGroups: user_info.commentGroups, - userInfoGroups: user_info.userInfoGroups, + reviewGroups: user_info.review_groups, + commentGroups: user_info.comment_groups, + userInfoGroups: user_info.user_info_groups, favorite: user_info.favorite, - deniedPermissions: user_info.deniedPermissions, + deniedPermissions: user_info.denied_permissions, descriptions: user_info.descriptions, templates: user_info.templates, avatar: user_info.avatar diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index c5475d6c..e1731c29 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -68,9 +68,9 @@ class ServiceConverter if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = ServiceConverter.config_manager.jwt_header; # get signature authorization header + jwt_header = ServiceConverter.config_manager.jwt_header; # get signature authorization header # set it to the request with the Bearer prefix - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") + req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") end req.body = payload.to_json diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index a396ccd2..120c4f4a 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -43,16 +43,16 @@ class TrackHelper # check if a secret key to generate token exists or not if JwtHelper.is_enabled && JwtHelper.use_for_request - inHeader = false + in_header = false token = nil - jwtHeader = TrackHelper.config_manager.jwt_header; # get the authorization header from the config + jwt_header = TrackHelper.config_manager.jwt_header; # get the authorization header from the config if file_data['token'] # if the token is in the body token = JwtHelper.decode(file_data['token']) # decode a token into a payload object using a secret key - elsif request.headers[jwtHeader] # if the token is in the header - hdr = request.headers[jwtHeader] + elsif request.headers[jwt_header] # if the token is in the header + hdr = request.headers[jwt_header] hdr.slice!(0, 'Bearer '.length) # get token from it (after Bearer prefix) token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key - inHeader = true + in_header = true else raise 'Expected JWT' # token missing error message end @@ -61,7 +61,7 @@ class TrackHelper file_data = JSON.parse(token) - file_data = file_data['payload'] if inHeader + file_data = file_data['payload'] if in_header end file_data @@ -285,9 +285,9 @@ class TrackHelper if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload - jwtHeader = TrackHelper.config_manager.jwt_header; # get signature authorization header + jwt_header = TrackHelper.config_manager.jwt_header; # get signature authorization header # set it to the request with the Bearer prefix - req.add_field(jwtHeader, "Bearer #{JwtHelper.encode({ payload: })}") + req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") end req.body = payload.to_json # convert the payload object into the json format diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index cb58a04e..2659ee0b 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -18,22 +18,22 @@ # Represents a user with various attributes class User - attr_accessor :id, :name, :email, :group, :reviewGroups, :commentGroups, :userInfoGroups, :favorite, - :deniedPermissions, :descriptions, :templates, :avatar + attr_accessor :id, :name, :email, :group, :review_groups, :comment_groups, :user_info_groups, :favorite, + :denied_permissions, :descriptions, :templates, :avatar - def initialize(id, name, email, group, reviewGroups, commentGroups, userInfoGroups, favorite, - deniedPermissions, descriptions, templates, avatar) + def initialize(id, name, email, group, review_groups, comment_groups, user_info_groups, favorite, + denied_permissions, descriptions, templates, avatar) @id = id @name = name @email = email @group = group - @reviewGroups = reviewGroups - @commentGroups = commentGroups + @review_groups = review_groups + @comment_groups = comment_groups @favorite = favorite - @deniedPermissions = deniedPermissions + @denied_permissions = denied_permissions @descriptions = descriptions @templates = templates - @userInfoGroups = userInfoGroups + @user_info_groups = user_info_groups @avatar = avatar end end @@ -129,14 +129,13 @@ class Users # get a list of users with their names and emails for mentions def get_users_for_mentions(id) - usersData = [] + users_data = [] @users.each do |user| if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? - usersData.push({ name: user.name, - email: user.email }) + users_data.push({ name: user.name, email: user.email }) end end - usersData + users_data end # get a list of users with their id, names and emails for protect From f955096fc00dbdb4ac3f27c1bc7dbc906e4eed94 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 00:11:39 +0300 Subject: [PATCH 099/176] ruby: Naming/VariableNumber correct --- .../ruby/app/models/users.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 2659ee0b..d2e782e7 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -40,7 +40,7 @@ end # Manages user-related data and operations. class Users - @descr_user_1 = [ + @descr_user_first = [ 'File author by default', 'Doesn’t belong to any group', 'Can review all the changes', @@ -51,7 +51,7 @@ class Users 'Has an avatar' ] - @descr_user_2 = [ + @descr_user_second = [ 'Belongs to Group2', 'Can review only his own changes or changes made by users with no group', 'Can view comments, edit his own comments, and comments left by users with no group. ' \ @@ -62,7 +62,7 @@ class Users 'Has an avatar' ] - @descr_user_3 = [ + @descr_user_third = [ 'Belongs to Group3', 'Can review changes made by Group2 users', 'Can view comments left by Group2 and Group3 users. Can edit comments left by the Group2 users', @@ -74,7 +74,7 @@ class Users 'Can see the information about Group2 users' ] - @descr_user_0 = [ + @descr_user_null = [ 'The name is requested when the editor is opened', 'Doesn’t belong to any group', 'Can review all the changes', @@ -92,7 +92,7 @@ class Users @users = [ User.new('uid-1', 'John Smith', 'smith@example.com', '', nil, {}, nil, - nil, [], @descr_user_1, true, true), + nil, [], @descr_user_first, true, true), User.new('uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', ['group-2', ''], { view: '', @@ -100,7 +100,7 @@ class Users remove: ['group-2'] }, ['group-2', ''], - true, [], @descr_user_2, false, true), + true, [], @descr_user_second, false, true), User.new('uid-3', 'Hamish Mitchell', nil, 'group-3', ['group-2'], { view: %w[group-3 group-2], @@ -108,10 +108,10 @@ class Users remove: [] }, ['group-2'], - false, %w[copy download print], @descr_user_3, false, false), + false, %w[copy download print], @descr_user_third, false, false), User.new('uid-0', nil, nil, '', nil, {}, [], - nil, ['protect'], @descr_user_0, false, false) + nil, ['protect'], @descr_user_null, false, false) ] class << self From f8d62ab8dbcaf5032679a53a42bdef4794e1d971 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 00:06:41 +0300 Subject: [PATCH 100/176] ruby: Naming/AccessorMethodName correct --- .../ruby/app/models/file_model.rb | 14 +++++++------- .../ruby/app/models/users.rb | 2 +- .../ruby/app/views/home/editor.html.erb | 12 ++++++------ .../ruby/app/views/home/index.html.erb | 4 ++-- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index ea6d7745..0630b41c 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -89,7 +89,7 @@ class FileModel end # get config parameters - def get_config + def config editors_mode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded can_edit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited if (!can_edit && editors_mode.eql?('edit') || editors_mode.eql?('fillForms')) && @@ -201,7 +201,7 @@ class FileModel end # get document history - def get_history + def history file_name = @file_name file_ext = File.extname(file_name).downcase doc_key = key @@ -317,7 +317,7 @@ class FileModel end # get image information - def get_insert_image + def insert_image # image file type # server url to the image # direct url to the image @@ -401,15 +401,15 @@ class FileModel end # get users data for mentions - def get_users_mentions + def users_mentions !@user.id.eql?('uid-0') ? Users.get_users_for_mentions(@user.id) : nil end - def get_users_info + def users_info users_info = [] return if @user.id.eql?('uid-0') - Users.get_all_users.each do |user_info| + Users.all_users.each do |user_info| u = { id: user_info.id, name: user_info.name, @@ -431,7 +431,7 @@ class FileModel end # get users data for protect - def get_users_protect + def users_protect !@user.id.eql?('uid-0') ? Users.get_users_for_protect(@user.id) : nil end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index d2e782e7..c72d3677 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -115,7 +115,7 @@ class Users ] class << self - def get_all_users + def all_users @users end diff --git a/web/documentserver-example/ruby/app/views/home/editor.html.erb b/web/documentserver-example/ruby/app/views/home/editor.html.erb index 323c959b..97c88e28 100755 --- a/web/documentserver-example/ruby/app/views/home/editor.html.erb +++ b/web/documentserver-example/ruby/app/views/home/editor.html.erb @@ -102,7 +102,7 @@ var onRequestInsertImage = function(event) { docEditor.insertImage({ // insert an image into the file "c": event.data.c, - <%= raw @file.get_insert_image %> + <%= raw @file.insert_image %> }) }; @@ -216,7 +216,7 @@ var сonnectEditor = function () { - config = <%= raw @file.get_config.to_json %>; + config = <%= raw @file.config.to_json %>; config.width = "100%"; config.height = "100%"; @@ -234,8 +234,8 @@ }; <% - history = @file.get_history - usersMentions = @file.get_users_mentions %> + history = @file.history + usersMentions = @file.users_mentions %> if (config.editorConfig.user.id) { <% if history %> @@ -262,7 +262,7 @@ switch (c) { case "info": users = []; - var allUsers = <%= raw @file.get_users_info.to_json %>; + var allUsers = <%= raw @file.users_info.to_json %>; for (var i = 0; i < event.data.id.length; i++) { for (var j = 0; j < allUsers.length; j++) { if (allUsers[j].id == event.data.id[i]) { @@ -276,7 +276,7 @@ var users = <%= raw @file.get_users_protect.to_json %>; break; default: - users = <%= raw @file.get_users_mentions.to_json %>; + users = <%= raw @file.users_mentions.to_json %>; } docEditor.setUsers({ "c": c, diff --git a/web/documentserver-example/ruby/app/views/home/index.html.erb b/web/documentserver-example/ruby/app/views/home/index.html.erb index b9018e38..9da594a4 100755 --- a/web/documentserver-example/ruby/app/views/home/index.html.erb +++ b/web/documentserver-example/ruby/app/views/home/index.html.erb @@ -62,7 +62,7 @@ Username @@ -110,7 +110,7 @@ Please do NOT use this integration example on your own server without proper code modifications, it is intended for testing purposes only. In case you enabled this test example, disable it before going for production. You can open the same document using different users in different Web browser sessions, so you can check out multi-user editing functions. - <% for user in Users.get_all_users() do %> + <% for user in Users.all_users() do %>
<%= user.name ? user.name : "Anonymous" %>
    From 94d22003b5a4bc28c867db026f4a683563019f80 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 11:50:10 +0300 Subject: [PATCH 101/176] ruby: Naming/MethodName correct --- web/documentserver-example/ruby/app/models/file_model.rb | 6 +++--- .../ruby/app/views/home/editor.html.erb | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 0630b41c..97b2b635 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -343,7 +343,7 @@ class FileModel end # get compared file information - def dataDocument + def data_document # file type # server url to the compared file # direct url to the compared file @@ -372,7 +372,7 @@ class FileModel end # get mail merge recipients information - def dataSpreadsheet + def data_spreadsheet # file type # server url to the mail merge recipients file # direct url to the mail merge recipients file @@ -393,7 +393,7 @@ class FileModel end if JwtHelper.is_enabled # check if a secret key to generate token exists or not - # encode a payload object into a token and write it to the dataSpreadsheet object + # encode a payload object into a token and write it to the data_spreadsheet object data_spreadsheet['token'] = JwtHelper.encode(data_spreadsheet) end diff --git a/web/documentserver-example/ruby/app/views/home/editor.html.erb b/web/documentserver-example/ruby/app/views/home/editor.html.erb index 97c88e28..65c002c9 100755 --- a/web/documentserver-example/ruby/app/views/home/editor.html.erb +++ b/web/documentserver-example/ruby/app/views/home/editor.html.erb @@ -108,14 +108,14 @@ // the user is trying to select document for comparing by clicking the Document from Storage button var onRequestSelectDocument = function(event) { - var data = <%= raw @file.dataDocument.to_json %>; + var data = <%= raw @file.data_document.to_json %>; data.c = event.data.c; docEditor.setRequestedDocument(data); // select a document for comparing }; // the user is trying to select recipients data by clicking the Mail merge button var onRequestSelectSpreadsheet = function (event) { - var data = <%= raw @file.dataSpreadsheet.to_json %>; + var data = <%= raw @file.data_spreadsheet.to_json %>; data.c = event.data.c; docEditor.setRequestedSpreadsheet(data); // insert recipient data for mail merge into the file }; From 8f4de5ce0d8b447e065ab91891d819752981b03b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 11:53:13 +0300 Subject: [PATCH 102/176] ruby: Naming/PredicateName correct --- .../ruby/app/controllers/home_controller.rb | 6 ++--- .../ruby/app/models/file_model.rb | 24 +++++++++---------- .../ruby/app/models/jwt_helper.rb | 2 +- .../ruby/app/models/service_converter.rb | 2 +- .../ruby/app/models/track_helper.rb | 4 ++-- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 4e5ae852..443d2707 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -165,7 +165,7 @@ class HomeController < ApplicationController file = params[:file] params[:dmode] - if JwtHelper.is_enabled && JwtHelper.use_for_request + if JwtHelper.enabled? && JwtHelper.use_for_request jwt_header = HomeController.config_manager.jwt_header if request.headers[jwt_header] hdr = request.headers[jwt_header] @@ -281,7 +281,7 @@ class HomeController < ApplicationController user_address = params[:userAddress] is_embedded = params[:dmode] - if JwtHelper.is_enabled && is_embedded.nil? && !user_address.nil? && JwtHelper.use_for_request + if JwtHelper.enabled? && is_embedded.nil? && !user_address.nil? && JwtHelper.use_for_request jwt_header = HomeController.config_manager.jwt_header if request.headers[jwt_header] hdr = request.headers[jwt_header] @@ -434,7 +434,7 @@ class HomeController < ApplicationController link: "#{DocumentHelper.get_server_url(false)}/editor?fileName=#{file_name}" } - data['token'] = JwtHelper.encode(data) if JwtHelper.is_enabled + data['token'] = JwtHelper.encode(data) if JwtHelper.enabled? render plain: data.to_json end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 97b2b635..938f079e 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -120,7 +120,7 @@ class FileModel document: { title: @file_name, url: download_url, - directUrl: is_enable_direct_url ? download_url(is_server_url: false) : '', + directUrl: enable_direct_url? ? download_url(is_server_url: false) : '', fileType: file_ext.delete('.'), key:, info: { @@ -193,7 +193,7 @@ class FileModel } } - if JwtHelper.is_enabled # check if a secret key to generate token exists or not + if JwtHelper.enabled? # check if a secret key to generate token exists or not config['token'] = JwtHelper.encode(config) # encode a payload object into a token and write it to the config end @@ -248,7 +248,7 @@ class FileModel data_obj['fileType'] = file_ext[1..file_ext.length] data_obj['key'] = cur_key data_obj['url'] = i == cur_ver ? doc_uri : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") - if is_enable_direct_url == true + if enable_direct_url? == true data_obj['directUrl'] = if i == cur_ver download_url(is_server_url: false) @@ -276,7 +276,7 @@ class FileModel prev = hist_data[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url - data obj['previous'] = if is_enable_direct_url == true + data obj['previous'] = if enable_direct_url? == true { # write key and url information about previous file version with optional directUrl fileType: prev['fileType'], key: prev['key'], @@ -295,7 +295,7 @@ class FileModel data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') end - if JwtHelper.is_enabled # check if a secret key to generate token exists or not + if JwtHelper.enabled? # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the data object data_obj['token'] = JwtHelper.encode(data_obj) end @@ -321,7 +321,7 @@ class FileModel # image file type # server url to the image # direct url to the image - insert_image = if is_enable_direct_url == true + insert_image = if enable_direct_url? == true { fileType: 'png', # image file type url: "#{DocumentHelper.get_server_url(true)}/assets/logo.png", # server url to the image @@ -334,7 +334,7 @@ class FileModel } end - if JwtHelper.is_enabled # check if a secret key to generate token exists or not + if JwtHelper.enabled? # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the insert_image object insert_image['token'] = JwtHelper.encode(insert_image) end @@ -347,7 +347,7 @@ class FileModel # file type # server url to the compared file # direct url to the compared file - compare_file = if is_enable_direct_url == true + compare_file = if enable_direct_url? == true { fileType: 'docx', # file type # server url to the compared file @@ -363,7 +363,7 @@ class FileModel } end - if JwtHelper.is_enabled # check if a secret key to generate token exists or not + if JwtHelper.enabled? # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the compare_file object compare_file['token'] = JwtHelper.encode(compare_file) end @@ -376,7 +376,7 @@ class FileModel # file type # server url to the mail merge recipients file # direct url to the mail merge recipients file - data_spreadsheet = if is_enable_direct_url == true + data_spreadsheet = if enable_direct_url? == true { fileType: 'csv', # file type # server url to the mail merge recipients file @@ -392,7 +392,7 @@ class FileModel } end - if JwtHelper.is_enabled # check if a secret key to generate token exists or not + if JwtHelper.enabled? # check if a secret key to generate token exists or not # encode a payload object into a token and write it to the data_spreadsheet object data_spreadsheet['token'] = JwtHelper.encode(data_spreadsheet) end @@ -436,7 +436,7 @@ class FileModel end # get direct url existence flag - def is_enable_direct_url + def enable_direct_url? !@direct_url.nil? && @direct_url == 'true' end end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 1a76b114..48679d79 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -26,7 +26,7 @@ class JwtHelper class << self # check if a secret key to generate token exists or not - def is_enabled + def enabled? @jwt_secret && !@jwt_secret.empty? ? true : false end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index e1731c29..39bbff8f 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -66,7 +66,7 @@ class ServiceConverter req.add_field('Accept', 'application/json') # set headers req.add_field('Content-Type', 'application/json') - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwt_header = ServiceConverter.config_manager.jwt_header; # get signature authorization header # set it to the request with the Bearer prefix diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 120c4f4a..68918384 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -42,7 +42,7 @@ class TrackHelper file_data = JSON.parse(body) # parse file data # check if a secret key to generate token exists or not - if JwtHelper.is_enabled && JwtHelper.use_for_request + if JwtHelper.enabled? && JwtHelper.use_for_request in_header = false token = nil jwt_header = TrackHelper.config_manager.jwt_header; # get the authorization header from the config @@ -283,7 +283,7 @@ class TrackHelper req = Net::HTTP::Post.new(uri.request_uri) # create the post request req.add_field('Content-Type', 'application/json') # set headers - if JwtHelper.is_enabled && JwtHelper.use_for_request # if the signature is enabled + if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload jwt_header = TrackHelper.config_manager.jwt_header; # get signature authorization header # set it to the request with the Bearer prefix From 8fa40ab439c65a77be7bcfdfd762aeab0ea14b9b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:10:24 +0300 Subject: [PATCH 103/176] ruby: Style/SymbolArray correct --- web/documentserver-example/ruby/Gemfile | 6 +++--- web/documentserver-example/ruby/config/application.rb | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 753e0bdf..01162d9a 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -2,7 +2,7 @@ source 'https://rubygems.org' -gem 'byebug', '~> 11.1', groups: %i[development test] +gem 'byebug', '~> 11.1', groups: [:development, :test] gem 'coffee-rails', '~> 5.0' gem 'dalli', '~> 3.2', group: :development gem 'jbuilder', '~> 2.11' @@ -15,12 +15,12 @@ gem 'rubocop', '~> 1.52', group: :development gem 'sass-rails', '~> 6.0' gem 'sdoc', '~> 2.6', group: :doc gem 'sorbet-runtime', '~> 0.5.10871' -gem 'test-unit', '~> 3.6', groups: %i[development test] +gem 'test-unit', '~> 3.6', groups: [:development, :test] gem 'turbolinks', '~> 5.2' gem 'tzinfo-data', '~> 1.2023' gem 'uglifier', '~> 4.2' gem 'uuid', '~> 2.3' -gem 'web-console', '~> 4.2', groups: %i[development test] +gem 'web-console', '~> 4.2', groups: [:development, :test] gem 'webrick', '~> 1.8' # Unfortunately, Sorbet only supports Darwin and Linux-based systems. diff --git a/web/documentserver-example/ruby/config/application.rb b/web/documentserver-example/ruby/config/application.rb index f9c59aa3..dfe4302f 100644 --- a/web/documentserver-example/ruby/config/application.rb +++ b/web/documentserver-example/ruby/config/application.rb @@ -16,7 +16,7 @@ class Application < Rails::Application config.middleware.insert_before 0, Rack::Cors do allow do origins '*' - resource '*', headers: :any, methods: %i[get post patch delete put options] + resource '*', headers: :any, methods: [:get, :post, :patch, :delete, :put, :options] end end From 7fe7753c887fef92002478040ef59b1ac1578a1e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:27:25 +0300 Subject: [PATCH 104/176] ruby: Layout/MultilineMethodArgumentLineBreaks correct --- .../ruby/app/models/file_model.rb | 4 +- .../ruby/app/models/users.rb | 72 +++++++++++++++---- 2 files changed, 61 insertions(+), 15 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 938f079e..7bb0a353 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -253,7 +253,9 @@ class FileModel if i == cur_ver download_url(is_server_url: false) else - DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}", + DocumentHelper.get_historypath_uri(file_name, +i, +"prev#{file_ext}", false) end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index c72d3677..a78f2903 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -18,8 +18,18 @@ # Represents a user with various attributes class User - attr_accessor :id, :name, :email, :group, :review_groups, :comment_groups, :user_info_groups, :favorite, - :denied_permissions, :descriptions, :templates, :avatar + attr_accessor :id, +:name, +:email, +:group, +:review_groups, +:comment_groups, +:user_info_groups, +:favorite, + :denied_permissions, +:descriptions, +:templates, +:avatar def initialize(id, name, email, group, review_groups, comment_groups, user_info_groups, favorite, denied_permissions, descriptions, templates, avatar) @@ -90,28 +100,62 @@ class Users ] @users = [ - User.new('uid-1', 'John Smith', 'smith@example.com', - '', nil, {}, nil, - nil, [], @descr_user_first, true, true), - User.new('uid-2', 'Mark Pottato', 'pottato@example.com', - 'group-2', ['group-2', ''], { + User.new('uid-1', +'John Smith', +'smith@example.com', + '', +nil, +{}, +nil, + nil, +[], +@descr_user_first, +true, +true), + User.new('uid-2', +'Mark Pottato', +'pottato@example.com', + 'group-2', +['group-2', ''], +{ view: '', edit: ['group-2', ''], remove: ['group-2'] }, ['group-2', ''], - true, [], @descr_user_second, false, true), - User.new('uid-3', 'Hamish Mitchell', nil, - 'group-3', ['group-2'], { + true, +[], +@descr_user_second, +false, +true), + User.new('uid-3', +'Hamish Mitchell', +nil, + 'group-3', +['group-2'], +{ view: %w[group-3 group-2], edit: ['group-2'], remove: [] }, ['group-2'], - false, %w[copy download print], @descr_user_third, false, false), - User.new('uid-0', nil, nil, - '', nil, {}, [], - nil, ['protect'], @descr_user_null, false, false) + false, +%w[copy download print], +@descr_user_third, +false, +false), + User.new('uid-0', +nil, +nil, + '', +nil, +{}, +[], + nil, +['protect'], +@descr_user_null, +false, +false) ] class << self From 940b4bfc8052416c0338f738753f7d981a776b60 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:28:12 +0300 Subject: [PATCH 105/176] ruby: Layout/TrailingWhitespace correct --- .../ruby/app/models/file_model.rb | 4 +- .../ruby/app/models/users.rb | 88 +++++++++---------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 7bb0a353..199ad579 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -253,8 +253,8 @@ class FileModel if i == cur_ver download_url(is_server_url: false) else - DocumentHelper.get_historypath_uri(file_name, -i, + DocumentHelper.get_historypath_uri(file_name, +i, "prev#{file_ext}", false) end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index a78f2903..8e8d2198 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -18,17 +18,17 @@ # Represents a user with various attributes class User - attr_accessor :id, -:name, -:email, -:group, -:review_groups, -:comment_groups, -:user_info_groups, + attr_accessor :id, +:name, +:email, +:group, +:review_groups, +:comment_groups, +:user_info_groups, :favorite, - :denied_permissions, -:descriptions, -:templates, + :denied_permissions, +:descriptions, +:templates, :avatar def initialize(id, name, email, group, review_groups, comment_groups, user_info_groups, favorite, @@ -100,61 +100,61 @@ class Users ] @users = [ - User.new('uid-1', -'John Smith', + User.new('uid-1', +'John Smith', 'smith@example.com', - '', -nil, -{}, + '', nil, - nil, -[], -@descr_user_first, -true, +{}, +nil, + nil, +[], +@descr_user_first, +true, true), - User.new('uid-2', -'Mark Pottato', + User.new('uid-2', +'Mark Pottato', 'pottato@example.com', - 'group-2', -['group-2', ''], + 'group-2', +['group-2', ''], { view: '', edit: ['group-2', ''], remove: ['group-2'] }, ['group-2', ''], - true, -[], -@descr_user_second, -false, + true, +[], +@descr_user_second, +false, true), - User.new('uid-3', -'Hamish Mitchell', + User.new('uid-3', +'Hamish Mitchell', nil, - 'group-3', -['group-2'], + 'group-3', +['group-2'], { view: %w[group-3 group-2], edit: ['group-2'], remove: [] }, ['group-2'], - false, -%w[copy download print], -@descr_user_third, -false, + false, +%w[copy download print], +@descr_user_third, +false, false), - User.new('uid-0', -nil, + User.new('uid-0', nil, - '', -nil, -{}, +nil, + '', +nil, +{}, [], - nil, -['protect'], -@descr_user_null, -false, + nil, +['protect'], +@descr_user_null, +false, false) ] From 40c520e8fd8ac78906694a585f9cd880a29e5605 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:29:02 +0300 Subject: [PATCH 106/176] ruby: Layout/ArgumentAlignment correct --- .../ruby/app/models/file_model.rb | 4 +- .../ruby/app/models/users.rb | 106 +++++++++--------- 2 files changed, 55 insertions(+), 55 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 199ad579..b6fb1bb7 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -254,8 +254,8 @@ class FileModel download_url(is_server_url: false) else DocumentHelper.get_historypath_uri(file_name, -i, -"prev#{file_ext}", + i, + "prev#{file_ext}", false) end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 8e8d2198..c4db0bbd 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -19,17 +19,17 @@ # Represents a user with various attributes class User attr_accessor :id, -:name, -:email, -:group, -:review_groups, -:comment_groups, -:user_info_groups, -:favorite, + :name, + :email, + :group, + :review_groups, + :comment_groups, + :user_info_groups, + :favorite, :denied_permissions, -:descriptions, -:templates, -:avatar + :descriptions, + :templates, + :avatar def initialize(id, name, email, group, review_groups, comment_groups, user_info_groups, favorite, denied_permissions, descriptions, templates, avatar) @@ -101,61 +101,61 @@ class Users @users = [ User.new('uid-1', -'John Smith', -'smith@example.com', + 'John Smith', + 'smith@example.com', '', -nil, -{}, -nil, nil, -[], -@descr_user_first, -true, -true), + {}, + nil, + nil, + [], + @descr_user_first, + true, + true), User.new('uid-2', -'Mark Pottato', -'pottato@example.com', + 'Mark Pottato', + 'pottato@example.com', 'group-2', -['group-2', ''], -{ - view: '', - edit: ['group-2', ''], - remove: ['group-2'] - }, + ['group-2', ''], + { + view: '', + edit: ['group-2', ''], + remove: ['group-2'] + }, ['group-2', ''], true, -[], -@descr_user_second, -false, -true), + [], + @descr_user_second, + false, + true), User.new('uid-3', -'Hamish Mitchell', -nil, + 'Hamish Mitchell', + nil, 'group-3', -['group-2'], -{ - view: %w[group-3 group-2], - edit: ['group-2'], - remove: [] - }, + ['group-2'], + { + view: %w[group-3 group-2], + edit: ['group-2'], + remove: [] + }, ['group-2'], false, -%w[copy download print], -@descr_user_third, -false, -false), + %w[copy download print], + @descr_user_third, + false, + false), User.new('uid-0', -nil, -nil, - '', -nil, -{}, -[], nil, -['protect'], -@descr_user_null, -false, -false) + nil, + '', + nil, + {}, + [], + nil, + ['protect'], + @descr_user_null, + false, + false) ] class << self From 03a585685e94f98b76dd757a0fb6d03cb7ee514f Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:29:36 +0300 Subject: [PATCH 107/176] ruby: Layout/FirstMethodArgumentLineBreak correct --- .../ruby/app/models/file_model.rb | 6 ++++-- .../ruby/app/models/track_helper.rb | 12 ++++++++---- web/documentserver-example/ruby/app/models/users.rb | 12 ++++++++---- 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index b6fb1bb7..80205a1d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -51,7 +51,8 @@ class FileModel if @config_manager.storage_path.absolute? "#{download_url}&dmode=emb" else - DocumentHelper.get_file_uri(@file_name, + DocumentHelper.get_file_uri( +@file_name, false) end end @@ -253,7 +254,8 @@ class FileModel if i == cur_ver download_url(is_server_url: false) else - DocumentHelper.get_historypath_uri(file_name, + DocumentHelper.get_historypath_uri( +file_name, i, "prev#{file_ext}", false) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 68918384..a8255c49 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -126,7 +126,8 @@ class TrackHelper download_uri = new_file_uri end rescue StandardError - new_file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, + new_file_name = DocumentHelper.get_correct_name( +File.basename(file_name, cur_ext) + download_ext, user_address) end end @@ -228,16 +229,19 @@ class TrackHelper if is_submit_form file_name = if new_file_name - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{download_ext}", + DocumentHelper.get_correct_name( +"#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else - DocumentHelper.get_correct_name("#{File.basename(file_name, cur_ext)}-form#{cur_ext}", + DocumentHelper.get_correct_name( +"#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, + file_name = DocumentHelper.get_correct_name( +File.basename(file_name, cur_ext) + download_ext, user_address) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index c4db0bbd..d64ac272 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -100,7 +100,8 @@ class Users ] @users = [ - User.new('uid-1', + User.new( +'uid-1', 'John Smith', 'smith@example.com', '', @@ -112,7 +113,8 @@ class Users @descr_user_first, true, true), - User.new('uid-2', + User.new( +'uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', @@ -128,7 +130,8 @@ class Users @descr_user_second, false, true), - User.new('uid-3', + User.new( +'uid-3', 'Hamish Mitchell', nil, 'group-3', @@ -144,7 +147,8 @@ class Users @descr_user_third, false, false), - User.new('uid-0', + User.new( +'uid-0', nil, nil, '', From f5ccc21f69642e65a5adc3410c9153fed1fcf360 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:31:23 +0300 Subject: [PATCH 108/176] ruby: Style/FetchEnvVar correct --- .../ruby/app/configuration/configuration.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index c4efd7fe..efae1f14 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -36,7 +36,7 @@ class ConfigurationManager sig { returns(T.nilable(URI::Generic)) } def example_uri - url = ENV['EXAMPLE_URL'] + url = ENV.fetch('EXAMPLE_URL', nil) return nil if url.nil? URI(url) @@ -50,7 +50,7 @@ class ConfigurationManager sig { returns(URI::Generic) } def document_server_private_uri - url = ENV['DOCUMENT_SERVER_PRIVATE_URL'] + url = ENV.fetch('DOCUMENT_SERVER_PRIVATE_URL', nil) return URI(url) if url document_server_public_uri @@ -100,7 +100,7 @@ class ConfigurationManager sig { returns(T::Boolean) } def jwt_use_for_request - env = ENV['JWT_USE_FOR_REQUEST'] + env = ENV.fetch('JWT_USE_FOR_REQUEST', nil) return ActiveModel::Type::Boolean.new.cast(env) if env true @@ -108,7 +108,7 @@ class ConfigurationManager sig { returns(T::Boolean) } def ssl_verify_peer_mode_enabled - env = ENV['SSL_VERIFY_PEER_MODE_ENABLED'] + env = ENV.fetch('SSL_VERIFY_PEER_MODE_ENABLED', nil) return ActiveModel::Type::Boolean.new.cast(env) if env false @@ -127,7 +127,7 @@ class ConfigurationManager sig { returns(Numeric) } def maximum_file_size - env = ENV['MAXIMUM_FILE_SIZE'] + env = ENV.fetch('MAXIMUM_FILE_SIZE', nil) return env.to_i if env 5 * 1024 * 1024 From cba2eac65d8ac962ca8af81a183cb34b7ee97d45 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:32:09 +0300 Subject: [PATCH 109/176] ruby: Lint/NumberConversion correct --- .../ruby/app/configuration/configuration.rb | 2 +- .../ruby/app/controllers/home_controller.rb | 2 +- .../ruby/app/models/service_converter.rb | 6 +++--- web/documentserver-example/ruby/app/models/track_helper.rb | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index efae1f14..1faa56a3 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -128,7 +128,7 @@ class ConfigurationManager sig { returns(Numeric) } def maximum_file_size env = ENV.fetch('MAXIMUM_FILE_SIZE', nil) - return env.to_i if env + return Integer(env, 10) if env 5 * 1024 * 1024 end diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 443d2707..8b9d270c 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -203,7 +203,7 @@ class HomeController < ApplicationController return end - status = file_data['status'].to_i + status = Integer(file_data['status'], 10) user_address = params[:userAddress] file_name = File.basename(params[:fileName]) diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 39bbff8f..a8f49dca 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -76,7 +76,7 @@ class ServiceConverter req.body = payload.to_json res = http.request(req) # get the response - status_code = res.code.to_i + status_code = Integer(res.code, 10) raise "Conversion service returned status: #{status_code}" if status_code != 200 # checking status code data = res.body # and take its body @@ -140,7 +140,7 @@ class ServiceConverter error_element = file_result['error'] unless error_element.nil? # if an error occurs - process_convert_service_responce_error(error_element.to_i) # get an error message + process_convert_service_responce_error(Integer(error_element, 10)) # get an error message end is_end_convert = file_result['endConvert'] # check if the conversion is completed @@ -166,7 +166,7 @@ class ServiceConverter percent_element = file_result['percent'] # get the percentage value - result_percent = percent_element.to_i unless percent_element.nil? + result_percent = Integer(percent_element, 10) unless percent_element.nil? result_percent = result_percent >= 100 ? 99 : result_percent diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index a8255c49..37742e4b 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -225,7 +225,7 @@ File.basename(file_name, cur_ext) + download_ext, begin # check if the forcesave type is equal to 3 (the form was submitted) - is_submit_form = file_data['forcesavetype'].to_i == 3 + is_submit_form = Integer(file_data['forcesavetype'], 10) == 3 if is_submit_form file_name = if new_file_name From 8580ea8a571da515b790f5d138fcb8616e8a53c0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:32:54 +0300 Subject: [PATCH 110/176] ruby: Style/StringHashKeys correct --- .../ruby/app/configuration/configuration.rb | 80 +++++++++---------- .../ruby/app/models/document_helper.rb | 12 +-- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index 1faa56a3..2f191b19 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -141,46 +141,46 @@ class ConfigurationManager sig { returns(T::Hash[String, String]) } def 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' + :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' } end end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index fa469917..98fe8606 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -294,12 +294,12 @@ class DocumentHelper # write file parameters to the info object info = { - 'version' => get_file_version(history_dir(directory)), - 'id' => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), - 'contentLength' => "#{(File.size(directory) / 1024.0).round(2)} KB", - 'pureContentLength' => File.size(directory), - 'title' => file_name, - 'updated' => File.mtime(directory) + :version => get_file_version(history_dir(directory)), + :id => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), + :contentLength => "#{(File.size(directory) / 1024.0).round(2)} KB", + :pureContentLength => File.size(directory), + :title => file_name, + :updated => File.mtime(directory) } if file_id.nil? # if file id is undefined From 955b35f38238403442b9ca26ee0a3ec9941251e7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:33:36 +0300 Subject: [PATCH 111/176] ruby: Style/MethodCallWithArgsParentheses correct --- .../app/configuration/configuration_tests.rb | 2 +- .../ruby/app/controllers/home_controller.rb | 74 +++++++++---------- .../ruby/app/models/document_helper.rb | 4 +- .../ruby/app/models/file_model.rb | 4 +- .../ruby/app/models/jwt_helper.rb | 4 +- .../ruby/app/models/service_converter.rb | 12 +-- .../ruby/app/models/track_helper.rb | 10 +-- .../ruby/config/application.rb | 2 +- 8 files changed, 56 insertions(+), 56 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration_tests.rb b/web/documentserver-example/ruby/app/configuration/configuration_tests.rb index ccf94cdf..9dcbb0d5 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration_tests.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration_tests.rb @@ -28,7 +28,7 @@ module Enviroment end def setup - ENV.replace @env + ENV.replace(@env) end end diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 8b9d270c..3eac5f51 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -51,7 +51,7 @@ class HomeController < ApplicationController DocumentHelper.init(request.remote_ip, request.base_url) user = Users.get_user(params[:userId]) file_name = DocumentHelper.create_demo(params[:fileExt], params[:sample], user) - redirect_to controller: 'home', action: 'editor', fileName: file_name, userId: user.id + redirect_to(controller: 'home', action: 'editor', fileName: file_name, userId: user.id) end # uploading a file @@ -64,12 +64,12 @@ class HomeController < ApplicationController cur_size = http_posted_file.size # check if the file size exceeds the maximum file size - raise 'File size is incorrect' if DocumentHelper.file_size_max < cur_size || cur_size <= 0 + raise('File size is incorrect') if DocumentHelper.file_size_max < cur_size || cur_size <= 0 cur_ext = File.extname(file_name).downcase # check if the file extension is supported by the editor - raise 'File type is not supported' unless DocumentHelper.file_exts.include? cur_ext + raise('File type is not supported') unless DocumentHelper.file_exts.include?(cur_ext) # get the correct file name if such a name already exists file_name = DocumentHelper.get_correct_name(file_name, nil) @@ -86,9 +86,9 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) # write a new file name to the response - render plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}" + render(plain: "{ \"filename\": \"#{file_name}\", \"documentType\": \"#{document_type}\"}") rescue StandardError => e - render plain: "{ \"error\": \"#{e.message}\"}" # write an error message to the response + render(plain: "{ \"error\": \"#{e.message}\"}") # write an error message to the response end end @@ -120,7 +120,7 @@ class HomeController < ApplicationController # if the conversion isn't completed, write file name and step values to the response if percent != 100 - render plain: "{ \"step\" : \"#{percent}\", \"filename\" : \"#{file_name}\"}" + render(plain: "{ \"step\" : \"#{percent}\", \"filename\" : \"#{file_name}\"}") return end @@ -136,7 +136,7 @@ class HomeController < ApplicationController res = http.request(req) data = res.body - raise 'stream is null' if data.nil? + raise('stream is null') if data.nil? # write a file with a new extension, but with the content from the origin file File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| @@ -152,9 +152,9 @@ class HomeController < ApplicationController DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file end - render plain: "{ \"filename\" : \"#{file_name}\"}" + render(plain: "{ \"filename\" : \"#{file_name}\"}") rescue StandardError => e - render plain: "{ \"error\": \"#{e.message}\"}" + render(plain: "{ \"error\": \"#{e.message}\"}") end # downloading a history file from public @@ -172,11 +172,11 @@ class HomeController < ApplicationController hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) if !token || token.eql?('') - render plain: 'JWT validation failed', status: 403 + render(plain: 'JWT validation failed', status: 403) return end else - render plain: 'JWT validation failed', status: 403 + render(plain: 'JWT validation failed', status: 403) return end end @@ -190,16 +190,16 @@ class HomeController < ApplicationController MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file)}" - send_file file_path, x_sendfile: true + send_file(file_path, x_sendfile: true) rescue StandardError - render plain: '{ "error": "File not found"}' + render(plain: '{ "error": "File not found"}') end # tracking file changes def track file_data = TrackHelper.read_body(request) # read the request body if file_data.nil? || file_data.empty? - render plain: '{"error":1}' # an error occurs if the file is empty + render(plain: '{"error":1}') # an error occurs if the file is empty return end @@ -217,17 +217,17 @@ class HomeController < ApplicationController if [2, 3].include?(status) # MustSave, Corrupted saved = TrackHelper.process_save(file_data, file_name, user_address) # save file - render plain: "{\"error\":#{saved}}" + render(plain: "{\"error\":#{saved}}") return end if [6, 7].include?(status) # MustForceave, CorruptedForcesave saved = TrackHelper.process_force_save(file_data, file_name, user_address) # force save file - render plain: "{\"error\":#{saved}}" + render(plain: "{\"error\":#{saved}}") return end - render plain: '{"error":0}' + render(plain: '{"error":0}') nil end @@ -235,7 +235,7 @@ class HomeController < ApplicationController def remove file_name = File.basename(params[:filename]) # get the file name unless file_name # if it doesn't exist - render plain: '{"success":false}' # report that the operation is unsuccessful + render(plain: '{"success":false}') # report that the operation is unsuccessful return end @@ -251,7 +251,7 @@ class HomeController < ApplicationController FileUtils.remove_entry_secure(hist_dir) # delete it end - render plain: '{"success":true}' # report that the operation is successful + render(plain: '{"success":true}') # report that the operation is successful nil end @@ -259,7 +259,7 @@ class HomeController < ApplicationController def files file_id = params[:fileId] files_info = DocumentHelper.get_files_info(file_id) # get the information about the file specified by a file id - render json: files_info + render(json: files_info) end # downloading a csv file @@ -272,7 +272,7 @@ class HomeController < ApplicationController response.headers['Content-Type'] = MimeMagic.by_path(csv_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file csv_path, x_sendfile: true + send_file(csv_path, x_sendfile: true) end # downloading a file @@ -289,7 +289,7 @@ class HomeController < ApplicationController token = JwtHelper.decode(hdr) end if !token || token.eql?('') - render plain: 'JWT validation failed', status: 403 + render(plain: 'JWT validation failed', status: 403) return end end @@ -306,9 +306,9 @@ class HomeController < ApplicationController MimeMagic.by_path(file_path).eql?(nil) ? nil : MimeMagic.by_path(file_path).type response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file file_path, x_sendfile: true + send_file(file_path, x_sendfile: true) rescue StandardError - render plain: '{ "error": "File not found"}' + render(plain: '{ "error": "File not found"}') end # Save Copy as... @@ -324,7 +324,7 @@ class HomeController < ApplicationController DocumentHelper.fill_forms_exts unless all_exts.include?(extension) - render plain: '{"error": "File type is not supported"}' + render(plain: '{"error": "File type is not supported"}') return end @@ -338,7 +338,7 @@ class HomeController < ApplicationController data = res.body if data.size <= 0 || data.size > HomeController.config_manager.maximum_file_size - render plain: '{"error": "File size is incorrect"}' + render(plain: '{"error": "File size is incorrect"}') return end @@ -348,10 +348,10 @@ class HomeController < ApplicationController user = Users.get_user(params[:userId]) DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file - render plain: "{\"file\" : \"#{file_name}\"}" + render(plain: "{\"file\" : \"#{file_name}\"}") nil rescue StandardError => e - render plain: "{\"error\":1, \"message\": \"#{e.message}\"}" + render(plain: "{\"error\":1, \"message\": \"#{e.message}\"}") nil end @@ -370,7 +370,7 @@ class HomeController < ApplicationController } json_data = TrackHelper.command_request('meta', dockey, meta) - render plain: "{ \"result\" : \"#{JSON.dump(json_data)}\"}" + render(plain: "{ \"result\" : \"#{JSON.dump(json_data)}\"}") end # ReferenceData @@ -395,7 +395,7 @@ class HomeController < ApplicationController url: link, directUrl: link } - render plain: data.to_json + render(plain: data.to_json) return end @@ -403,7 +403,7 @@ class HomeController < ApplicationController query_params = CGI.parse(url_obj.query) file_name = query_params['fileName'].first unless File.exist?(DocumentHelper.storage_path(file_name, nil)) - render plain: '{ "error": "File is not exist"}' + render(plain: '{ "error": "File is not exist"}') return end end @@ -414,7 +414,7 @@ class HomeController < ApplicationController end if file_name.empty? - render plain: '{ "error": "File not found"}' + render(plain: '{ "error": "File not found"}') return end @@ -436,7 +436,7 @@ class HomeController < ApplicationController data['token'] = JwtHelper.encode(data) if JwtHelper.enabled? - render plain: data.to_json + render(plain: data.to_json) end def restore @@ -495,15 +495,15 @@ class HomeController < ApplicationController FileUtils.cp(source_file, bumped_file) FileUtils.cp(recovery_file, source_file) - render json: { + render(json: { error: nil, success: true - } + }) rescue StandardError => e response.status = :internal_server_error - render json: { + render(json: { error: e.message, success: false - } + }) end end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 98fe8606..1a71d137 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -200,9 +200,9 @@ class DocumentHelper # save sample document of a necessary extension to the storage directory src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) - dest = storage_path file_name, nil + dest = storage_path(file_name, nil) - FileUtils.cp src, dest + FileUtils.cp(src, dest) # save file meta data to the file diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 80205a1d..5a6485c9 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -280,7 +280,7 @@ file_name, prev = hist_data[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url - data obj['previous'] = if enable_direct_url? == true + data(obj['previous'] = if enable_direct_url? == true { # write key and url information about previous file version with optional directUrl fileType: prev['fileType'], key: prev['key'], @@ -293,7 +293,7 @@ file_name, key: prev['key'], url: prev['url'] } - end + end) # write the path to the diff.zip archive with differences in this file version data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 48679d79..55ab0b32 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -37,13 +37,13 @@ class JwtHelper # encode a payload object into a token using a secret key def encode(payload) - JWT.encode payload, @jwt_secret, 'HS256' # define the hashing algorithm and get token + JWT.encode(payload, @jwt_secret, 'HS256') # define the hashing algorithm and get token end # decode a token into a payload object using a secret key def decode(token) begin - decoded = JWT.decode token, @jwt_secret, true, { algorithm: 'HS256' } + decoded = JWT.decode(token, @jwt_secret, true, { algorithm: 'HS256' }) rescue StandardError return '' end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index a8f49dca..e5c77f00 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -77,13 +77,13 @@ class ServiceConverter res = http.request(req) # get the response status_code = Integer(res.code, 10) - raise "Conversion service returned status: #{status_code}" if status_code != 200 # checking status code + raise("Conversion service returned status: #{status_code}") if status_code != 200 # checking status code data = res.body # and take its body rescue Timeout::Error # try again rescue StandardError => e - raise e.message + raise(e.message) end json_data = JSON.parse(data) # parse response body @@ -92,11 +92,11 @@ class ServiceConverter # generate the document key value def generate_revision_id(expected_key) - require 'zlib' + require('zlib') if expected_key.length > 20 # check if the expected key length is greater than 20 # calculate 32-bit crc value from the expected key and turn it into the string - expected_key = (Zlib.crc32 expected_key).to_s + expected_key = (Zlib.crc32(expected_key)).to_s end key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') @@ -131,7 +131,7 @@ class ServiceConverter error_message = "ErrorCode = #{error_code}" # default value for the error message end - raise error_message + raise(error_message) end # get the response url @@ -155,7 +155,7 @@ class ServiceConverter file_type_element = file_result['fileType'] if file_url_element.nil? # and the file url doesn't exist - raise 'Invalid answer format' # get ann error message + raise('Invalid answer format') # get ann error message end response_uri = file_url_element # otherwise, get the file url diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 37742e4b..9898b0b2 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -54,10 +54,10 @@ class TrackHelper token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key in_header = true else - raise 'Expected JWT' # token missing error message + raise('Expected JWT') # token missing error message end - raise 'Invalid JWT signature' if !token || token.eql?('') + raise('Invalid JWT signature') if !token || token.eql?('') file_data = JSON.parse(token) @@ -298,7 +298,7 @@ File.basename(file_name, cur_ext) + download_ext, res = http.request(req) # get the response data = res.body # and take its body rescue StandardError => e - raise e.message + raise(e.message) end JSON.parse(data) # convert the response body into the json format @@ -316,11 +316,11 @@ File.basename(file_name, cur_ext) + download_ext, res = http.request(req) # get the response status_code = res.code - raise "Document editing service returned status: #{status_code}" if status_code != '200' # checking status code + raise("Document editing service returned status: #{status_code}") if status_code != '200' # checking status code data = res.body # and take its body - raise 'stream is null' if data.nil? + raise('stream is null') if data.nil? data end diff --git a/web/documentserver-example/ruby/config/application.rb b/web/documentserver-example/ruby/config/application.rb index dfe4302f..cccafed3 100644 --- a/web/documentserver-example/ruby/config/application.rb +++ b/web/documentserver-example/ruby/config/application.rb @@ -13,7 +13,7 @@ require 'securerandom' # Configuration for the Rails application. class Application < Rails::Application - config.middleware.insert_before 0, Rack::Cors do + config.middleware.insert_before(0, Rack::Cors) do allow do origins '*' resource '*', headers: :any, methods: [:get, :post, :patch, :delete, :put, :options] From 5b99e3d17abb513535f42817327a1b72a2e5140d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:35:14 +0300 Subject: [PATCH 112/176] ruby: Style/HashSyntax correct --- .../ruby/app/configuration/configuration.rb | 80 +++++++++---------- .../ruby/app/models/document_helper.rb | 12 +-- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index 2f191b19..f3dc744e 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -141,46 +141,46 @@ class ConfigurationManager sig { returns(T::Hash[String, String]) } def 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' + 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' } end end diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 1a71d137..efa6db43 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -294,12 +294,12 @@ class DocumentHelper # write file parameters to the info object info = { - :version => get_file_version(history_dir(directory)), - :id => ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), - :contentLength => "#{(File.size(directory) / 1024.0).round(2)} KB", - :pureContentLength => File.size(directory), - :title => file_name, - :updated => File.mtime(directory) + version: get_file_version(history_dir(directory)), + id: ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), + contentLength: "#{(File.size(directory) / 1024.0).round(2)} KB", + pureContentLength: File.size(directory), + title: file_name, + updated: File.mtime(directory) } if file_id.nil? # if file id is undefined From 7710c6d6e838bdbaf7cd6134d4dfd93b5eee19eb Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:36:03 +0300 Subject: [PATCH 113/176] ruby: Style/QuotedSymbols correct --- .../ruby/app/configuration/configuration.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index f3dc744e..308345c7 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -149,7 +149,7 @@ class ConfigurationManager bg: 'Bulgarian', ca: 'Catalan', zh: 'Chinese (Simplified)', - "zh-TW": 'Chinese (Traditional)', + 'zh-TW': 'Chinese (Traditional)', cs: 'Czech', da: 'Danish', nl: 'Dutch', @@ -169,7 +169,7 @@ class ConfigurationManager no: 'Norwegian', pl: 'Polish', pt: 'Portuguese (Brazil)', - "pt-PT": 'Portuguese (Portugal)', + 'pt-PT': 'Portuguese (Portugal)', ro: 'Romanian', ru: 'Russian', si: 'Sinhala (Sri Lanka)', @@ -180,7 +180,7 @@ class ConfigurationManager tr: 'Turkish', uk: 'Ukrainian', vi: 'Vietnamese', - "aa-AA": 'Test Language' + 'aa-AA': 'Test Language' } end end From f2504ab740516ba360fa00d0c44fe868e2443cb2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:36:45 +0300 Subject: [PATCH 114/176] ruby: Style/FileWrite correct --- .../ruby/app/controllers/home_controller.rb | 12 +++--------- .../ruby/app/models/document_helper.rb | 4 +--- .../ruby/app/models/track_helper.rb | 12 +++--------- 3 files changed, 7 insertions(+), 21 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 3eac5f51..a16c3389 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -76,9 +76,7 @@ class HomeController < ApplicationController document_type = FileUtility.get_file_type(file_name) # write the uploaded file to the storage directory - File.open(DocumentHelper.storage_path(file_name, nil), 'wb') do |file| - file.write(http_posted_file.read) - end + File.binwrite(DocumentHelper.storage_path(file_name, nil), http_posted_file.read) # create file meta information user = Users.get_user(params[:userId]) @@ -139,9 +137,7 @@ class HomeController < ApplicationController raise('stream is null') if data.nil? # write a file with a new extension, but with the content from the origin file - File.open(DocumentHelper.storage_path(correct_name, nil), 'wb') do |file| - file.write(data) - end + File.binwrite(DocumentHelper.storage_path(correct_name, nil), data) old_storage_path = DocumentHelper.storage_path(file_name, nil) File.delete(old_storage_path) if File.exist?(old_storage_path) @@ -342,9 +338,7 @@ class HomeController < ApplicationController return end - File.open(DocumentHelper.storage_path(file_name, nil), 'wb') do |file| - file.write(data) - end + File.binwrite(DocumentHelper.storage_path(file_name, nil), data) user = Users.get_user(params[:userId]) DocumentHelper.create_meta(file_name, user.id, user.name, nil) # create meta data of the new file diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index efa6db43..97708164 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -188,9 +188,7 @@ class DocumentHelper } # write file meta information to the createdInfo.json file - File.open(File.join(hist_dir, 'createdInfo.json'), 'wb') do |file| - file.write(json.to_json) - end + File.binwrite(File.join(hist_dir, 'createdInfo.json'), json.to_json) end # create demo document diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 9898b0b2..63444c93 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -158,15 +158,11 @@ File.basename(file_name, cur_ext) + download_ext, hist_data = file_data['changeshistory'] hist_data ||= file_data['history'].to_json if hist_data - File.open(File.join(ver_dir, 'changes.json'), 'wb') do |file| # open the file with document changes - file.write(hist_data) # and write history data to this file - end + File.binwrite(File.join(ver_dir, 'changes.json'), hist_data) end # write the key value to the key.txt file - File.open(File.join(ver_dir, 'key.txt'), 'wb') do |file| - file.write(file_data['key']) - end + File.binwrite(File.join(ver_dir, 'key.txt'), file_data['key']) # get the path to the forcesaved file forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) @@ -326,9 +322,7 @@ File.basename(file_name, cur_ext) + download_ext, end def save_file(data, path) - File.open(path, 'wb') do |file| # open the file from the path specified - file.write(data) # and write the response data to it - end + File.binwrite(path, data) end end end From fd5a2b7b0e3dc6af9f00496008a8c71a4dab9a46 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:37:42 +0300 Subject: [PATCH 115/176] ruby: Style/NegatedIfElseCondition correct --- web/documentserver-example/ruby/app/models/file_model.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 5a6485c9..82b21f7c 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -164,10 +164,10 @@ class FileModel change: false } end, - createUrl: !@user.id.eql?('uid-0') ? create_url : nil, + createUrl: @user.id.eql?('uid-0') ? nil : create_url, templates: @user.templates ? templates : nil, user: { # the user currently viewing or editing the document - id: !@user.id.eql?('uid-0') ? @user.id : nil, + id: @user.id.eql?('uid-0') ? nil : @user.id, name: @user.name, group: @user.group, image: @user.avatar ? "#{DocumentHelper.get_server_url(true)}/assets/#{@user.id}.png" : nil @@ -406,7 +406,7 @@ file_name, # get users data for mentions def users_mentions - !@user.id.eql?('uid-0') ? Users.get_users_for_mentions(@user.id) : nil + @user.id.eql?('uid-0') ? nil : Users.get_users_for_mentions(@user.id) end def users_info @@ -436,7 +436,7 @@ file_name, # get users data for protect def users_protect - !@user.id.eql?('uid-0') ? Users.get_users_for_protect(@user.id) : nil + @user.id.eql?('uid-0') ? nil : Users.get_users_for_protect(@user.id) end # get direct url existence flag From f441ab1650edf8de66255ecd7f39803d59342254 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:38:22 +0300 Subject: [PATCH 116/176] ruby: Style/RedundantParentheses correct --- web/documentserver-example/ruby/app/models/service_converter.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index e5c77f00..73efaa27 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -96,7 +96,7 @@ class ServiceConverter if expected_key.length > 20 # check if the expected key length is greater than 20 # calculate 32-bit crc value from the expected key and turn it into the string - expected_key = (Zlib.crc32(expected_key)).to_s + expected_key = Zlib.crc32(expected_key).to_s end key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') From 6f5a854cd25fdbcfa51f6a1eb6996906a6c000d7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:38:50 +0300 Subject: [PATCH 117/176] ruby: Style/WordArray correct --- web/documentserver-example/ruby/app/models/file_model.rb | 6 +++--- web/documentserver-example/ruby/app/models/users.rb | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 82b21f7c..4e83b6ba 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -130,12 +130,12 @@ class FileModel favorite: @user.favorite }, permissions: { # the permission for the document to be edited and downloaded or not - comment: !%w[view fillForms embedded blockcontent].include?(editors_mode), + comment: !['view', 'fillForms', 'embedded', 'blockcontent'].include?(editors_mode), copy: !@user.denied_permissions.include?('copy'), download: !@user.denied_permissions.include?('download'), - edit: can_edit && %w[edit view filter blockcontent].include?(editors_mode), + edit: can_edit && ['edit', 'view', 'filter', 'blockcontent'].include?(editors_mode), print: !@user.denied_permissions.include?('print'), - fillForms: !%w[view comment embedded blockcontent].include?(editors_mode), + fillForms: !['view', 'comment', 'embedded', 'blockcontent'].include?(editors_mode), modifyFilter: !editors_mode.eql?('filter'), modifyContentControl: !editors_mode.eql?('blockcontent'), review: can_edit && (editors_mode.eql?('edit') || editors_mode.eql?('review')), diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index d64ac272..2457f546 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -137,13 +137,13 @@ class Users 'group-3', ['group-2'], { - view: %w[group-3 group-2], + view: ['group-3', 'group-2'], edit: ['group-2'], remove: [] }, ['group-2'], false, - %w[copy download print], + ['copy', 'download', 'print'], @descr_user_third, false, false), From 9b6495718954e5e4d84ea62e1474a9cfda8bef4c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:39:19 +0300 Subject: [PATCH 118/176] ruby: Layout/MultilineMethodParameterLineBreaks correct --- .../ruby/app/models/users.rb | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 2457f546..268b9e30 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -31,8 +31,18 @@ class User :templates, :avatar - def initialize(id, name, email, group, review_groups, comment_groups, user_info_groups, favorite, - denied_permissions, descriptions, templates, avatar) + def initialize(id, +name, +email, +group, +review_groups, +comment_groups, +user_info_groups, +favorite, + denied_permissions, +descriptions, +templates, +avatar) @id = id @name = name @email = email From 9471891a89f62877e2b537c3b9b87d6bec73a117 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:40:05 +0300 Subject: [PATCH 119/176] ruby: Lint/NonAtomicFileOperation correct --- .../ruby/app/controllers/home_controller.rb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index a16c3389..6e5933a7 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -140,7 +140,7 @@ class HomeController < ApplicationController File.binwrite(DocumentHelper.storage_path(correct_name, nil), data) old_storage_path = DocumentHelper.storage_path(file_name, nil) - File.delete(old_storage_path) if File.exist?(old_storage_path) + FileUtils.rm_f(old_storage_path) file_name = correct_name user = Users.get_user(params[:userId]) @@ -239,13 +239,13 @@ class HomeController < ApplicationController storage_path = DocumentHelper.storage_path(file_name, nil) hist_dir = DocumentHelper.history_dir(storage_path) - if File.exist?(storage_path) # if the file exists - File.delete(storage_path) # delete it from the storage path - end + # if the file exists + FileUtils.rm_f(storage_path) # delete it from the storage path + - if Dir.exist?(hist_dir) # if the history directory of this file exists - FileUtils.remove_entry_secure(hist_dir) # delete it - end + # if the history directory of this file exists + FileUtils.rm_rf(hist_dir) # delete it + render(plain: '{"success":true}') # report that the operation is successful nil From 9796abf846328f9918b78923bda638a05faa5d9d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:40:48 +0300 Subject: [PATCH 120/176] ruby: Layout/FirstArgumentIndentation correct --- web/documentserver-example/ruby/app/models/file_model.rb | 4 ++-- .../ruby/app/models/track_helper.rb | 8 ++++---- web/documentserver-example/ruby/app/models/users.rb | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 4e83b6ba..760162f4 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -52,7 +52,7 @@ class FileModel "#{download_url}&dmode=emb" else DocumentHelper.get_file_uri( -@file_name, + @file_name, false) end end @@ -255,7 +255,7 @@ class FileModel download_url(is_server_url: false) else DocumentHelper.get_historypath_uri( -file_name, + file_name, i, "prev#{file_ext}", false) diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 63444c93..d2043354 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -127,7 +127,7 @@ class TrackHelper end rescue StandardError new_file_name = DocumentHelper.get_correct_name( -File.basename(file_name, cur_ext) + download_ext, + File.basename(file_name, cur_ext) + download_ext, user_address) end end @@ -226,18 +226,18 @@ File.basename(file_name, cur_ext) + download_ext, if is_submit_form file_name = if new_file_name DocumentHelper.get_correct_name( -"#{File.basename(file_name, cur_ext)}-form#{download_ext}", + "#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address) # get the correct file name if it already exists else DocumentHelper.get_correct_name( -"#{File.basename(file_name, cur_ext)}-form#{cur_ext}", + "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else if new_file_name file_name = DocumentHelper.get_correct_name( -File.basename(file_name, cur_ext) + download_ext, + File.basename(file_name, cur_ext) + download_ext, user_address) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 268b9e30..f05ad42e 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -111,7 +111,7 @@ class Users @users = [ User.new( -'uid-1', + 'uid-1', 'John Smith', 'smith@example.com', '', @@ -124,7 +124,7 @@ class Users true, true), User.new( -'uid-2', + 'uid-2', 'Mark Pottato', 'pottato@example.com', 'group-2', @@ -141,7 +141,7 @@ class Users false, true), User.new( -'uid-3', + 'uid-3', 'Hamish Mitchell', nil, 'group-3', @@ -158,7 +158,7 @@ class Users false, false), User.new( -'uid-0', + 'uid-0', nil, nil, '', From ae738e1be223288ba1bb96f16417112a9178ee4a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:41:28 +0300 Subject: [PATCH 121/176] ruby: Style/RedundantSelfAssignmentBranch correct --- .../ruby/app/models/service_converter.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 73efaa27..507dfa68 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -32,14 +32,14 @@ class ServiceConverter class << self # get the url of the converted file def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) - from_ext = from_ext.nil? ? File.extname(document_uri).downcase : from_ext # get the current document extension + from_ext = File.extname(document_uri).downcase if from_ext.nil? # get the current document extension # get the current document name or uuid title = File.basename(URI.parse(document_uri).path) - title = title.nil? ? UUID.generate.to_s : title + title = UUID.generate.to_s if title.nil? # get the document key - document_revision_id = document_revision_id.empty? ? document_uri : document_revision_id + document_revision_id = document_uri if document_revision_id.empty? document_revision_id = generate_revision_id(document_revision_id) payload = { # write all the conversion parameters to the payload @@ -168,7 +168,7 @@ class ServiceConverter result_percent = Integer(percent_element, 10) unless percent_element.nil? - result_percent = result_percent >= 100 ? 99 : result_percent + result_percent = 99 if result_percent >= 100 end From 992dbe18afc0f891141f69479e8990fba786f43a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:41:52 +0300 Subject: [PATCH 122/176] ruby: Layout/ArgumentAlignment correct --- .../ruby/app/models/file_model.rb | 8 +- .../ruby/app/models/track_helper.rb | 8 +- .../ruby/app/models/users.rb | 104 +++++++++--------- 3 files changed, 60 insertions(+), 60 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 760162f4..5e262979 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -53,7 +53,7 @@ class FileModel else DocumentHelper.get_file_uri( @file_name, - false) + false) end end @@ -256,9 +256,9 @@ class FileModel else DocumentHelper.get_historypath_uri( file_name, - i, - "prev#{file_ext}", - false) + i, + "prev#{file_ext}", + false) end end data_obj['version'] = i diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index d2043354..ded766b0 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -128,7 +128,7 @@ class TrackHelper rescue StandardError new_file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, - user_address) + user_address) end end @@ -227,18 +227,18 @@ class TrackHelper file_name = if new_file_name DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{download_ext}", - user_address) # get the correct file name if it already exists + user_address) # get the correct file name if it already exists else DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", - user_address) + user_address) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else if new_file_name file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, - user_address) + user_address) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index f05ad42e..b8f74610 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -112,64 +112,64 @@ class Users @users = [ User.new( 'uid-1', - 'John Smith', - 'smith@example.com', - '', - nil, - {}, - nil, - nil, - [], - @descr_user_first, - true, - true), + 'John Smith', + 'smith@example.com', + '', + nil, + {}, + nil, + nil, + [], + @descr_user_first, + true, + true), User.new( 'uid-2', - 'Mark Pottato', - 'pottato@example.com', - 'group-2', - ['group-2', ''], - { - view: '', - edit: ['group-2', ''], - remove: ['group-2'] - }, - ['group-2', ''], - true, - [], - @descr_user_second, - false, - true), + 'Mark Pottato', + 'pottato@example.com', + 'group-2', + ['group-2', ''], + { + view: '', + edit: ['group-2', ''], + remove: ['group-2'] + }, + ['group-2', ''], + true, + [], + @descr_user_second, + false, + true), User.new( 'uid-3', - 'Hamish Mitchell', - nil, - 'group-3', - ['group-2'], - { - view: ['group-3', 'group-2'], - edit: ['group-2'], - remove: [] - }, - ['group-2'], - false, - ['copy', 'download', 'print'], - @descr_user_third, - false, - false), + 'Hamish Mitchell', + nil, + 'group-3', + ['group-2'], + { + view: ['group-3', 'group-2'], + edit: ['group-2'], + remove: [] + }, + ['group-2'], + false, + ['copy', 'download', 'print'], + @descr_user_third, + false, + false), User.new( 'uid-0', - nil, - nil, - '', - nil, - {}, - [], - nil, - ['protect'], - @descr_user_null, - false, - false) + nil, + nil, + '', + nil, + {}, + [], + nil, + ['protect'], + @descr_user_null, + false, + false) ] class << self From 1f5c23a2d1c625bb8cffe8b92cc6ccf2920f5d09 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:43:31 +0300 Subject: [PATCH 123/176] ruby: Layout/CommentIndentation correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 6e5933a7..499572a8 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -239,11 +239,11 @@ class HomeController < ApplicationController storage_path = DocumentHelper.storage_path(file_name, nil) hist_dir = DocumentHelper.history_dir(storage_path) - # if the file exists + # if the file exists FileUtils.rm_f(storage_path) # delete it from the storage path - # if the history directory of this file exists + # if the history directory of this file exists FileUtils.rm_rf(hist_dir) # delete it From 58eec51312f8264646877b3b992fd7026da64be4 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:44:03 +0300 Subject: [PATCH 124/176] ruby: Layout/IndentationConsistency correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 499572a8..c6518137 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -240,11 +240,11 @@ class HomeController < ApplicationController hist_dir = DocumentHelper.history_dir(storage_path) # if the file exists - FileUtils.rm_f(storage_path) # delete it from the storage path + FileUtils.rm_f(storage_path) # delete it from the storage path # if the history directory of this file exists - FileUtils.rm_rf(hist_dir) # delete it + FileUtils.rm_rf(hist_dir) # delete it render(plain: '{"success":true}') # report that the operation is successful From 743176bb5ce22bea5bf839073cd54bb25557d794 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:44:29 +0300 Subject: [PATCH 125/176] ruby: Layout/TrailingWhitespace correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- .../ruby/app/models/users.rb | 20 +++++++++---------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index c6518137..b4b51d07 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -241,11 +241,11 @@ class HomeController < ApplicationController # if the file exists FileUtils.rm_f(storage_path) # delete it from the storage path - + # if the history directory of this file exists FileUtils.rm_rf(hist_dir) # delete it - + render(plain: '{"success":true}') # report that the operation is successful nil diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index b8f74610..c53883f9 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -31,17 +31,17 @@ class User :templates, :avatar - def initialize(id, -name, -email, -group, -review_groups, -comment_groups, -user_info_groups, + def initialize(id, +name, +email, +group, +review_groups, +comment_groups, +user_info_groups, favorite, - denied_permissions, -descriptions, -templates, + denied_permissions, +descriptions, +templates, avatar) @id = id @name = name From f00f2126620474518309c6d497f88b310f5eacc9 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:44:59 +0300 Subject: [PATCH 126/176] ruby: Lint/SymbolConversion correct --- .../ruby/app/controllers/home_controller.rb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index b4b51d07..d8046451 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -446,7 +446,7 @@ class HomeController < ApplicationController DocumentHelper.init(request.remote_ip, request.base_url) file_model = FileModel.new( { - 'file_name': source_basename + file_name: source_basename } ) @@ -471,13 +471,13 @@ class HomeController < ApplicationController bumped_changes_file = bumped_version_directory.join('changes.json') bumped_changes = { - 'serverVersion': nil, - 'changes': [ + serverVersion: nil, + changes: [ { - 'created': Time.now.to_formatted_s(:db), - 'user': { - 'id': user.id, - 'name': user.name + created: Time.now.to_formatted_s(:db), + user: { + id: user.id, + name: user.name } } ] From 18aa9487b3bb9d20befa524957c81490de4c05ba Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:45:27 +0300 Subject: [PATCH 127/176] ruby: Layout/FirstMethodArgumentLineBreak correct --- .../ruby/app/controllers/home_controller.rb | 6 ++++-- web/documentserver-example/ruby/app/models/file_model.rb | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index d8046451..eccb0bf9 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -489,13 +489,15 @@ class HomeController < ApplicationController FileUtils.cp(source_file, bumped_file) FileUtils.cp(recovery_file, source_file) - render(json: { + render( +json: { error: nil, success: true }) rescue StandardError => e response.status = :internal_server_error - render(json: { + render( +json: { error: e.message, success: false }) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 5e262979..d4a26861 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -280,7 +280,8 @@ class FileModel prev = hist_data[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url - data(obj['previous'] = if enable_direct_url? == true + data( +obj['previous'] = if enable_direct_url? == true { # write key and url information about previous file version with optional directUrl fileType: prev['fileType'], key: prev['key'], From 5f68d09e2f789b45eefc6e0c166e8608bbbc13ca Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:46:25 +0300 Subject: [PATCH 128/176] ruby: Layout/FirstHashElementIndentation correct --- .../ruby/app/controllers/home_controller.rb | 8 ++++---- web/documentserver-example/ruby/app/models/users.rb | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index eccb0bf9..3b08a4cc 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -491,15 +491,15 @@ class HomeController < ApplicationController render( json: { - error: nil, + error: nil, success: true - }) +}) rescue StandardError => e response.status = :internal_server_error render( json: { - error: e.message, + error: e.message, success: false - }) +}) end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index c53883f9..463d6f20 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -130,10 +130,10 @@ class Users 'group-2', ['group-2', ''], { - view: '', + view: '', edit: ['group-2', ''], remove: ['group-2'] - }, + }, ['group-2', ''], true, [], @@ -147,10 +147,10 @@ class Users 'group-3', ['group-2'], { - view: ['group-3', 'group-2'], + view: ['group-3', 'group-2'], edit: ['group-2'], remove: [] - }, + }, ['group-2'], false, ['copy', 'download', 'print'], From 7e9356df5ec868483e5086abad4ef5daca8c12ef Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:46:53 +0300 Subject: [PATCH 129/176] ruby: Layout/MultilineMethodCallBraceLayout correct --- .../ruby/app/controllers/home_controller.rb | 6 ++++-- .../ruby/app/models/file_model.rb | 9 ++++++--- .../ruby/app/models/track_helper.rb | 12 ++++++++---- web/documentserver-example/ruby/app/models/users.rb | 12 ++++++++---- 4 files changed, 26 insertions(+), 13 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 3b08a4cc..b6d0ff15 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -493,13 +493,15 @@ class HomeController < ApplicationController json: { error: nil, success: true -}) +} +) rescue StandardError => e response.status = :internal_server_error render( json: { error: e.message, success: false -}) +} +) end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index d4a26861..fb4fd5a1 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -53,7 +53,8 @@ class FileModel else DocumentHelper.get_file_uri( @file_name, - false) + false +) end end @@ -258,7 +259,8 @@ class FileModel file_name, i, "prev#{file_ext}", - false) + false +) end end data_obj['version'] = i @@ -294,7 +296,8 @@ obj['previous'] = if enable_direct_url? == true key: prev['key'], url: prev['url'] } - end) + end +) # write the path to the diff.zip archive with differences in this file version data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index ded766b0..592e4de9 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -128,7 +128,8 @@ class TrackHelper rescue StandardError new_file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, - user_address) + user_address +) end end @@ -227,18 +228,21 @@ class TrackHelper file_name = if new_file_name DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{download_ext}", - user_address) # get the correct file name if it already exists + user_address +) # get the correct file name if it already exists else DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", - user_address) + user_address +) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else if new_file_name file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, - user_address) + user_address +) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 463d6f20..9a8ae5cc 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -122,7 +122,8 @@ class Users [], @descr_user_first, true, - true), + true +), User.new( 'uid-2', 'Mark Pottato', @@ -139,7 +140,8 @@ class Users [], @descr_user_second, false, - true), + true +), User.new( 'uid-3', 'Hamish Mitchell', @@ -156,7 +158,8 @@ class Users ['copy', 'download', 'print'], @descr_user_third, false, - false), + false +), User.new( 'uid-0', nil, @@ -169,7 +172,8 @@ class Users ['protect'], @descr_user_null, false, - false) + false +) ] class << self From af38a4ba61e21602925ceec712986e118d75a87c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:47:24 +0300 Subject: [PATCH 130/176] ruby: Layout/LineEndStringConcatenationIndentation correct --- .../ruby/app/models/document_helper.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 97708164..53677c90 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -222,8 +222,8 @@ class DocumentHelper # for redirection to my link user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' "#{get_server_url(is_server_url)}/downloadhistory/?"\ - "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ - "&file=#{ERB::Util.url_encode(file)}#{user_host}" + "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ + "&file=#{ERB::Util.url_encode(file)}#{user_host}" end # get server url @@ -238,8 +238,8 @@ class DocumentHelper # get callback url def get_callback(file_name) "#{get_server_url(true)}/track?" \ - "fileName=#{ERB::Util.url_encode(file_name)}&" \ - "userAddress=#{cur_user_host_address(nil)}" + "fileName=#{ERB::Util.url_encode(file_name)}&" \ + "userAddress=#{cur_user_host_address(nil)}" end # get url to the created file From 94df21fe21fef692e2abbf67285318d762d4aef9 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:48:18 +0300 Subject: [PATCH 131/176] ruby: Style/ClassMethodsDefinitions correct --- .../ruby/app/models/document_helper.rb | 508 +++++++++-------- .../ruby/app/models/file_utility.rb | 15 +- .../ruby/app/models/jwt_helper.rb | 44 +- .../ruby/app/models/service_converter.rb | 244 ++++---- .../ruby/app/models/track_helper.rb | 520 +++++++++--------- .../ruby/app/models/users.rb | 48 +- 6 files changed, 685 insertions(+), 694 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 53677c90..765eaafa 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -32,294 +32,292 @@ class DocumentHelper @remote_ip = nil @base_url = nil - class << self - def init(ip, url) - @remote_ip = ip - @base_url = url + def self.init(ip, url) + @remote_ip = ip + @base_url = url + end + + # define max file size + def self.file_size_max + DocumentHelper.config_manager.maximum_file_size + end + + # all the supported file extensions + def self.file_exts + DocumentHelper.format_manager.all_extensions + end + + def self.fill_forms_exts + DocumentHelper.format_manager.fillable_extensions + end + + # file extensions that can be viewed + def self.viewed_exts + DocumentHelper.format_manager.viewable_extensions + end + + # file extensions that can be edited + def self.edited_exts + DocumentHelper.format_manager.editable_extensions + end + + # file extensions that can be converted + def self.convert_exts + DocumentHelper.format_manager.convertible_extensions + end + + # get current user host address + def self.cur_user_host_address(user_address) + (user_address.nil? ? @remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_') + end + + # get the storage path of the given file + def self.storage_path(file_name, user_address) + directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) + + # create a new directory if it doesn't exist + FileUtils.mkdir_p(directory) unless File.directory?(directory) + + # put the given file to this directory + File.join(directory, File.basename(file_name)) + end + + # get the path to the forcesaved file version + def self.forcesave_path(file_name, user_address, create) + directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) + + # the directory with host address doesn't exist + return '' unless File.directory?(directory) + + # get the path to the history of the given file + directory = File.join(directory, "#{File.basename(file_name)}-hist") + unless File.directory?(directory) + return '' unless create + + FileUtils.mkdir_p(directory) # create history directory if it doesn't exist + + # the history directory doesn't exist and we are not supposed to create it + end - # define max file size - def file_size_max - DocumentHelper.config_manager.maximum_file_size - end + directory = File.join(directory, File.basename(file_name)) # get the path to the given file + return '' if !File.file?(directory) && !create - # all the supported file extensions - def file_exts - DocumentHelper.format_manager.all_extensions - end + directory.to_s + end - def fill_forms_exts - DocumentHelper.format_manager.fillable_extensions - end + # get the path to the file history + def self.history_dir(storage_path) + directory = "#{storage_path}-hist" - # file extensions that can be viewed - def viewed_exts - DocumentHelper.format_manager.viewable_extensions - end + # create history directory if it doesn't exist + FileUtils.mkdir_p(directory) unless File.directory?(directory) - # file extensions that can be edited - def edited_exts - DocumentHelper.format_manager.editable_extensions - end + directory + end - # file extensions that can be converted - def convert_exts - DocumentHelper.format_manager.convertible_extensions - end + # get the path to the specified file version + def self.version_dir(hist_dir, ver) + File.join(hist_dir, ver.to_s) + end - # get current user host address - def cur_user_host_address(user_address) - (user_address.nil? ? @remote_ip : user_address).gsub(/[^0-9\-.a-zA-Z_=]/, '_') - end + # get the last file version + def self.get_file_version(hist_dir) + return 1 unless Dir.exist?(hist_dir) - # get the storage path of the given file - def storage_path(file_name, user_address) - directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) - - # create a new directory if it doesn't exist - FileUtils.mkdir_p(directory) unless File.directory?(directory) - - # put the given file to this directory - File.join(directory, File.basename(file_name)) - end - - # get the path to the forcesaved file version - def forcesave_path(file_name, user_address, create) - directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) - - # the directory with host address doesn't exist - return '' unless File.directory?(directory) - - # get the path to the history of the given file - directory = File.join(directory, "#{File.basename(file_name)}-hist") - unless File.directory?(directory) - return '' unless create - - FileUtils.mkdir_p(directory) # create history directory if it doesn't exist - - # the history directory doesn't exist and we are not supposed to create it + ver = 1 + Dir.foreach(hist_dir) do |e| # run through all the file versions + next if e.eql?('.') + next if e.eql?('..') + if File.directory?(File.join(hist_dir, e)) + ver += 1 # and count them end - - directory = File.join(directory, File.basename(file_name)) # get the path to the given file - return '' if !File.file?(directory) && !create - - directory.to_s end - # get the path to the file history - def history_dir(storage_path) - directory = "#{storage_path}-hist" + ver + end - # create history directory if it doesn't exist - FileUtils.mkdir_p(directory) unless File.directory?(directory) + # get the correct file name if such a name already exists + def self.get_correct_name(file_name, user_address) + max_name = 50 + ext = File.extname(file_name) # get file extension + # get file name without extension + base_name = File.basename(file_name, ext)[0...max_name] + (file_name.length > max_name ? '[...]' : '') + name = base_name + ext.downcase # get full file name + index = 1 - directory + # if the file with such a name already exists in this directory + while File.exist?(storage_path(name, user_address)) + name = "#{base_name} (#{index})#{ext.downcase}" # add an index after its base name + index += 1 end - # get the path to the specified file version - def version_dir(hist_dir, ver) - File.join(hist_dir, ver.to_s) - end + name + end - # get the last file version - def get_file_version(hist_dir) - return 1 unless Dir.exist?(hist_dir) + # get all the stored files from the folder + def self.get_stored_files(user_address) + directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) - ver = 1 - Dir.foreach(hist_dir) do |e| # run through all the file versions + arr = [] + + if Dir.exist?(directory) + Dir.foreach(directory) do |e| # run through all the elements from the folder next if e.eql?('.') next if e.eql?('..') + next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it - if File.directory?(File.join(hist_dir, e)) - ver += 1 # and count them - end - end - - ver - end - - # get the correct file name if such a name already exists - def get_correct_name(file_name, user_address) - max_name = 50 - ext = File.extname(file_name) # get file extension - # get file name without extension - base_name = File.basename(file_name, ext)[0...max_name] + (file_name.length > max_name ? '[...]' : '') - name = base_name + ext.downcase # get full file name - index = 1 - - # if the file with such a name already exists in this directory - while File.exist?(storage_path(name, user_address)) - name = "#{base_name} (#{index})#{ext.downcase}" # add an index after its base name - index += 1 - end - - name - end - - # get all the stored files from the folder - def get_stored_files(user_address) - directory = DocumentHelper.config_manager.storage_path.join(cur_user_host_address(user_address)) - - arr = [] - - if Dir.exist?(directory) - Dir.foreach(directory) do |e| # run through all the elements from the folder - next if e.eql?('.') - next if e.eql?('..') - next if File.directory?(File.join(directory, e)) # if the element is a directory, skip it - - arr.push(e) # push the file to the array - end - end - - arr - end - - # create file meta information - def create_meta(file_name, uid, uname, user_address) - hist_dir = history_dir(storage_path(file_name, user_address)) # get the path to the file history - - # write user name, user uid and the creation time to the json object - json = { - created: Time.now.to_formatted_s(:db), - uid:, - uname: - } - - # write file meta information to the createdInfo.json file - File.binwrite(File.join(hist_dir, 'createdInfo.json'), json.to_json) - end - - # create demo document - def create_demo(file_ext, sample, user) - demo_name = (sample == 'true' ? 'sample.' : 'new.') + file_ext - file_name = get_correct_name(demo_name, nil) # get the correct file name if such a name already exists - - # save sample document of a necessary extension to the storage directory - src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) - dest = storage_path(file_name, nil) - - FileUtils.cp(src, dest) - - # save file meta data to the file - - create_meta(file_name, user.id, user.name, nil) - - file_name - end - - # get file url - def get_file_uri(file_name, for_document_server) - "#{get_server_url(for_document_server)}/" \ - "#{DocumentHelper.config_manager.storage_path}/" \ - "#{cur_user_host_address(nil)}/" \ - "#{ERB::Util.url_encode(file_name)}" - end - - # get history path url - def get_historypath_uri(file_name, version, file, is_server_url: true) - # for redirection to my link - user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' - "#{get_server_url(is_server_url)}/downloadhistory/?"\ - "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ - "&file=#{ERB::Util.url_encode(file)}#{user_host}" - end - - # get server url - def get_server_url(for_document_server) - return DocumentHelper.config_manager.example_uri.to_s if - for_document_server && - DocumentHelper.config_manager.example_uri - - @base_url - end - - # get callback url - def get_callback(file_name) - "#{get_server_url(true)}/track?" \ - "fileName=#{ERB::Util.url_encode(file_name)}&" \ - "userAddress=#{cur_user_host_address(nil)}" - end - - # get url to the created file - def get_create_url(document_type) - "#{get_server_url(false)}/sample?fileExt=#{get_internal_extension(document_type).delete('.')}" - end - - # get url to download a file - def get_download_url(file_name, is_server_url: true) - user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' - "#{get_server_url(is_server_url)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" - end - - # get internal file extension by its type - def get_internal_extension(file_type) - case file_type - when 'word' # .docx for word type - '.docx' - when 'cell' # .xlsx for cell type - '.xlsx' - when 'slide' # .pptx for slide type - '.pptx' - else - '.docx' # the default value is .docx + arr.push(e) # push the file to the array end end - # get image url for templates - def get_template_image_url(file_type) - path = "#{get_server_url(true)}/assets/" - case file_type - when 'word' # for word type - "#{path}file_docx.svg" - when 'cell' # .xlsx for cell type - "#{path}file_xlsx.svg" - when 'slide' # .pptx for slide type - "#{path}file_pptx.svg" - else - "#{path}file_docx.svg" # the default value is .docx - end - end + arr + end - # get files information - def get_files_info(file_id) - result = [] + # create file meta information + def self.create_meta(file_name, uid, uname, user_address) + hist_dir = history_dir(storage_path(file_name, user_address)) # get the path to the file history - get_stored_files(nil).each do |file_name| # run through all the stored files from the folder - directory = storage_path(file_name, nil) - uri = "#{cur_user_host_address(nil)}/#{file_name}" + # write user name, user uid and the creation time to the json object + json = { + created: Time.now.to_formatted_s(:db), + uid:, + uname: + } - # write file parameters to the info object - info = { - version: get_file_version(history_dir(directory)), - id: ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), - contentLength: "#{(File.size(directory) / 1024.0).round(2)} KB", - pureContentLength: File.size(directory), - title: file_name, - updated: File.mtime(directory) - } + # write file meta information to the createdInfo.json file + File.binwrite(File.join(hist_dir, 'createdInfo.json'), json.to_json) + end - if file_id.nil? # if file id is undefined - result.push(info) # push info object to the response array - elsif file_id.eql?(info['id']) # if file id is defined - result.push(info) # response object will be equal to the info object - return result # and it is equal to the document key value - end - end + # create demo document + def self.create_demo(file_ext, sample, user) + demo_name = (sample == 'true' ? 'sample.' : 'new.') + file_ext + file_name = get_correct_name(demo_name, nil) # get the correct file name if such a name already exists - return '"File not found"' unless file_id.nil? + # save sample document of a necessary extension to the storage directory + src = Rails.root.join('assets', 'document-templates', sample == 'true' ? 'sample' : 'new', demo_name) + dest = storage_path(file_name, nil) - result - end + FileUtils.cp(src, dest) - # enable ignore certificate - def verify_ssl(file_uri, http) - return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled + # save file meta data to the file - http.use_ssl = true - # set the flags for the server certificate verification at the beginning of SSL session - http.verify_mode = OpenSSL::SSL::VERIFY_NONE + create_meta(file_name, user.id, user.name, nil) + + file_name + end + + # get file url + def self.get_file_uri(file_name, for_document_server) + "#{get_server_url(for_document_server)}/" \ + "#{DocumentHelper.config_manager.storage_path}/" \ + "#{cur_user_host_address(nil)}/" \ + "#{ERB::Util.url_encode(file_name)}" + end + + # get history path url + def self.get_historypath_uri(file_name, version, file, is_server_url: true) + # for redirection to my link + user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' + "#{get_server_url(is_server_url)}/downloadhistory/?"\ + "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ + "&file=#{ERB::Util.url_encode(file)}#{user_host}" + end + + # get server url + def self.get_server_url(for_document_server) + return DocumentHelper.config_manager.example_uri.to_s if + for_document_server && + DocumentHelper.config_manager.example_uri + + @base_url + end + + # get callback url + def self.get_callback(file_name) + "#{get_server_url(true)}/track?" \ + "fileName=#{ERB::Util.url_encode(file_name)}&" \ + "userAddress=#{cur_user_host_address(nil)}" + end + + # get url to the created file + def self.get_create_url(document_type) + "#{get_server_url(false)}/sample?fileExt=#{get_internal_extension(document_type).delete('.')}" + end + + # get url to download a file + def self.get_download_url(file_name, is_server_url: true) + user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' + "#{get_server_url(is_server_url)}/download?fileName=#{ERB::Util.url_encode(file_name)}#{user_host}" + end + + # get internal file extension by its type + def self.get_internal_extension(file_type) + case file_type + when 'word' # .docx for word type + '.docx' + when 'cell' # .xlsx for cell type + '.xlsx' + when 'slide' # .pptx for slide type + '.pptx' + else + '.docx' # the default value is .docx end end + + # get image url for templates + def self.get_template_image_url(file_type) + path = "#{get_server_url(true)}/assets/" + case file_type + when 'word' # for word type + "#{path}file_docx.svg" + when 'cell' # .xlsx for cell type + "#{path}file_xlsx.svg" + when 'slide' # .pptx for slide type + "#{path}file_pptx.svg" + else + "#{path}file_docx.svg" # the default value is .docx + end + end + + # get files information + def self.get_files_info(file_id) + result = [] + + get_stored_files(nil).each do |file_name| # run through all the stored files from the folder + directory = storage_path(file_name, nil) + uri = "#{cur_user_host_address(nil)}/#{file_name}" + + # write file parameters to the info object + info = { + version: get_file_version(history_dir(directory)), + id: ServiceConverter.generate_revision_id("#{uri}.#{File.mtime(directory)}"), + contentLength: "#{(File.size(directory) / 1024.0).round(2)} KB", + pureContentLength: File.size(directory), + title: file_name, + updated: File.mtime(directory) + } + + if file_id.nil? # if file id is undefined + result.push(info) # push info object to the response array + elsif file_id.eql?(info['id']) # if file id is defined + result.push(info) # response object will be equal to the info object + return result # and it is equal to the document key value + end + end + + return '"File not found"' unless file_id.nil? + + result + end + + # enable ignore certificate + def self.verify_ssl(file_uri, http) + return unless file_uri.start_with?('https') && DocumentHelper.config_manager.ssl_verify_peer_mode_enabled + + http.use_ssl = true + # set the flags for the server certificate verification at the beginning of SSL session + http.verify_mode = OpenSSL::SSL::VERIFY_NONE + end end diff --git a/web/documentserver-example/ruby/app/models/file_utility.rb b/web/documentserver-example/ruby/app/models/file_utility.rb index 52551f2a..e521aa22 100644 --- a/web/documentserver-example/ruby/app/models/file_utility.rb +++ b/web/documentserver-example/ruby/app/models/file_utility.rb @@ -25,14 +25,15 @@ class FileUtility class << self attr_reader :format_manager - def get_file_type(file_name) - ext = File.extname(file_name).downcase + end - return 'word' if FileUtility.format_manager.document_extensinons.include?(ext) - return 'cell' if FileUtility.format_manager.spreadsheet_extensinons.include?(ext) - return 'slide' if FileUtility.format_manager.presentation_extensinons.include?(ext) + def self.get_file_type(file_name) + ext = File.extname(file_name).downcase - 'word' - end + return 'word' if FileUtility.format_manager.document_extensinons.include?(ext) + return 'cell' if FileUtility.format_manager.spreadsheet_extensinons.include?(ext) + return 'slide' if FileUtility.format_manager.presentation_extensinons.include?(ext) + + 'word' end end diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 55ab0b32..92c58017 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -24,32 +24,30 @@ class JwtHelper @jwt_secret = ConfigurationManager.new.jwt_secret @token_use_for_request = ConfigurationManager.new.jwt_use_for_request - class << self - # check if a secret key to generate token exists or not - def enabled? - @jwt_secret && !@jwt_secret.empty? ? true : false - end + # check if a secret key to generate token exists or not + def self.enabled? + @jwt_secret && !@jwt_secret.empty? ? true : false + end - # check if a secret key used for request - def use_for_request - @token_use_for_request - end + # check if a secret key used for request + def self.use_for_request + @token_use_for_request + end - # encode a payload object into a token using a secret key - def encode(payload) - JWT.encode(payload, @jwt_secret, 'HS256') # define the hashing algorithm and get token - end + # encode a payload object into a token using a secret key + def self.encode(payload) + JWT.encode(payload, @jwt_secret, 'HS256') # define the hashing algorithm and get token + end - # decode a token into a payload object using a secret key - def decode(token) - begin - decoded = JWT.decode(token, @jwt_secret, true, { algorithm: 'HS256' }) - rescue StandardError - return '' - end - # decoded = Array [ {"data"=>"test"}, # payload - # {"alg"=>"HS256"} # header ] - decoded[0].to_json # get json payload + # decode a token into a payload object using a secret key + def self.decode(token) + begin + decoded = JWT.decode(token, @jwt_secret, true, { algorithm: 'HS256' }) + rescue StandardError + return '' end + # decoded = Array [ {"data"=>"test"}, # payload + # {"alg"=>"HS256"} # header ] + decoded[0].to_json # get json payload end end diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index 507dfa68..e58bcd3a 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -29,150 +29,148 @@ class ServiceConverter @convert_timeout = ServiceConverter.config_manager.convertation_timeout @document_converter_url = ServiceConverter.config_manager.document_server_converter_uri.to_s - class << self - # get the url of the converted file - def get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) - from_ext = File.extname(document_uri).downcase if from_ext.nil? # get the current document extension + # get the url of the converted file + def self.get_converted_data(document_uri, from_ext, to_ext, document_revision_id, is_async, file_pass, lang = nil) + from_ext = File.extname(document_uri).downcase if from_ext.nil? # get the current document extension - # get the current document name or uuid - title = File.basename(URI.parse(document_uri).path) - title = UUID.generate.to_s if title.nil? + # get the current document name or uuid + title = File.basename(URI.parse(document_uri).path) + title = UUID.generate.to_s if title.nil? - # get the document key - document_revision_id = document_uri if document_revision_id.empty? - document_revision_id = generate_revision_id(document_revision_id) + # get the document key + document_revision_id = document_uri if document_revision_id.empty? + document_revision_id = generate_revision_id(document_revision_id) - payload = { # write all the conversion parameters to the payload - async: is_async ? true : false, - url: document_uri, - outputtype: to_ext.delete('.'), - filetype: from_ext.delete('.'), - title:, - key: document_revision_id, - password: file_pass, - region: lang - } + payload = { # write all the conversion parameters to the payload + async: is_async ? true : false, + url: document_uri, + outputtype: to_ext.delete('.'), + filetype: from_ext.delete('.'), + title:, + key: document_revision_id, + password: file_pass, + region: lang + } - data = nil - begin - uri = URI.parse(@document_converter_url) # create the request url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + data = nil + begin + uri = URI.parse(@document_converter_url) # create the request url + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - DocumentHelper.verify_ssl(@document_converter_url, http) + DocumentHelper.verify_ssl(@document_converter_url, http) - http.read_timeout = @convert_timeout - http.open_timeout = 5 - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field('Accept', 'application/json') # set headers - req.add_field('Content-Type', 'application/json') + http.read_timeout = @convert_timeout + http.open_timeout = 5 + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field('Accept', 'application/json') # set headers + req.add_field('Content-Type', 'application/json') - if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled - payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload - jwt_header = ServiceConverter.config_manager.jwt_header; # get signature authorization header - # set it to the request with the Bearer prefix - req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") - end - - req.body = payload.to_json - res = http.request(req) # get the response - - status_code = Integer(res.code, 10) - raise("Conversion service returned status: #{status_code}") if status_code != 200 # checking status code - - data = res.body # and take its body - rescue Timeout::Error - # try again - rescue StandardError => e - raise(e.message) + if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled + payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload + jwt_header = ServiceConverter.config_manager.jwt_header; # get signature authorization header + # set it to the request with the Bearer prefix + req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") end - json_data = JSON.parse(data) # parse response body - get_response_data(json_data) # get response url + req.body = payload.to_json + res = http.request(req) # get the response + + status_code = Integer(res.code, 10) + raise("Conversion service returned status: #{status_code}") if status_code != 200 # checking status code + + data = res.body # and take its body + rescue Timeout::Error + # try again + rescue StandardError => e + raise(e.message) end - # generate the document key value - def generate_revision_id(expected_key) - require('zlib') + json_data = JSON.parse(data) # parse response body + get_response_data(json_data) # get response url + end - if expected_key.length > 20 # check if the expected key length is greater than 20 - # calculate 32-bit crc value from the expected key and turn it into the string - expected_key = Zlib.crc32(expected_key).to_s - end + # generate the document key value + def self.generate_revision_id(expected_key) + require('zlib') - key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') - key[(key.length - [key.length, 20].min)..key.length] # the resulting key is of the length 20 or less + if expected_key.length > 20 # check if the expected key length is greater than 20 + # calculate 32-bit crc value from the expected key and turn it into the string + expected_key = Zlib.crc32(expected_key).to_s end - # create an error message for the error code - def process_convert_service_responce_error(error_code) - error_message = 'unknown error' + key = expected_key.gsub(/[^0-9a-zA-Z.=]/, '_') + key[(key.length - [key.length, 20].min)..key.length] # the resulting key is of the length 20 or less + end - # add an error message to the error message template depending on the error code - case error_code - when -8 - error_message = 'Error occurred in the ConvertService.ashx: Error document VKey' - when -7 - error_message = 'Error occurred in the ConvertService.ashx: Error document request' - when -6 - error_message = 'Error occurred in the ConvertService.ashx: Error database' - when -5 - error_message = 'Error occurred in the ConvertService.ashx: Incorrect password' - when -4 - error_message = 'Error occurred in the ConvertService.ashx: Error download error' - when -3 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation error' - when -2 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation timeout' - when -1 - error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' - when 0 - # public const int c_nErrorNo = 0 - else - error_message = "ErrorCode = #{error_code}" # default value for the error message - end + # create an error message for the error code + def self.process_convert_service_responce_error(error_code) + error_message = 'unknown error' - raise(error_message) + # add an error message to the error message template depending on the error code + case error_code + when -8 + error_message = 'Error occurred in the ConvertService.ashx: Error document VKey' + when -7 + error_message = 'Error occurred in the ConvertService.ashx: Error document request' + when -6 + error_message = 'Error occurred in the ConvertService.ashx: Error database' + when -5 + error_message = 'Error occurred in the ConvertService.ashx: Incorrect password' + when -4 + error_message = 'Error occurred in the ConvertService.ashx: Error download error' + when -3 + error_message = 'Error occurred in the ConvertService.ashx: Error convertation error' + when -2 + error_message = 'Error occurred in the ConvertService.ashx: Error convertation timeout' + when -1 + error_message = 'Error occurred in the ConvertService.ashx: Error convertation unknown' + when 0 + # public const int c_nErrorNo = 0 + else + error_message = "ErrorCode = #{error_code}" # default value for the error message end - # get the response url - def get_response_data(json_data) - file_result = json_data + raise(error_message) + end - error_element = file_result['error'] - unless error_element.nil? # if an error occurs - process_convert_service_responce_error(Integer(error_element, 10)) # get an error message - end + # get the response url + def self.get_response_data(json_data) + file_result = json_data - is_end_convert = file_result['endConvert'] # check if the conversion is completed - - result_percent = 0 # the conversion percentage - response_uri = '' - response_file_type = '' - - if is_end_convert # if the conversion is completed - - file_url_element = file_result['fileUrl'] - file_type_element = file_result['fileType'] - - if file_url_element.nil? # and the file url doesn't exist - raise('Invalid answer format') # get ann error message - end - - response_uri = file_url_element # otherwise, get the file url - response_file_type = file_type_element # get the file type - result_percent = 100 - - else # if the conversion isn't completed - - percent_element = file_result['percent'] # get the percentage value - - result_percent = Integer(percent_element, 10) unless percent_element.nil? - - result_percent = 99 if result_percent >= 100 - - end - - [result_percent, response_uri, response_file_type] + error_element = file_result['error'] + unless error_element.nil? # if an error occurs + process_convert_service_responce_error(Integer(error_element, 10)) # get an error message end + + is_end_convert = file_result['endConvert'] # check if the conversion is completed + + result_percent = 0 # the conversion percentage + response_uri = '' + response_file_type = '' + + if is_end_convert # if the conversion is completed + + file_url_element = file_result['fileUrl'] + file_type_element = file_result['fileType'] + + if file_url_element.nil? # and the file url doesn't exist + raise('Invalid answer format') # get ann error message + end + + response_uri = file_url_element # otherwise, get the file url + response_file_type = file_type_element # get the file type + result_percent = 100 + + else # if the conversion isn't completed + + percent_element = file_result['percent'] # get the percentage value + + result_percent = Integer(percent_element, 10) unless percent_element.nil? + + result_percent = 99 if result_percent >= 100 + + end + + [result_percent, response_uri, response_file_type] end end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 592e4de9..2497a4c6 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -32,301 +32,299 @@ class TrackHelper @document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s - class << self - # read the request body - def read_body(request) - body = request.body.read + # read the request body + def self.read_body(request) + body = request.body.read - return '' if body.nil? || body.empty? + return '' if body.nil? || body.empty? - file_data = JSON.parse(body) # parse file data + file_data = JSON.parse(body) # parse file data - # check if a secret key to generate token exists or not - if JwtHelper.enabled? && JwtHelper.use_for_request - in_header = false - token = nil - jwt_header = TrackHelper.config_manager.jwt_header; # get the authorization header from the config - if file_data['token'] # if the token is in the body - token = JwtHelper.decode(file_data['token']) # decode a token into a payload object using a secret key - elsif request.headers[jwt_header] # if the token is in the header - hdr = request.headers[jwt_header] - hdr.slice!(0, 'Bearer '.length) # get token from it (after Bearer prefix) - token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key - in_header = true - else - raise('Expected JWT') # token missing error message - end - - raise('Invalid JWT signature') if !token || token.eql?('') - - file_data = JSON.parse(token) - - file_data = file_data['payload'] if in_header + # check if a secret key to generate token exists or not + if JwtHelper.enabled? && JwtHelper.use_for_request + in_header = false + token = nil + jwt_header = TrackHelper.config_manager.jwt_header; # get the authorization header from the config + if file_data['token'] # if the token is in the body + token = JwtHelper.decode(file_data['token']) # decode a token into a payload object using a secret key + elsif request.headers[jwt_header] # if the token is in the header + hdr = request.headers[jwt_header] + hdr.slice!(0, 'Bearer '.length) # get token from it (after Bearer prefix) + token = JwtHelper.decode(hdr) # decode a token into a payload object using a secret key + in_header = true + else + raise('Expected JWT') # token missing error message end - file_data + raise('Invalid JWT signature') if !token || token.eql?('') + + file_data = JSON.parse(token) + + file_data = file_data['payload'] if in_header end - def resolve_process_save_body(body) - copied = body.dup + file_data + end - url = copied['url'] - if url - uri = URI(url) - resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) - copied['url'] = resolved_uri.to_s - end + def self.resolve_process_save_body(body) + copied = body.dup - changesurl = copied['changesurl'] - if changesurl - uri = URI(changesurl) - resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) - copied['changesurl'] = resolved_uri.to_s - end - - home = copied['home'] - copied['home'] = resolve_process_save_body(home) if home - - copied + url = copied['url'] + if url + uri = URI(url) + resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) + copied['url'] = resolved_uri.to_s end - # file saving process - def process_save(raw_file_data, file_name, user_address) - file_data = resolve_process_save_body(raw_file_data) + changesurl = copied['changesurl'] + if changesurl + uri = URI(changesurl) + resolved_uri = TrackHelper.proxy_manager.resolve_uri(uri) + copied['changesurl'] = resolved_uri.to_s + end - download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved - end + home = copied['home'] + copied['home'] = resolve_process_save_body(home) if home - new_file_name = file_name - download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file + copied + end - cur_ext = File.extname(file_name).downcase # get current file extension + # file saving process + def self.process_save(raw_file_data, file_name, user_address) + file_data = resolve_process_save_body(raw_file_data) - # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - _, new_file_uri, = ServiceConverter.get_converted_data( - download_uri, - download_ext.delete('.'), - cur_ext.delete('.'), - key, - false, - nil - ) # get the url of the converted file - if new_file_uri.nil? || new_file_uri.empty? - new_file_name = DocumentHelper.get_correct_name( - File.basename(file_name, cur_ext) + download_ext, - user_address - ) # get the correct file name if it already exists - else - download_uri = new_file_uri - end - rescue StandardError + download_uri = file_data['url'] + if download_uri.eql?(nil) + saved = 1 + return saved + end + + new_file_name = file_name + download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file + + cur_ext = File.extname(file_name).downcase # get current file extension + + # convert downloaded file to the file with the current extension if these extensions aren't equal + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key + begin + _, new_file_uri, = ServiceConverter.get_converted_data( + download_uri, + download_ext.delete('.'), + cur_ext.delete('.'), + key, + false, + nil + ) # get the url of the converted file + if new_file_uri.nil? || new_file_uri.empty? new_file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, user_address + ) # get the correct file name if it already exists + else + download_uri = new_file_uri + end + rescue StandardError + new_file_name = DocumentHelper.get_correct_name( + File.basename(file_name, cur_ext) + download_ext, + user_address +) + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + return saved if data.eql?(nil) + + begin + # get the storage directory of the new file + storage_path = DocumentHelper.storage_path(new_file_name, user_address) + + hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file + # get the path to the specified file version + ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) + + FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist + + # move the file from the storage directory to the previous file version directory + FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) + + save_file(data, storage_path) # save the downloaded file to the storage directory + + change_data = download_file(file_data['changesurl']) # download file with document versions differences + save_file(change_data, File.join(ver_dir, 'diff.zip')) # save file with document versions differences + + hist_data = file_data['changeshistory'] + hist_data ||= file_data['history'].to_json + if hist_data + File.binwrite(File.join(ver_dir, 'changes.json'), hist_data) + end + + # write the key value to the key.txt file + File.binwrite(File.join(ver_dir, 'key.txt'), file_data['key']) + + # get the path to the forcesaved file + forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) + unless forcesave_path.eql?('') # if this path is empty + File.delete(forcesave_path) # remove it + end + + saved = 0 + rescue StandardError + saved = 1 + end + + saved + end + + # file force saving process + def self.process_force_save(file_data, file_name, user_address) + download_uri = file_data['url'] + if download_uri.eql?(nil) + saved = 1 + return saved + end + + download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file + + cur_ext = File.extname(file_name).downcase # get current file extension + + new_file_name = false + + # convert downloaded file to the file with the current extension if these extensions aren't equal + unless cur_ext.eql?(download_ext) + key = ServiceConverter.generate_revision_id(download_uri) # get the document key + begin + _, new_file_uri, = ServiceConverter.get_converted_data( + download_uri, + download_ext.delete('.'), + cur_ext.delete('.'), + key, + false, + nil + ) # get the url of the converted file + if new_file_uri.nil? || new_file_uri.empty? + new_file_name = true + else + download_uri = new_file_uri + end + rescue StandardError + new_file_name = true + end + end + + saved = 1 + + data = download_file(download_uri) # download document file + return saved if data.eql?(nil) + + begin + # check if the forcesave type is equal to 3 (the form was submitted) + is_submit_form = Integer(file_data['forcesavetype'], 10) == 3 + + if is_submit_form + file_name = if new_file_name + DocumentHelper.get_correct_name( + "#{File.basename(file_name, cur_ext)}-form#{download_ext}", + user_address +) # get the correct file name if it already exists + else + DocumentHelper.get_correct_name( + "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", + user_address +) + end + forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + else + if new_file_name + file_name = DocumentHelper.get_correct_name( + File.basename(file_name, cur_ext) + download_ext, + user_address ) end + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) + if forcesave_path.eql?('') + # if the path to the new file doesn't exist, create it + forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) + end end + save_file(data, forcesave_path) # save the downloaded file to the storage directory + + if is_submit_form + uid = file_data['actions'][0]['userid'] + # create file meta information with the Filling form tag instead of user name + DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) + end + + saved = 0 + rescue StandardError saved = 1 - - data = download_file(download_uri) # download document file - return saved if data.eql?(nil) - - begin - # get the storage directory of the new file - storage_path = DocumentHelper.storage_path(new_file_name, user_address) - - hist_dir = DocumentHelper.history_dir(storage_path) # get the history directory of the new file - # get the path to the specified file version - ver_dir = DocumentHelper.version_dir(hist_dir, DocumentHelper.get_file_version(hist_dir)) - - FileUtils.mkdir_p(ver_dir) # create the version directory if doesn't exist - - # move the file from the storage directory to the previous file version directory - FileUtils.move(DocumentHelper.storage_path(file_name, user_address), File.join(ver_dir, "prev#{cur_ext}")) - - save_file(data, storage_path) # save the downloaded file to the storage directory - - change_data = download_file(file_data['changesurl']) # download file with document versions differences - save_file(change_data, File.join(ver_dir, 'diff.zip')) # save file with document versions differences - - hist_data = file_data['changeshistory'] - hist_data ||= file_data['history'].to_json - if hist_data - File.binwrite(File.join(ver_dir, 'changes.json'), hist_data) - end - - # write the key value to the key.txt file - File.binwrite(File.join(ver_dir, 'key.txt'), file_data['key']) - - # get the path to the forcesaved file - forcesave_path = DocumentHelper.forcesave_path(new_file_name, user_address, false) - unless forcesave_path.eql?('') # if this path is empty - File.delete(forcesave_path) # remove it - end - - saved = 0 - rescue StandardError - saved = 1 - end - - saved end - # file force saving process - def process_force_save(file_data, file_name, user_address) - download_uri = file_data['url'] - if download_uri.eql?(nil) - saved = 1 - return saved - end + saved + end - download_ext = ".#{file_data['filetype']}" # get the extension of the downloaded file + # send the command request + def self.command_request(method, key, meta = nil) + # create a payload object with the method and key + payload = { + c: method, + key: + } - cur_ext = File.extname(file_name).downcase # get current file extension + payload.merge!({ meta: }) unless meta.nil? - new_file_name = false - - # convert downloaded file to the file with the current extension if these extensions aren't equal - unless cur_ext.eql?(download_ext) - key = ServiceConverter.generate_revision_id(download_uri) # get the document key - begin - _, new_file_uri, = ServiceConverter.get_converted_data( - download_uri, - download_ext.delete('.'), - cur_ext.delete('.'), - key, - false, - nil - ) # get the url of the converted file - if new_file_uri.nil? || new_file_uri.empty? - new_file_name = true - else - download_uri = new_file_uri - end - rescue StandardError - new_file_name = true - end - end - - saved = 1 - - data = download_file(download_uri) # download document file - return saved if data.eql?(nil) - - begin - # check if the forcesave type is equal to 3 (the form was submitted) - is_submit_form = Integer(file_data['forcesavetype'], 10) == 3 - - if is_submit_form - file_name = if new_file_name - DocumentHelper.get_correct_name( - "#{File.basename(file_name, cur_ext)}-form#{download_ext}", - user_address -) # get the correct file name if it already exists - else - DocumentHelper.get_correct_name( - "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", - user_address -) - end - forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file - else - if new_file_name - file_name = DocumentHelper.get_correct_name( - File.basename(file_name, cur_ext) + download_ext, - user_address -) - end - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) - if forcesave_path.eql?('') - # if the path to the new file doesn't exist, create it - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) - end - end - - save_file(data, forcesave_path) # save the downloaded file to the storage directory - - if is_submit_form - uid = file_data['actions'][0]['userid'] - # create file meta information with the Filling form tag instead of user name - DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) - end - - saved = 0 - rescue StandardError - saved = 1 - end - - saved - end - - # send the command request - def command_request(method, key, meta = nil) - # create a payload object with the method and key - payload = { - c: method, - key: - } - - payload.merge!({ meta: }) unless meta.nil? - - data = nil - begin - uri = URI.parse(@document_command_url) # parse the document command url - http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - - DocumentHelper.verify_ssl(@document_command_url, http) - - req = Net::HTTP::Post.new(uri.request_uri) # create the post request - req.add_field('Content-Type', 'application/json') # set headers - - if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled - payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload - jwt_header = TrackHelper.config_manager.jwt_header; # get signature authorization header - # set it to the request with the Bearer prefix - req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") - end - - req.body = payload.to_json # convert the payload object into the json format - res = http.request(req) # get the response - data = res.body # and take its body - rescue StandardError => e - raise(e.message) - end - - JSON.parse(data) # convert the response body into the json format - end - - # save file from the url - def download_file(uristr) - uri = URI.parse(uristr) # parse the url string + data = nil + begin + uri = URI.parse(@document_command_url) # parse the document command url http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server - http.open_timeout = 5 - DocumentHelper.verify_ssl(uristr, http) + DocumentHelper.verify_ssl(@document_command_url, http) - req = Net::HTTP::Get.new(uri) + req = Net::HTTP::Post.new(uri.request_uri) # create the post request + req.add_field('Content-Type', 'application/json') # set headers + + if JwtHelper.enabled? && JwtHelper.use_for_request # if the signature is enabled + payload['token'] = JwtHelper.encode(payload) # get token and save it to the payload + jwt_header = TrackHelper.config_manager.jwt_header; # get signature authorization header + # set it to the request with the Bearer prefix + req.add_field(jwt_header, "Bearer #{JwtHelper.encode({ payload: })}") + end + + req.body = payload.to_json # convert the payload object into the json format res = http.request(req) # get the response - - status_code = res.code - raise("Document editing service returned status: #{status_code}") if status_code != '200' # checking status code - data = res.body # and take its body - - raise('stream is null') if data.nil? - - data + rescue StandardError => e + raise(e.message) end - def save_file(data, path) - File.binwrite(path, data) - end + JSON.parse(data) # convert the response body into the json format + end + + # save file from the url + def self.download_file(uristr) + uri = URI.parse(uristr) # parse the url string + http = Net::HTTP.new(uri.host, uri.port) # create a connection to the http server + http.open_timeout = 5 + + DocumentHelper.verify_ssl(uristr, http) + + req = Net::HTTP::Get.new(uri) + res = http.request(req) # get the response + + status_code = res.code + raise("Document editing service returned status: #{status_code}") if status_code != '200' # checking status code + + data = res.body # and take its body + + raise('stream is null') if data.nil? + + data + end + + def self.save_file(data, path) + File.binwrite(path, data) end end diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 9a8ae5cc..20549a77 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -176,37 +176,35 @@ class Users ) ] - class << self - def all_users - @users - end + def self.all_users + @users + end - # get a user by id specified - def get_user(id) - @users.each do |user| - return user if user.id.eql?(id) - end - @users[0] + # get a user by id specified + def self.get_user(id) + @users.each do |user| + return user if user.id.eql?(id) end + @users[0] + end - # get a list of users with their names and emails for mentions - def get_users_for_mentions(id) - users_data = [] - @users.each do |user| - if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? - users_data.push({ name: user.name, email: user.email }) - end + # get a list of users with their names and emails for mentions + def self.get_users_for_mentions(id) + users_data = [] + @users.each do |user| + if !user.id.eql?(id) && !user.name.nil? && !user.email.nil? + users_data.push({ name: user.name, email: user.email }) end - users_data end + users_data + end - # get a list of users with their id, names and emails for protect - def get_users_for_protect(id) - users_data = [] - @users.each do |user| - users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? - end - users_data + # get a list of users with their id, names and emails for protect + def self.get_users_for_protect(id) + users_data = [] + @users.each do |user| + users_data.push({ id: user.id, name: user.name, email: user.email }) if !user.id.eql?(id) && !user.name.nil? end + users_data end end From 4577861f8b3537a5ce3e48b92195845fe8d4faa4 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:48:42 +0300 Subject: [PATCH 132/176] ruby: Layout/ClosingParenthesisIndentation correct --- web/documentserver-example/ruby/app/models/file_model.rb | 4 ++-- .../ruby/app/models/track_helper.rb | 8 ++++---- web/documentserver-example/ruby/app/models/users.rb | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index fb4fd5a1..df823ea6 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -54,7 +54,7 @@ class FileModel DocumentHelper.get_file_uri( @file_name, false -) + ) end end @@ -260,7 +260,7 @@ class FileModel i, "prev#{file_ext}", false -) + ) end end data_obj['version'] = i diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 2497a4c6..7f839f4e 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -128,7 +128,7 @@ class TrackHelper new_file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, user_address -) + ) end end @@ -228,12 +228,12 @@ class TrackHelper DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{download_ext}", user_address -) # get the correct file name if it already exists + ) # get the correct file name if it already exists else DocumentHelper.get_correct_name( "#{File.basename(file_name, cur_ext)}-form#{cur_ext}", user_address -) + ) end forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file else @@ -241,7 +241,7 @@ class TrackHelper file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, user_address -) + ) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 20549a77..5847d6e0 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -123,7 +123,7 @@ class Users @descr_user_first, true, true -), + ), User.new( 'uid-2', 'Mark Pottato', @@ -141,7 +141,7 @@ class Users @descr_user_second, false, true -), + ), User.new( 'uid-3', 'Hamish Mitchell', @@ -159,7 +159,7 @@ class Users @descr_user_third, false, false -), + ), User.new( 'uid-0', nil, @@ -173,7 +173,7 @@ class Users @descr_user_null, false, false -) + ) ] def self.all_users From 066de3359d5d536e3f4a6ea2dcac069bdcf05b00 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:49:06 +0300 Subject: [PATCH 133/176] ruby: Layout/ExtraSpacing correct --- .../ruby/app/models/service_converter.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/service_converter.rb b/web/documentserver-example/ruby/app/models/service_converter.rb index e58bcd3a..43c1d94d 100755 --- a/web/documentserver-example/ruby/app/models/service_converter.rb +++ b/web/documentserver-example/ruby/app/models/service_converter.rb @@ -154,10 +154,10 @@ class ServiceConverter file_type_element = file_result['fileType'] if file_url_element.nil? # and the file url doesn't exist - raise('Invalid answer format') # get ann error message + raise('Invalid answer format') # get ann error message end - response_uri = file_url_element # otherwise, get the file url + response_uri = file_url_element # otherwise, get the file url response_file_type = file_type_element # get the file type result_percent = 100 From 4ff7b6e543566fa8ee2a7ec518c96f8c620a924f Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:49:36 +0300 Subject: [PATCH 134/176] ruby: Layout/IndentationWidth correct --- .../ruby/app/models/file_model.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index df823ea6..4e318221 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -284,12 +284,12 @@ class FileModel # write key and url information about previous file version with optional direct url data( obj['previous'] = if enable_direct_url? == true - { # write key and url information about previous file version with optional directUrl - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'], - directUrl: prev['directUrl'] - } + { # write key and url information about previous file version with optional directUrl + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'], + directUrl: prev['directUrl'] + } else { fileType: prev['fileType'], From d613a0206859b128e4e689684378222eec0610fb Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:50:13 +0300 Subject: [PATCH 135/176] ruby: Layout/FirstHashElementLineBreak correct --- web/documentserver-example/ruby/app/models/file_model.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 4e318221..ec34f18d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -149,7 +149,8 @@ class FileModel referenceData: { instanceId: DocumentHelper.get_server_url(false), fileKey: unless @user.id.eql?('uid-0') - { fileName: @file_name, + { +fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json end } From d4b2bf95bc70fb898f2b12bf08e2e7690ad65013 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:50:33 +0300 Subject: [PATCH 136/176] ruby: Layout/LineContinuationSpacing correct --- web/documentserver-example/ruby/app/models/document_helper.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 765eaafa..12a9a94e 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -220,8 +220,8 @@ class DocumentHelper def self.get_historypath_uri(file_name, version, file, is_server_url: true) # for redirection to my link user_host = is_server_url ? "&userAddress=#{cur_user_host_address(nil)}" : '' - "#{get_server_url(is_server_url)}/downloadhistory/?"\ - "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}"\ + "#{get_server_url(is_server_url)}/downloadhistory/?" \ + "fileName=#{ERB::Util.url_encode(file_name)}&ver=#{version}" \ "&file=#{ERB::Util.url_encode(file)}#{user_host}" end From 10e1848beb1418c5cfd08471e5a81d79989c6090 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:50:59 +0300 Subject: [PATCH 137/176] ruby: Style/AccessorGrouping correct --- .../ruby/app/models/document_helper.rb | 3 ++- .../ruby/app/models/file_model.rb | 9 ++++++- .../ruby/app/models/track_helper.rb | 3 ++- .../ruby/app/models/users.rb | 24 +++++++++---------- 4 files changed, 24 insertions(+), 15 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 12a9a94e..7f7311e6 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -25,7 +25,8 @@ class DocumentHelper @format_manager = FormatManager.new class << self - attr_reader :config_manager, :format_manager + attr_reader :config_manager + attr_reader :format_manager end @runtime_cache = {} diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index ec34f18d..0400d5dd 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -20,7 +20,14 @@ require_relative '../configuration/configuration' # Class for handling file-related operations and information. class FileModel - attr_accessor :file_name, :mode, :type, :user_ip, :lang, :user, :action_data, :direct_url + attr_accessor :file_name + attr_accessor :mode + attr_accessor :type + attr_accessor :user_ip + attr_accessor :lang + attr_accessor :user + attr_accessor :action_data + attr_accessor :direct_url attr_reader :config_manager # set file parameters diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 7f839f4e..220d7907 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -27,7 +27,8 @@ class TrackHelper @proxy_manager = ProxyManager.new(config_manager: @config_manager) class << self - attr_reader :config_manager, :proxy_manager + attr_reader :config_manager + attr_reader :proxy_manager end @document_command_url = TrackHelper.config_manager.document_server_command_uri.to_s diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 5847d6e0..8a160e8b 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -18,18 +18,18 @@ # Represents a user with various attributes class User - attr_accessor :id, - :name, - :email, - :group, - :review_groups, - :comment_groups, - :user_info_groups, - :favorite, - :denied_permissions, - :descriptions, - :templates, - :avatar + attr_accessor :id + attr_accessor :name + attr_accessor :email + attr_accessor :group + attr_accessor :review_groups + attr_accessor :comment_groups + attr_accessor :user_info_groups + attr_accessor :favorite + attr_accessor :denied_permissions + attr_accessor :descriptions + attr_accessor :templates + attr_accessor :avatar def initialize(id, name, From 97420e18cf7d326b865e40447fcd710365f0fee3 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:51:34 +0300 Subject: [PATCH 138/176] ruby: Style/AccessModifierDeclarations correct --- web/documentserver-example/ruby/app/format/format.rb | 5 ++--- web/documentserver-example/ruby/app/proxy/proxy.rb | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/format/format.rb b/web/documentserver-example/ruby/app/format/format.rb index 03f1a04e..378cfb7e 100644 --- a/web/documentserver-example/ruby/app/format/format.rb +++ b/web/documentserver-example/ruby/app/format/format.rb @@ -146,15 +146,14 @@ class FormatManager end end - private sig { returns(Pathname) } - def file + private def file directory.join('onlyoffice-docs-formats.json') end sig { returns(Pathname) } - def directory + private def directory current_directory = Pathname(T.must(__dir__)) directory = current_directory.join('..', '..', 'assets', 'document-formats') directory.cleanpath diff --git a/web/documentserver-example/ruby/app/proxy/proxy.rb b/web/documentserver-example/ruby/app/proxy/proxy.rb index 8fee7df3..1ddb1d1b 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy.rb @@ -37,10 +37,9 @@ class ProxyManager redirect_public_url(uri) end - private sig { params(uri: URI::Generic).returns(T::Boolean) } - def refer_public_url(uri) + private def refer_public_url(uri) public_uri = @config_manager.document_server_public_uri uri.scheme == public_uri.scheme && uri.host == public_uri.host && @@ -48,7 +47,7 @@ class ProxyManager end sig { params(uri: URI::Generic).returns(URI::Generic) } - def redirect_public_url(uri) + private def redirect_public_url(uri) private_uri = @config_manager.document_server_private_uri redirected_uri = uri redirected_uri.scheme = private_uri.scheme From 5148fd26013792f83f17e1f70be55e27a715320c Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:52:02 +0300 Subject: [PATCH 139/176] ruby: Layout/EmptyLines correct --- .../ruby/app/controllers/home_controller.rb | 2 -- web/documentserver-example/ruby/app/format/format.rb | 1 - web/documentserver-example/ruby/app/proxy/proxy.rb | 1 - 3 files changed, 4 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index b6d0ff15..6b8fb363 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -242,11 +242,9 @@ class HomeController < ApplicationController # if the file exists FileUtils.rm_f(storage_path) # delete it from the storage path - # if the history directory of this file exists FileUtils.rm_rf(hist_dir) # delete it - render(plain: '{"success":true}') # report that the operation is successful nil end diff --git a/web/documentserver-example/ruby/app/format/format.rb b/web/documentserver-example/ruby/app/format/format.rb index 378cfb7e..cb242ca0 100644 --- a/web/documentserver-example/ruby/app/format/format.rb +++ b/web/documentserver-example/ruby/app/format/format.rb @@ -146,7 +146,6 @@ class FormatManager end end - sig { returns(Pathname) } private def file directory.join('onlyoffice-docs-formats.json') diff --git a/web/documentserver-example/ruby/app/proxy/proxy.rb b/web/documentserver-example/ruby/app/proxy/proxy.rb index 1ddb1d1b..45f3fca6 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy.rb @@ -37,7 +37,6 @@ class ProxyManager redirect_public_url(uri) end - sig { params(uri: URI::Generic).returns(T::Boolean) } private def refer_public_url(uri) public_uri = @config_manager.document_server_public_uri From e0ed22d1f58e7ccf414c907e473bc8dc3ae86c54 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:52:31 +0300 Subject: [PATCH 140/176] ruby: Layout/FirstArgumentIndentation correct --- .../ruby/app/controllers/home_controller.rb | 16 +++++------ .../ruby/app/models/file_model.rb | 28 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 6b8fb363..5369ecff 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -488,18 +488,18 @@ class HomeController < ApplicationController FileUtils.cp(recovery_file, source_file) render( -json: { - error: nil, - success: true -} + json: { + error: nil, + success: true + } ) rescue StandardError => e response.status = :internal_server_error render( -json: { - error: e.message, - success: false -} + json: { + error: e.message, + success: false + } ) end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 0400d5dd..abbe058d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -291,20 +291,20 @@ fileName: @file_name, prev = hist_data[(i - 2).to_s] # get the history data from the previous file version # write key and url information about previous file version with optional direct url data( -obj['previous'] = if enable_direct_url? == true - { # write key and url information about previous file version with optional directUrl - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'], - directUrl: prev['directUrl'] - } - else - { - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'] - } - end + obj['previous'] = if enable_direct_url? == true + { # write key and url information about previous file version with optional directUrl + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'], + directUrl: prev['directUrl'] + } + else + { + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'] + } + end ) # write the path to the diff.zip archive with differences in this file version From 4ea23d16778ed97b96f757fc3738b983b078968e Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:54:00 +0300 Subject: [PATCH 141/176] ruby: Style/Lambda correct --- web/documentserver-example/ruby/Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 01162d9a..26eb9a68 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -29,7 +29,7 @@ gem 'webrick', '~> 1.8' # # https://github.com/sorbet/sorbet/issues/4011 # https://github.com/sorbet/sorbet/issues/4119 -install_if -> { RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /x86_64/ } do +install_if lambda { RUBY_PLATFORM =~ /darwin/ || RUBY_PLATFORM =~ /x86_64/ } do gem 'sorbet', '~> 0.5.10871', group: :development gem 'tapioca', '~> 0.11.6', group: :development end From 10b40423ad5e8cd3ecf49ea1c9cc106abdb6e690 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:54:30 +0300 Subject: [PATCH 142/176] ruby: Layout/CommentIndentation correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 5369ecff..f7fdc4f6 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -239,10 +239,10 @@ class HomeController < ApplicationController storage_path = DocumentHelper.storage_path(file_name, nil) hist_dir = DocumentHelper.history_dir(storage_path) - # if the file exists + # if the file exists FileUtils.rm_f(storage_path) # delete it from the storage path - # if the history directory of this file exists + # if the history directory of this file exists FileUtils.rm_rf(hist_dir) # delete it render(plain: '{"success":true}') # report that the operation is successful From a69f7f343ac497eb4277cd39dbd30a33e73a3229 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:54:56 +0300 Subject: [PATCH 143/176] ruby: Layout/HashAlignment correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- web/documentserver-example/ruby/app/models/users.rb | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index f7fdc4f6..45e07a53 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -490,7 +490,7 @@ class HomeController < ApplicationController render( json: { error: nil, - success: true + success: true } ) rescue StandardError => e @@ -498,7 +498,7 @@ class HomeController < ApplicationController render( json: { error: e.message, - success: false + success: false } ) end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index abbe058d..32e7d856 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -158,7 +158,7 @@ class FileModel fileKey: unless @user.id.eql?('uid-0') { fileName: @file_name, - userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json +userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json end } }, diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 8a160e8b..4878c113 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -132,8 +132,8 @@ class Users ['group-2', ''], { view: '', - edit: ['group-2', ''], - remove: ['group-2'] + edit: ['group-2', ''], + remove: ['group-2'] }, ['group-2', ''], true, @@ -150,8 +150,8 @@ class Users ['group-2'], { view: ['group-3', 'group-2'], - edit: ['group-2'], - remove: [] + edit: ['group-2'], + remove: [] }, ['group-2'], false, From d744bc2e2397e5bc0e7890384e4300851a5cca4f Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:55:19 +0300 Subject: [PATCH 144/176] ruby: Layout/ClosingParenthesisIndentation correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 45e07a53..b9d5629e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -492,7 +492,7 @@ class HomeController < ApplicationController error: nil, success: true } -) + ) rescue StandardError => e response.status = :internal_server_error render( @@ -500,6 +500,6 @@ class HomeController < ApplicationController error: e.message, success: false } -) + ) end end diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 32e7d856..c55f7e38 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -305,7 +305,7 @@ userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json url: prev['url'] } end -) + ) # write the path to the diff.zip archive with differences in this file version data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') From 716d4dc694434ae0f8adf551f65423e6a8e2c155 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:55:58 +0300 Subject: [PATCH 145/176] ruby: Layout/FirstHashElementIndentation correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index c55f7e38..895eeff9 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -157,7 +157,7 @@ class FileModel instanceId: DocumentHelper.get_server_url(false), fileKey: unless @user.id.eql?('uid-0') { -fileName: @file_name, + fileName: @file_name, userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json end } From 7197a216f8a95c30df9cea837e645d44229664fa Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:56:29 +0300 Subject: [PATCH 146/176] ruby: Layout/ParameterAlignment correct --- .../ruby/app/models/users.rb | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 4878c113..116e5d44 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -32,17 +32,17 @@ class User attr_accessor :avatar def initialize(id, -name, -email, -group, -review_groups, -comment_groups, -user_info_groups, -favorite, + name, + email, + group, + review_groups, + comment_groups, + user_info_groups, + favorite, denied_permissions, -descriptions, -templates, -avatar) + descriptions, + templates, + avatar) @id = id @name = name @email = email From 0d3ed49adfc0096d7f20cebcceef5f1886439975 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:57:33 +0300 Subject: [PATCH 147/176] ruby: Layout/MultilineOperationIndentation correct --- web/documentserver-example/ruby/app/proxy/proxy.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/proxy/proxy.rb b/web/documentserver-example/ruby/app/proxy/proxy.rb index 45f3fca6..2e1a7a90 100644 --- a/web/documentserver-example/ruby/app/proxy/proxy.rb +++ b/web/documentserver-example/ruby/app/proxy/proxy.rb @@ -41,8 +41,8 @@ class ProxyManager private def refer_public_url(uri) public_uri = @config_manager.document_server_public_uri uri.scheme == public_uri.scheme && - uri.host == public_uri.host && - uri.port == public_uri.port + uri.host == public_uri.host && + uri.port == public_uri.port end sig { params(uri: URI::Generic).returns(URI::Generic) } From 63ec4db0b38c5c28a5eca9fed67163d9906cb10a Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 12:58:23 +0300 Subject: [PATCH 148/176] ruby: Lint/AmbiguousOperatorPrecedence correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 895eeff9..f053b21d 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -101,7 +101,7 @@ class FileModel def config editors_mode = @mode || 'edit' # mode: view/edit/review/comment/fillForms/embedded can_edit = DocumentHelper.edited_exts.include?(file_ext) # check if the document can be edited - if (!can_edit && editors_mode.eql?('edit') || editors_mode.eql?('fillForms')) && + if ((!can_edit && editors_mode.eql?('edit')) || editors_mode.eql?('fillForms')) && DocumentHelper.fill_forms_exts.include?(file_ext) editors_mode = 'fillForms' can_edit = true From 5fd2878c3d9c9771bfbacf95a64dd7eccb39d729 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:00:04 +0300 Subject: [PATCH 149/176] ruby: Layout/FirstHashElementIndentation correct --- web/documentserver-example/ruby/app/models/file_model.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index f053b21d..b4d43282 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -156,9 +156,10 @@ class FileModel referenceData: { instanceId: DocumentHelper.get_server_url(false), fileKey: unless @user.id.eql?('uid-0') - { + { fileName: @file_name, -userAddress: DocumentHelper.cur_user_host_address(nil) }.to_json + userAddress: DocumentHelper.cur_user_host_address(nil) + }.to_json end } }, From 1e66124a8af848beaf65d704f98c6649633a0978 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:01:15 +0300 Subject: [PATCH 150/176] ruby: ElseAlignment correct --- .../ruby/app/models/file_model.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index b4d43282..948185aa 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -299,12 +299,12 @@ class FileModel url: prev['url'], directUrl: prev['directUrl'] } - else - { - fileType: prev['fileType'], - key: prev['key'], - url: prev['url'] - } + else + { + fileType: prev['fileType'], + key: prev['key'], + url: prev['url'] + } end ) From d51dab82c59b10c7b9098939c66b33512456f008 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:01:55 +0300 Subject: [PATCH 151/176] ruby: Layout/EndAlignment correct --- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 948185aa..904390f2 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -305,7 +305,7 @@ class FileModel key: prev['key'], url: prev['url'] } - end + end ) # write the path to the diff.zip archive with differences in this file version From 4c9c79ae8e02e077fc991f7b847c6f068abad5f6 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:02:20 +0300 Subject: [PATCH 152/176] ruby: Layout/EmptyLinesAroundClassBody correct --- web/documentserver-example/ruby/app/models/file_utility.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/file_utility.rb b/web/documentserver-example/ruby/app/models/file_utility.rb index e521aa22..e9e09e6d 100644 --- a/web/documentserver-example/ruby/app/models/file_utility.rb +++ b/web/documentserver-example/ruby/app/models/file_utility.rb @@ -24,7 +24,6 @@ class FileUtility class << self attr_reader :format_manager - end def self.get_file_type(file_name) From e94d81e228eec611e3817f7fbf73ffa52e52e1ee Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:04:00 +0300 Subject: [PATCH 153/176] ruby: Layout/FirstMethodParameterLineBreak correct --- .../ruby/app/models/users.rb | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/users.rb b/web/documentserver-example/ruby/app/models/users.rb index 116e5d44..56015378 100644 --- a/web/documentserver-example/ruby/app/models/users.rb +++ b/web/documentserver-example/ruby/app/models/users.rb @@ -31,18 +31,20 @@ class User attr_accessor :templates attr_accessor :avatar - def initialize(id, - name, - email, - group, - review_groups, - comment_groups, - user_info_groups, - favorite, - denied_permissions, - descriptions, - templates, - avatar) + def initialize( + id, + name, + email, + group, + review_groups, + comment_groups, + user_info_groups, + favorite, + denied_permissions, + descriptions, + templates, + avatar + ) @id = id @name = name @email = email From 0c2a2713576cb8efa5b23bfdbf7a495c899cb97f Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:11:01 +0300 Subject: [PATCH 154/176] ruby: added rubocop configuration file --- web/documentserver-example/ruby/.rubocop.yml | 161 +++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 web/documentserver-example/ruby/.rubocop.yml diff --git a/web/documentserver-example/ruby/.rubocop.yml b/web/documentserver-example/ruby/.rubocop.yml new file mode 100644 index 00000000..f2e7b4c9 --- /dev/null +++ b/web/documentserver-example/ruby/.rubocop.yml @@ -0,0 +1,161 @@ +AllCops: + NewCops: enable + +# Bundler + +Bundler/GemVersion: + Enabled: true + EnforcedStyle: required + +# Layout + +Layout/EmptyComment: + Enabled: true + AllowBorderComment: false + AllowMarginComment: true + +Layout/EmptyLineAfterGuardClause: + Enabled: false + +Layout/EndOfLine: + Enabled: true + EnforcedStyle: lf + +Layout/FirstArrayElementLineBreak: + Enabled: true + AllowMultilineFinalElement: false + +Layout/FirstHashElementLineBreak: + Enabled: true + AllowMultilineFinalElement: false + +Layout/FirstMethodArgumentLineBreak: + Enabled: true + AllowMultilineFinalElement: false + +Layout/FirstMethodParameterLineBreak: + Enabled: true + AllowMultilineFinalElement: false + +Layout/LineLength: + Enabled: true + Max: 120 + +Layout/MultilineArrayLineBreaks: + Enabled: true + AllowMultilineFinalElement: false + +Layout/MultilineAssignmentLayout: + Enabled: true + EnforcedStyle: new_line + SupportedTypes: [] + +Layout/MultilineHashKeyLineBreaks: + Enabled: true + AllowMultilineFinalElement: false + +Layout/MultilineMethodArgumentLineBreaks: + Enabled: true + AllowMultilineFinalElement: false + +Layout/MultilineMethodParameterLineBreaks: + Enabled: true + AllowMultilineFinalElement: false + +Layout/SingleLineBlockChain: + Enabled: true + +# Lint + +Lint/NumberConversion: + Enabled: true + +Lint/DuplicateBranch: + Enabled: false + +# Metrics + +Metrics: + Enabled: false + +# Naming + +Naming/InclusiveLanguage: + Enabled: true + +# Style + +Style/AccessModifierDeclarations: + Enabled: true + EnforcedStyle: inline + +Style/AccessorGrouping: + Enabled: true + EnforcedStyle: separated + +Style/ArrayCoercion: + Enabled: true + +Style/ClassAndModuleChildren: + Enabled: true + EnforcedStyle: compact + +Style/ClassMethodsDefinitions: + Enabled: true + +Style/CollectionMethods: + Enabled: true + +Style/DateTime: + Enabled: true + +Style/EndlessMethod: + Enabled: true + EnforcedStyle: disallow + +Style/FrozenStringLiteralComment: + Enabled: true + EnforcedStyle: always + Exclude: + - "Gemfile" + +Style/IfUnlessModifier: + Enabled: false + +Style/Lambda: + Enabled: true + EnforcedStyle: lambda + +Style/MethodCallWithArgsParentheses: + Enabled: true + AllowedMethods: [] + AllowedPatterns: [] + +Style/MethodCalledOnDoEndBlock: + Enabled: true + +Style/MissingElse: + Enabled: true + EnforcedStyle: case + +Style/MultipleComparison: + Enabled: false + +Style/NumberedParameters: + Enabled: true + EnforcedStyle: disallow + +Style/ParenthesesAroundCondition: + Enabled: true + AllowInMultilineConditions: true + +Style/StringHashKeys: + Enabled: true + +Style/SymbolArray: + Enabled: true + EnforcedStyle: brackets + +Style/WordArray: + Enabled: true + EnforcedStyle: brackets From 9389607aaf66bf8cd34db25084b6920b51af450d Mon Sep 17 00:00:00 2001 From: sshakndr Date: Tue, 21 Nov 2023 15:39:31 +0700 Subject: [PATCH 155/176] python: flake8 configuration file --- .github/workflows/lint-python.yml | 3 +-- web/documentserver-example/python/.flake8 | 4 ++++ web/documentserver-example/python/Makefile | 3 +-- 3 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 web/documentserver-example/python/.flake8 diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index 756d0e89..936407a3 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -31,5 +31,4 @@ jobs: - name: Lint Flake8 run: | - flake8 --count --select=E9,F63,F7,F82 --show-source --statistics - flake8 --count --max-complexity=15 --max-line-length=120 --per-file-ignores="__init__.py:F4" --statistics + flake8 --count --show-source --statistics diff --git a/web/documentserver-example/python/.flake8 b/web/documentserver-example/python/.flake8 new file mode 100644 index 00000000..39193f07 --- /dev/null +++ b/web/documentserver-example/python/.flake8 @@ -0,0 +1,4 @@ +[flake8] +max-complexity = 15 +max-line-length = 120 +per-file-ignores = __init__.py:F4 \ No newline at end of file diff --git a/web/documentserver-example/python/Makefile b/web/documentserver-example/python/Makefile index 03a9c75d..21a227f0 100644 --- a/web/documentserver-example/python/Makefile +++ b/web/documentserver-example/python/Makefile @@ -47,8 +47,7 @@ compose-prod: # Up containers in a production environment. .PHONY: lint lint: # Lint the source code for style and check for types. - @flake8 - @mypy . + @flake8 --count --show-source --statistics .PHONY: test test: # Recursively run the tests. From 6578d414eaa888770c600913155a2f9c3043df4d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 7 Nov 2023 08:40:12 +0300 Subject: [PATCH 156/176] php: fix opening history without changes --- web/documentserver-example/php/src/functions.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/php/src/functions.php b/web/documentserver-example/php/src/functions.php index 25912d68..43e21ad9 100644 --- a/web/documentserver-example/php/src/functions.php +++ b/web/documentserver-example/php/src/functions.php @@ -950,8 +950,11 @@ function getHistory($filename, $filetype, $docKey, $fileuri, $isEnableDirectUrl) "url" => $prev["url"], ]; - // write the path to the diff.zip archive with differences in this file version - $dataObj["changesUrl"] = getHistoryDownloadUrl($filename, $i - 1, "diff.zip"); + $diffPath = implode(DIRECTORY_SEPARATOR, [$histDir, ($i - 1), "diff.zip"]); + if (file_exists($diffPath)) { + // write the path to the diff.zip archive with differences in this file version + $dataObj["changesUrl"] = getHistoryDownloadUrl($filename, $i - 1, "diff.zip"); + } } $jwtManager = new JwtManager(); From ad4b2d136c83a53f3bd3ebe070568e78aa2cebe0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 7 Nov 2023 09:26:35 +0300 Subject: [PATCH 157/176] java-spring: fix opening history without changes --- .../history/DefaultHistoryManager.java | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/DefaultHistoryManager.java b/web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/DefaultHistoryManager.java index f640fc8d..2052ae05 100644 --- a/web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/DefaultHistoryManager.java +++ b/web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/DefaultHistoryManager.java @@ -40,6 +40,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Scanner; +import java.nio.file.Paths; // todo: Rebuild completely @Component @@ -280,8 +281,9 @@ public class DefaultHistoryManager implements HistoryManager { dataObj.put("version", i); if (i > 1) { //check if the version number is greater than 1 + Integer verdiff = i - 1; // get the history data from the previous file version - Map prev = (Map) histData.get(Integer.toString(i - 1)); + Map prev = (Map) histData.get(Integer.toString(verdiff)); Map prevInfo = new HashMap(); prevInfo.put("fileType", prev.get("fileType")); prevInfo.put("key", prev.get("key")); // write key and URL information about previous file version @@ -292,10 +294,12 @@ public class DefaultHistoryManager implements HistoryManager { // write information about previous file version to the data object dataObj.put("previous", prevInfo); - // write the path to the diff.zip archive with differences in this file version - Integer verdiff = i - 1; - dataObj.put("changesUrl", documentManager - .getHistoryFileUrl(fileName, verdiff, "diff.zip", true)); + + if (diffExists(histDir, verdiff)) { + // write the path to the diff.zip archive with differences in this file version + dataObj.put("changesUrl", documentManager + .getHistoryFileUrl(fileName, verdiff, "diff.zip", true)); + } } if (jwtManager.tokenEnabled()) { @@ -331,4 +335,11 @@ public class DefaultHistoryManager implements HistoryManager { } return output; } + + // diff.zip existence check + private Boolean diffExists(final String histDir, final Integer verdiff) { + String filePath = Paths.get(histDir, String.valueOf(verdiff), "diff.zip").toString(); + File file = new File(filePath); + return file.exists(); + } } From b903bfc0cb233dabaf63483c5eca693ca98b8a3d Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 7 Nov 2023 11:02:41 +0300 Subject: [PATCH 158/176] java: fix opening history without changes --- .../main/java/controllers/IndexServlet.java | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/web/documentserver-example/java/src/main/java/controllers/IndexServlet.java b/web/documentserver-example/java/src/main/java/controllers/IndexServlet.java index 970db304..ef4b4a24 100755 --- a/web/documentserver-example/java/src/main/java/controllers/IndexServlet.java +++ b/web/documentserver-example/java/src/main/java/controllers/IndexServlet.java @@ -968,9 +968,10 @@ public class IndexServlet extends HttpServlet { dataObj.put("version", i); if (i > 1) { //check if the version number is greater than 1 + Integer verdiff = i - 1; // get the history data from the previous file version - Map prev = (Map) histData.get(Integer.toString(i - 1)); + Map prev = (Map) histData.get(Integer.toString(verdiff)); Map prevInfo = new HashMap(); prevInfo.put("fileType", prev.get("fileType")); @@ -983,12 +984,16 @@ public class IndexServlet extends HttpServlet { // write information about previous file version to the data object dataObj.put("previous", prevInfo); - // write the path to the diff.zip archive with differences in this file version - Integer verdiff = i - 1; - String changesUrl = DocumentManager - .getDownloadHistoryUrl(fileName, verdiff, - "diff.zip", true); - dataObj.put("changesUrl", changesUrl); + + String diffPath = Paths.get(histDir, String.valueOf(verdiff), "diff.zip").toString(); + File diffFile = new File(diffPath); + if (diffFile.exists()) { + // write the path to the diff.zip archive with differences in this file version + String changesUrl = DocumentManager + .getDownloadHistoryUrl(fileName, verdiff, + "diff.zip", true); + dataObj.put("changesUrl", changesUrl); + } } if (DocumentManager.tokenEnabled()) { From 0b5b0d9c270545ebf4fe440097d7e6d01b6a1381 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 7 Nov 2023 13:39:37 +0300 Subject: [PATCH 159/176] python: fix opening history without changes --- .../python/src/utils/historyManager.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/python/src/utils/historyManager.py b/web/documentserver-example/python/src/utils/historyManager.py index a4838c19..9fb239e8 100644 --- a/web/documentserver-example/python/src/utils/historyManager.py +++ b/web/documentserver-example/python/src/utils/historyManager.py @@ -214,8 +214,11 @@ def getHistoryObject(storagePath, filename, docKey, docUrl, isEnableDirectUrl, r 'url': prev['url'] } dataObj['previous'] = prevInfo # write information about previous file version to the data object - # write the path to the diff.zip archive with differences in this file version - dataObj['changesUrl'] = getPublicHistUri(filename, i - 1, "diff.zip", req) + + diffPath = os.path.sep.join([histDir, str(i - 1), "diff.zip"]) + if (os.path.exists(diffPath)): + # write the path to the diff.zip archive with differences in this file version + dataObj['changesUrl'] = getPublicHistUri(filename, i - 1, "diff.zip", req) if jwtManager.isEnabled(): dataObj['token'] = jwtManager.encode(dataObj) From 160c0bef3c5521e82f78c44182d3ab8711ad8fb5 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Tue, 7 Nov 2023 22:30:33 +0300 Subject: [PATCH 160/176] ruby: fix opening history without changes --- web/documentserver-example/ruby/app/models/file_model.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 7c1129ae..dd3cd0d2 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -266,8 +266,11 @@ class FileModel :url => prev["url"] } - # write the path to the diff.zip archive with differences in this file version - dataObj["changesUrl"] = DocumentHelper.get_historypath_uri(file_name, i - 1, "diff.zip") + diff_path = [hist_dir, (i - 1).to_s, "diff.zip"].join(File::SEPARATOR) + if File.exist?(diff_path) + # write the path to the diff.zip archive with differences in this file version + dataObj["changesUrl"] = DocumentHelper.get_historypath_uri(file_name, i - 1, "diff.zip") + end end if JwtHelper.is_enabled # check if a secret key to generate token exists or not From 8fd9113c47e5a3cf0433127a6368fbd97d7cad5c Mon Sep 17 00:00:00 2001 From: sshakndr Date: Mon, 27 Nov 2023 15:36:56 +0700 Subject: [PATCH 161/176] python: mypy in lint workflow --- .github/workflows/lint-python.yml | 4 +++- web/documentserver-example/python/Makefile | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index 936407a3..b69c874c 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -27,8 +27,10 @@ jobs: run: | python -m pip install --upgrade pip pip install flake8 + pip install mypy + pip install django-stubs if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Lint Flake8 run: | - flake8 --count --show-source --statistics + make lint diff --git a/web/documentserver-example/python/Makefile b/web/documentserver-example/python/Makefile index 21a227f0..a0d9b132 100644 --- a/web/documentserver-example/python/Makefile +++ b/web/documentserver-example/python/Makefile @@ -48,6 +48,7 @@ compose-prod: # Up containers in a production environment. .PHONY: lint lint: # Lint the source code for style and check for types. @flake8 --count --show-source --statistics + @mypy . .PHONY: test test: # Recursively run the tests. From 969240ad53d62281ac99d05bddf66f54ccc846fb Mon Sep 17 00:00:00 2001 From: sshakndr Date: Mon, 27 Nov 2023 17:30:09 +0700 Subject: [PATCH 162/176] python: intalling dependencies by make in lint workflow --- .github/workflows/lint-python.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index b69c874c..d4b959c8 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -26,10 +26,8 @@ jobs: - name: Install Dependencies run: | python -m pip install --upgrade pip - pip install flake8 - pip install mypy - pip install django-stubs - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + make prod + make dev - name: Lint Flake8 run: | From d397db61cd1f5332bb35cd3fe07d5e949dc4766e Mon Sep 17 00:00:00 2001 From: sshakndr Date: Mon, 27 Nov 2023 17:36:21 +0700 Subject: [PATCH 163/176] python: lint workflow python version fix --- .github/workflows/lint-python.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index d4b959c8..b19cf30c 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -21,7 +21,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4 with: - python-version: '3.10' + python-version: '3.11' - name: Install Dependencies run: | From 9d5feaaf99d511ac30762b4e0029f3d9f1283c4c Mon Sep 17 00:00:00 2001 From: sshakndr Date: Tue, 28 Nov 2023 13:49:12 +0700 Subject: [PATCH 164/176] python: flake8 and mypy separated --- .github/workflows/lint-python.yml | 5 +++++ web/documentserver-example/python/Makefile | 5 ++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index b19cf30c..13d9458a 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -32,3 +32,8 @@ jobs: - name: Lint Flake8 run: | make lint + + # TODO: Configure mypy + # - name: Types mypy + # run: | + # make types diff --git a/web/documentserver-example/python/Makefile b/web/documentserver-example/python/Makefile index a0d9b132..a4cc7a26 100644 --- a/web/documentserver-example/python/Makefile +++ b/web/documentserver-example/python/Makefile @@ -46,8 +46,11 @@ compose-prod: # Up containers in a production environment. up --detach .PHONY: lint -lint: # Lint the source code for style and check for types. +lint: # Lint the source code for style. @flake8 --count --show-source --statistics + +.PHONY: types +types: # Check the source code for types. @mypy . .PHONY: test From d40f932863e4f807ff9f5e36fbd8322a1aa04cc5 Mon Sep 17 00:00:00 2001 From: sshakndr Date: Wed, 29 Nov 2023 10:11:43 +0700 Subject: [PATCH 165/176] python: deleted unnecessary lines from workflows --- .github/workflows/lint-python.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/lint-python.yml b/.github/workflows/lint-python.yml index 13d9458a..4eb8d860 100644 --- a/.github/workflows/lint-python.yml +++ b/.github/workflows/lint-python.yml @@ -25,8 +25,6 @@ jobs: - name: Install Dependencies run: | - python -m pip install --upgrade pip - make prod make dev - name: Lint Flake8 From 7c1939e8c92fe75ef9ae09cd3b2e4d0022286fd7 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:46:02 +0300 Subject: [PATCH 166/176] ruby: updated rubocop configuration file --- web/documentserver-example/ruby/.rubocop.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/web/documentserver-example/ruby/.rubocop.yml b/web/documentserver-example/ruby/.rubocop.yml index f2e7b4c9..d640f95a 100644 --- a/web/documentserver-example/ruby/.rubocop.yml +++ b/web/documentserver-example/ruby/.rubocop.yml @@ -1,3 +1,5 @@ +require: rubocop-rails + AllCops: NewCops: enable From 037c5682f8bd3266d0fac99b5bc8fc72074708f0 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:47:28 +0300 Subject: [PATCH 167/176] ruby: Rails/Blank correct --- .../ruby/app/controllers/home_controller.rb | 4 ++-- web/documentserver-example/ruby/app/models/track_helper.rb | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index b9d5629e..7e9e9c2d 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -93,7 +93,7 @@ class HomeController < ApplicationController # converting a file def convert file_data = request.body.read - return '' if file_data.nil? || file_data.empty? + return '' if file_data.blank? body = JSON.parse(file_data) @@ -194,7 +194,7 @@ class HomeController < ApplicationController # tracking file changes def track file_data = TrackHelper.read_body(request) # read the request body - if file_data.nil? || file_data.empty? + if file_data.blank? render(plain: '{"error":1}') # an error occurs if the file is empty return end diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 220d7907..1d4bd38e 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -37,7 +37,7 @@ class TrackHelper def self.read_body(request) body = request.body.read - return '' if body.nil? || body.empty? + return '' if body.blank? file_data = JSON.parse(body) # parse file data @@ -117,7 +117,7 @@ class TrackHelper false, nil ) # get the url of the converted file - if new_file_uri.nil? || new_file_uri.empty? + if new_file_uri.blank? new_file_name = DocumentHelper.get_correct_name( File.basename(file_name, cur_ext) + download_ext, user_address @@ -205,7 +205,7 @@ class TrackHelper false, nil ) # get the url of the converted file - if new_file_uri.nil? || new_file_uri.empty? + if new_file_uri.blank? new_file_name = true else download_uri = new_file_uri From efb4616ca6e53b447c5e8fe96fca1bbaca7e4ab4 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:49:10 +0300 Subject: [PATCH 168/176] ruby: Rails/HttpStatus correct --- .../ruby/app/controllers/home_controller.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 7e9e9c2d..10f5a84e 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -168,11 +168,11 @@ class HomeController < ApplicationController hdr.slice!(0, 'Bearer '.length) token = JwtHelper.decode(hdr) if !token || token.eql?('') - render(plain: 'JWT validation failed', status: 403) + render(plain: 'JWT validation failed', status: :forbidden) return end else - render(plain: 'JWT validation failed', status: 403) + render(plain: 'JWT validation failed', status: :forbidden) return end end @@ -283,7 +283,7 @@ class HomeController < ApplicationController token = JwtHelper.decode(hdr) end if !token || token.eql?('') - render(plain: 'JWT validation failed', status: 403) + render(plain: 'JWT validation failed', status: :forbidden) return end end From 3d0ae07de4c31c2e23eef21708d8a8f5fcbe074b Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:49:39 +0300 Subject: [PATCH 169/176] ruby: Rails/TimeZone correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- web/documentserver-example/ruby/app/models/file_model.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 10f5a84e..d9bd5a88 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -472,7 +472,7 @@ class HomeController < ApplicationController serverVersion: nil, changes: [ { - created: Time.now.to_formatted_s(:db), + created: Time.zone.now.to_formatted_s(:db), user: { id: user.id, name: user.name diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 7f7311e6..0ffd082c 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -182,7 +182,7 @@ class DocumentHelper # write user name, user uid and the creation time to the json object json = { - created: Time.now.to_formatted_s(:db), + created: Time.zone.now.to_formatted_s(:db), uid:, uname: } diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 904390f2..eea69a11 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -134,7 +134,7 @@ class FileModel key:, info: { owner: 'Me', - uploaded: Time.now.to_s, + uploaded: Time.zone.now.to_s, favorite: @user.favorite }, permissions: { # the permission for the document to be edited and downloaded or not From b262a34540c3c71c78d18c7501bf96181d090f33 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:50:22 +0300 Subject: [PATCH 170/176] ruby: Rails/ToFormattedS correct --- .../ruby/app/controllers/home_controller.rb | 2 +- web/documentserver-example/ruby/app/models/document_helper.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index d9bd5a88..88208f22 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -472,7 +472,7 @@ class HomeController < ApplicationController serverVersion: nil, changes: [ { - created: Time.zone.now.to_formatted_s(:db), + created: Time.zone.now.to_fs(:db), user: { id: user.id, name: user.name diff --git a/web/documentserver-example/ruby/app/models/document_helper.rb b/web/documentserver-example/ruby/app/models/document_helper.rb index 0ffd082c..f1bde213 100755 --- a/web/documentserver-example/ruby/app/models/document_helper.rb +++ b/web/documentserver-example/ruby/app/models/document_helper.rb @@ -182,7 +182,7 @@ class DocumentHelper # write user name, user uid and the creation time to the json object json = { - created: Time.zone.now.to_formatted_s(:db), + created: Time.zone.now.to_fs(:db), uid:, uname: } From d894663a4a88af447d4105443090423bb144aeee Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:50:44 +0300 Subject: [PATCH 171/176] ruby: Rails/NegateInclude correct --- .../ruby/app/models/file_model.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index eea69a11..a8631b15 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -138,12 +138,12 @@ class FileModel favorite: @user.favorite }, permissions: { # the permission for the document to be edited and downloaded or not - comment: !['view', 'fillForms', 'embedded', 'blockcontent'].include?(editors_mode), - copy: !@user.denied_permissions.include?('copy'), - download: !@user.denied_permissions.include?('download'), + comment: ['view', 'fillForms', 'embedded', 'blockcontent'].exclude?(editors_mode), + copy: @user.denied_permissions.exclude?('copy'), + download: @user.denied_permissions.exclude?('download'), edit: can_edit && ['edit', 'view', 'filter', 'blockcontent'].include?(editors_mode), - print: !@user.denied_permissions.include?('print'), - fillForms: !['view', 'comment', 'embedded', 'blockcontent'].include?(editors_mode), + print: @user.denied_permissions.exclude?('print'), + fillForms: ['view', 'comment', 'embedded', 'blockcontent'].exclude?(editors_mode), modifyFilter: !editors_mode.eql?('filter'), modifyContentControl: !editors_mode.eql?('blockcontent'), review: can_edit && (editors_mode.eql?('edit') || editors_mode.eql?('review')), @@ -151,7 +151,7 @@ class FileModel reviewGroups: @user.review_groups, commentGroups: @user.comment_groups, userInfoGroups: @user.user_info_groups, - protect: !@user.denied_permissions.include?('protect') + protect: @user.denied_permissions.exclude?('protect') }, referenceData: { instanceId: DocumentHelper.get_server_url(false), From e5560b25d78ad336ea433b11630aad8435a23294 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Mon, 20 Nov 2023 13:52:09 +0300 Subject: [PATCH 172/176] ruby: Rails/Present correct --- web/documentserver-example/ruby/app/models/jwt_helper.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/ruby/app/models/jwt_helper.rb b/web/documentserver-example/ruby/app/models/jwt_helper.rb index 92c58017..44293d6a 100644 --- a/web/documentserver-example/ruby/app/models/jwt_helper.rb +++ b/web/documentserver-example/ruby/app/models/jwt_helper.rb @@ -26,7 +26,7 @@ class JwtHelper # check if a secret key to generate token exists or not def self.enabled? - @jwt_secret && !@jwt_secret.empty? ? true : false + @jwt_secret.present? end # check if a secret key used for request From af1dc6d9b5fe670bd5ac7f32e761a4261469ff66 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 30 Nov 2023 09:28:05 +0300 Subject: [PATCH 173/176] ruby: add rubocop-rails --- web/documentserver-example/ruby/Gemfile | 1 + 1 file changed, 1 insertion(+) diff --git a/web/documentserver-example/ruby/Gemfile b/web/documentserver-example/ruby/Gemfile index 26eb9a68..1f2da09b 100644 --- a/web/documentserver-example/ruby/Gemfile +++ b/web/documentserver-example/ruby/Gemfile @@ -12,6 +12,7 @@ gem 'mimemagic', github: 'mimemagicrb/mimemagic', ref: '01f92d86d15d85cfd0f20dab gem 'rack-cors', '~> 2.0' gem 'rails', '~> 7.0.8' gem 'rubocop', '~> 1.52', group: :development +gem 'rubocop-rails', '~> 2.20', group: :development gem 'sass-rails', '~> 6.0' gem 'sdoc', '~> 2.6', group: :doc gem 'sorbet-runtime', '~> 0.5.10871' From 9cf058078c3654c6d24cddc7dcce1998788114a9 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 30 Nov 2023 14:05:57 +0300 Subject: [PATCH 174/176] ruby: fix lint problems after merging develop --- .../ruby/app/controllers/home_controller.rb | 46 +++++++------- .../ruby/app/models/file_model.rb | 18 +++++- .../ruby/app/models/track_helper.rb | 62 +++++++------------ 3 files changed, 61 insertions(+), 65 deletions(-) diff --git a/web/documentserver-example/ruby/app/controllers/home_controller.rb b/web/documentserver-example/ruby/app/controllers/home_controller.rb index 94c209e4..23b6cbe9 100755 --- a/web/documentserver-example/ruby/app/controllers/home_controller.rb +++ b/web/documentserver-example/ruby/app/controllers/home_controller.rb @@ -154,27 +154,25 @@ class HomeController < ApplicationController end def historyobj - begin - data = request.body.read - if data == nil || data.empty? - return "" - end - file_data = JSON.parse(data) - file = FileModel.new( - file_name: File.basename(file_data['file_name']), - mode: file_data['mode'], - type: file_data['type'], - user_ip: file_data['user_ip'], - lang: file_data['lang'], - user: file_data['user'], - action_data: file_data['action_data'], - direct_url: file_data['direct_url'] - ) - history = file.get_history - render json: history - rescue - render json: '{ "error": "File not found"}' + data = request.body.read + if data.blank? + return '' end + file_data = JSON.parse(data) + file = FileModel.new( + file_name: File.basename(file_data['file_name']), + mode: file_data['mode'], + type: file_data['type'], + user_ip: file_data['user_ip'], + lang: file_data['lang'], + user: file_data['user'], + action_data: file_data['action_data'], + direct_url: file_data['direct_url'] + ) + history = file.get_history + render(json: history) + rescue StandardError + render(json: '{ "error": "File not found"}') end # downloading a history file from public @@ -223,7 +221,7 @@ class HomeController < ApplicationController return end - status = Integer(file_data['status'], 10) + status = file_data['status'] user_address = params[:userAddress] file_name = File.basename(params[:fileName]) @@ -300,11 +298,11 @@ class HomeController < ApplicationController response.headers['Content-Length'] = File.size(asset_path).to_s response.headers['Content-Type'] = MimeMagic.by_path(asset_path).type - response.headers['Content-Disposition'] = "attachment;filename*=UTF-8\'\'" + ERB::Util.url_encode(file_name) + response.headers['Content-Disposition'] = "attachment;filename*=UTF-8''#{ERB::Util.url_encode(file_name)}" - send_file asset_path, :x_sendfile => true + send_file(asset_path, x_sendfile: true) end - + # downloading a file def download file_name = File.basename(params[:fileName]) diff --git a/web/documentserver-example/ruby/app/models/file_model.rb b/web/documentserver-example/ruby/app/models/file_model.rb index 3dcb4224..2ec252b6 100755 --- a/web/documentserver-example/ruby/app/models/file_model.rb +++ b/web/documentserver-example/ruby/app/models/file_model.rb @@ -216,7 +216,7 @@ class FileModel file_name = @file_name file_ext = File.extname(file_name).downcase doc_key = key - doc_uri = file_uri + file_uri # get the path to the file history hist_dir = DocumentHelper.history_dir(DocumentHelper.storage_path(@file_name, nil)) @@ -258,7 +258,19 @@ class FileModel # get the history data from the previous file version and write key and url information about it data_obj['fileType'] = file_ext[1..file_ext.length] data_obj['key'] = cur_key - data_obj['url'] = i == cur_ver ? DocumentHelper.get_download_url(file_name, true) : DocumentHelper.get_historypath_uri(file_name, i, "prev#{file_ext}") + data_obj['url'] = + if i == cur_ver + DocumentHelper.get_download_url( + file_name, + true + ) + else + DocumentHelper.get_historypath_uri( + file_name, + i, + "prev#{file_ext}" + ) + end if enable_direct_url? == true data_obj['directUrl'] = if i == cur_ver @@ -308,7 +320,7 @@ class FileModel end ) - diff_path = [hist_dir, (i - 1).to_s, "diff.zip"].join(File::SEPARATOR) + diff_path = [hist_dir, (i - 1).to_s, 'diff.zip'].join(File::SEPARATOR) if File.exist?(diff_path) # write the path to the diff.zip archive with differences in this file version data_obj['changesUrl'] = DocumentHelper.get_historypath_uri(file_name, i - 1, 'diff.zip') diff --git a/web/documentserver-example/ruby/app/models/track_helper.rb b/web/documentserver-example/ruby/app/models/track_helper.rb index 1bbb59d3..b55c4468 100755 --- a/web/documentserver-example/ruby/app/models/track_helper.rb +++ b/web/documentserver-example/ruby/app/models/track_helper.rb @@ -236,44 +236,13 @@ class TrackHelper user_address ) end - forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file - else - if new_file_name - file_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + download_ext, user_address) - end - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) - if forcesave_path.eql?("") - forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, true) # if the path to the new file doesn't exist, create it - end - end - - save_file(data, forcesave_path) # save the downloaded file to the storage directory - - if is_submit_form - uid = file_data['actions'][0]['userid'] - DocumentHelper.create_meta(file_name, uid, "Filling Form", user_address) # create file meta information with the Filling form tag instead of user name - - forms_data_url = file_data["formsdataurl"].to_s - - if forms_data_url && !forms_data_url.eql?("") - forms_name = DocumentHelper.get_correct_name(File.basename(file_name, cur_ext) + ".txt", user_address) - forms_path = DocumentHelper.storage_path(forms_name, user_address) - forms = download_file(forms_data_url) - if forms.eql?(nil) - return saved - end - save_file(forms, forms_path) - else - raise 'Document editing service did not return formsDataUrl' - end - end - - saved = 0 - rescue StandardError => msg - saved = 1 - end - - saved + forcesave_path = DocumentHelper.storage_path(file_name, user_address) # get the path to the new file + else + if new_file_name + file_name = DocumentHelper.get_correct_name( + File.basename(file_name, cur_ext) + download_ext, + user_address + ) end forcesave_path = DocumentHelper.forcesave_path(file_name, user_address, false) if forcesave_path.eql?('') @@ -288,6 +257,23 @@ class TrackHelper uid = file_data['actions'][0]['userid'] # create file meta information with the Filling form tag instead of user name DocumentHelper.create_meta(file_name, uid, 'Filling Form', user_address) + + forms_data_url = file_data['formsdataurl'].to_s + + unless forms_data_url && !forms_data_url.eql?('') + raise('Document editing service did not return formsDataUrl') + end + forms_name = DocumentHelper.get_correct_name( + "#{File.basename(file_name, cur_ext)}.txt", + user_address + ) + forms_path = DocumentHelper.storage_path(forms_name, user_address) + forms = download_file(forms_data_url) + if forms.eql?(nil) + return saved + end + save_file(forms, forms_path) + end saved = 0 From 83b1dc07e1d4ae9f2e53a2d072ef8be083b936f2 Mon Sep 17 00:00:00 2001 From: ZEROM22 Date: Thu, 30 Nov 2023 18:19:38 +0300 Subject: [PATCH 175/176] =?UTF-8?q?node:=20fixed=20overflow=20when=20hashi?= =?UTF-8?q?ng=20=D1=81yrillic=20characters?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- web/documentserver-example/nodejs/app.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/documentserver-example/nodejs/app.js b/web/documentserver-example/nodejs/app.js index 05793760..38810d33 100755 --- a/web/documentserver-example/nodejs/app.js +++ b/web/documentserver-example/nodejs/app.js @@ -55,7 +55,7 @@ String.prototype.hashCode = function hashCode() { const len = this.length; let ret = 0; for (let i = 0; i < len; i++) { - ret = Math.trunc(31 * ret + this.charCodeAt(i)); + ret = Math.imul(ret, 31) + this.charCodeAt(i); } return ret; }; From 7d8a1a8b6d70ed7ab0b245e46c6297e238219d3f Mon Sep 17 00:00:00 2001 From: Sergey Linnik Date: Fri, 1 Dec 2023 18:07:41 +0300 Subject: [PATCH 176/176] sr-Latn-CS skin language --- CHANGELOG.md | 1 + web/documentserver-example/csharp-mvc/web.appsettings.config | 2 +- web/documentserver-example/csharp/settings.config | 2 +- .../java-spring/src/main/resources/application.properties | 2 +- .../java/src/main/resources/settings.properties | 2 +- web/documentserver-example/nodejs/config/default.json | 1 + .../php/src/configuration/ConfigurationManager.php | 1 + .../python/src/configuration/configuration.py | 1 + .../ruby/app/configuration/configuration.rb | 1 + 9 files changed, 9 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b648c40..4095bbd8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ # Change Log +- sr-Latn-CS skin languages - getting history via api - using a repo with a list of formats - convert after uploading only tagged formats diff --git a/web/documentserver-example/csharp-mvc/web.appsettings.config b/web/documentserver-example/csharp-mvc/web.appsettings.config index 51630ee6..2a6a645c 100644 --- a/web/documentserver-example/csharp-mvc/web.appsettings.config +++ b/web/documentserver-example/csharp-mvc/web.appsettings.config @@ -15,7 +15,7 @@ - + diff --git a/web/documentserver-example/csharp/settings.config b/web/documentserver-example/csharp/settings.config index 8715147e..d6dc3238 100644 --- a/web/documentserver-example/csharp/settings.config +++ b/web/documentserver-example/csharp/settings.config @@ -14,7 +14,7 @@ - + diff --git a/web/documentserver-example/java-spring/src/main/resources/application.properties b/web/documentserver-example/java-spring/src/main/resources/application.properties index 2fefdaf8..b5e420d1 100755 --- a/web/documentserver-example/java-spring/src/main/resources/application.properties +++ b/web/documentserver-example/java-spring/src/main/resources/application.properties @@ -25,7 +25,7 @@ files.docservice.token-use-for-request=true files.docservice.verify-peer-off=true -files.docservice.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 +files.docservice.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|sr-Latn-CS:Serbian|si:Sinhala (Sri Lanka)|sk:Slovak|sl:Slovenian|es:Spanish|sv:Swedish|tr:Turkish|uk:Ukrainian|vi:Vietnamese|aa-AA:Test Language spring.datasource.url=jdbc:h2:mem:usersdb spring.datasource.driverClassName=org.h2.Driver diff --git a/web/documentserver-example/java/src/main/resources/settings.properties b/web/documentserver-example/java/src/main/resources/settings.properties index 98a9daab..d3cdb116 100644 --- a/web/documentserver-example/java/src/main/resources/settings.properties +++ b/web/documentserver-example/java/src/main/resources/settings.properties @@ -13,7 +13,7 @@ files.docservice.url.api=web-apps/apps/api/documents/api.js files.docservice.url.preloader=web-apps/apps/api/documents/cache-scripts.html files.docservice.url.example= -files.docservice.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 +files.docservice.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|sr-Latn-CS:Serbian|si:Sinhala (Sri Lanka)|sk:Slovak|sl:Slovenian|es:Spanish|sv:Swedish|tr:Turkish|uk:Ukrainian|vi:Vietnamese|aa-AA:Test Language files.docservice.secret= files.docservice.header=Authorization diff --git a/web/documentserver-example/nodejs/config/default.json b/web/documentserver-example/nodejs/config/default.json index 2e9fda9e..afff46cc 100644 --- a/web/documentserver-example/nodejs/config/default.json +++ b/web/documentserver-example/nodejs/config/default.json @@ -69,6 +69,7 @@ "pt-PT": "Portuguese (Portugal)", "ro": "Romanian", "ru": "Russian", + "sr-Latn-CS": "Serbian", "si": "Sinhala (Sri Lanka)", "sk": "Slovak", "sl": "Slovenian", diff --git a/web/documentserver-example/php/src/configuration/ConfigurationManager.php b/web/documentserver-example/php/src/configuration/ConfigurationManager.php index 400060f2..2455754f 100644 --- a/web/documentserver-example/php/src/configuration/ConfigurationManager.php +++ b/web/documentserver-example/php/src/configuration/ConfigurationManager.php @@ -189,6 +189,7 @@ class ConfigurationManager 'pt-PT' => 'Portuguese (Portugal)', 'ro' => 'Romanian', 'ru' => 'Russian', + 'sr-Latn-CS' => 'Serbian', 'si' => 'Sinhala (Sri Lanka)', 'sk' => 'Slovak', 'sl' => 'Slovenian', diff --git a/web/documentserver-example/python/src/configuration/configuration.py b/web/documentserver-example/python/src/configuration/configuration.py index 37ee8330..d6b3f490 100644 --- a/web/documentserver-example/python/src/configuration/configuration.py +++ b/web/documentserver-example/python/src/configuration/configuration.py @@ -151,6 +151,7 @@ class ConfigurationManager: 'pt-PT': 'Portuguese (Portugal)', 'ro': 'Romanian', 'ru': 'Russian', + 'sr-Latn-CS': 'Serbian', 'si': 'Sinhala (Sri Lanka)', 'sk': 'Slovak', 'sl': 'Slovenian', diff --git a/web/documentserver-example/ruby/app/configuration/configuration.rb b/web/documentserver-example/ruby/app/configuration/configuration.rb index 308345c7..b1fb619e 100644 --- a/web/documentserver-example/ruby/app/configuration/configuration.rb +++ b/web/documentserver-example/ruby/app/configuration/configuration.rb @@ -172,6 +172,7 @@ class ConfigurationManager 'pt-PT': 'Portuguese (Portugal)', ro: 'Romanian', ru: 'Russian', + sr-Latn-CS: 'Serbian', si: 'Sinhala (Sri Lanka)', sk: 'Slovak', sl: 'Slovenian',