# encoding: utf-8
# frozen_string_literal: true
#
# Redmine plugin for Document Management System "Features"
#
# Copyright © 2012   Daniel Munn <dan.munn@munnster.co.uk>
# Copyright © 2011-20 Karel Pičman <karel.picman@kontron.com>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

require File.expand_path('../../../test_helper', __FILE__)
require 'fileutils'

class DmsfWebdavPutTest < RedmineDmsf::Test::IntegrationTest

  fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles,
    :enabled_modules, :dmsf_folders, :dmsf_files, :dmsf_file_revisions

  def setup
    @dmsf_storage_directory = Setting.plugin_redmine_dmsf['dmsf_storage_directory']
    Setting.plugin_redmine_dmsf['dmsf_storage_directory'] = 'files/dmsf'
    FileUtils.cp_r File.join(File.expand_path('../../../fixtures/files', __FILE__), '.'), DmsfFile.storage_path
    @admin = credentials 'admin'
    @jsmith = credentials 'jsmith'
    @jsmith_user = User.find_by(login: 'jsmith')
    @project1 = Project.find 1
    @project2 = Project.find 2
    @project3 = Project.find 3
    @project3.enable_module! :dmsf
    @role = Role.find_by(name: 'Manager')
    @dmsf_webdav = Setting.plugin_redmine_dmsf['dmsf_webdav']
    Setting.plugin_redmine_dmsf['dmsf_webdav'] = true
    @dmsf_webdav_strategy = Setting.plugin_redmine_dmsf['dmsf_webdav_strategy']
    Setting.plugin_redmine_dmsf['dmsf_webdav_strategy'] = 'WEBDAV_READ_WRITE'
    @dmsf_webdav_use_project_names = Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names']
    Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] = false
  end

  def teardown
    # Delete our tmp folder
    begin
      FileUtils.rm_rf DmsfFile.storage_path
    rescue => e
      error e.message
    end
    Setting.plugin_redmine_dmsf['dmsf_storage_directory'] = @dmsf_storage_directory
    Setting.plugin_redmine_dmsf['dmsf_webdav'] = @dmsf_webdav
    Setting.plugin_redmine_dmsf['dmsf_webdav_strategy'] = @dmsf_webdav_strategy
    Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] = @dmsf_webdav_use_project_names
  end

  def test_truth
    assert_kind_of Project, @project1
    assert_kind_of Project, @project2
    assert_kind_of Project, @project3
    assert_kind_of Role, @role
    assert_kind_of User, @jsmith_user
  end

  def test_put_denied_unless_authenticated_root
    put '/dmsf/webdav'
    assert_response :unauthorized
  end

  def test_put_denied_unless_authenticated
    put "/dmsf/webdav/#{@project1.identifier}"
    assert_response :unauthorized
  end

  def test_put_denied_with_failed_authentication_root
    put '/dmsf/webdav', params: nil, headers: credentials('admin', 'badpassword')
    assert_response :unauthorized
  end

  def test_put_denied_with_failed_authentication
    put "/dmsf/webdav/#{@project1.identifier}", params: nil, headers: credentials('admin', 'badpassword')
    assert_response :unauthorized
  end

  def test_put_denied_at_root_level
    put '/dmsf/webdav/test.txt', params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :not_implemented
  end

  def test_put_denied_on_folder
    put "/dmsf/webdav/#{@project1.identifier}", params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :forbidden
  end

  def test_put_failed_on_non_existant_project
    put '/dmsf/webdav/not_a_project/file.txt', params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :conflict # not_a_project does not exist - file.txt cannot be created
  end

  def test_put_as_admin_granted_on_dmsf_enabled_project
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @admin.merge!({ content_type: :text })
    assert_response :created
    # Lets check for our file
    file = DmsfFile.find_file_by_name @project1, nil, 'test-1234.txt'
    assert file, 'Check for files existance'
    Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] = true
    project1_uri = Addressable::URI.escape(RedmineDmsf::Webdav::ProjectResource.create_project_name(@project1))
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @admin.merge!({ content_type: :text })
    assert_response :conflict
    put "/dmsf/webdav/#{project1_uri}/test-1234.txt", params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :created
  end

  def test_put_failed_as_jsmith_on_non_dmsf_enabled_project
    put "/dmsf/webdav/#{@project2.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :conflict # Should report conflict, as project 2 technically doesn't exist if not enabled
    # Lets check for our file
    file = DmsfFile.find_file_by_name @project2, nil, 'test-1234.txt'
    assert_nil file, 'Check for files existance'
  end

  def test_put_failed_when_no_permission
    @project2.enable_module! :dmsf # Flag module enabled
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :conflict # We don't hold the permission view_dmsf_folders, and thus project 2 doesn't exist
                                  # to us.
  end

  def test_put_failed_when_no_file_manipulation_permission
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :view_dmsf_folders
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :forbidden # We don't hold the permission file_manipulation - so we're unable to do anything
                                   # with files
  end

  def test_put_failed_when_no_view_dmsf_folders_permission
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :file_manipulation
    # Check we don't have write access even if we do have the file_manipulation permission
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :conflict # We don't hold the permission view_dmsf_folders, and thus project 2 doesn't exist
                                  # to us.
    # Lets check for our file
    file = DmsfFile.find_file_by_name @project1, nil, 'test-1234.txt'
    assert_nil file, 'File test-1234 was found in projects dmsf folder.'
  end

  def test_put_succeeds_for_non_admin_with_correct_permissions
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :created # Now we have permissions
    # Lets check for our file
    file = DmsfFile.find_file_by_name @project1, nil, 'test-1234.txt'
    assert file, 'File test-1234 was not found in projects dmsf folder.'
    assert file.last_revision
    assert_equal file.last_revision.digest_type, 'SHA256'
    Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] = true
    project1_uri = Addressable::URI.escape(RedmineDmsf::Webdav::ProjectResource.create_project_name(@project1))
    put "/dmsf/webdav/#{@project1.identifier}/test-1234.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
    assert_response :conflict
    put "/dmsf/webdav/#{project1_uri}/test-1234.txt", params: '1234', headers: @jsmith.merge!({ content_type: :text })
    assert_response :created # Now we have permissions
  end

  def test_put_writes_revision_successfully_for_unlocked_file
    @project1.enable_module! :dmsf #Flag module enabled
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    file = DmsfFile.find_file_by_name @project1, nil, 'test.txt'
    assert_not_nil file, 'test.txt file not found'
    assert_difference 'file.dmsf_file_revisions.count', +1 do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @jsmith.merge!({ content_type: :text })
      assert_response :created
    end
  end

  def test_put_fails_revision_when_file_is_locked
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    log_user 'admin', 'admin' # login as admin
    file = DmsfFile.find_file_by_name @project1, nil, 'test.txt'
    assert file.lock!, "File failed to be locked by #{User.current}"
    assert_no_difference 'file.dmsf_file_revisions.count' do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @jsmith.merge!({ content_type: :text })
      assert_response :locked
    end
  end

  def test_put_fails_revision_when_file_is_locked_and_user_is_administrator
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    log_user 'jsmith', 'jsmith' # login as jsmith
    file = DmsfFile.find_file_by_name @project1, nil, 'test.txt'
    assert file.lock!, "File failed to be locked by #{User.current}"
    assert_no_difference 'file.dmsf_file_revisions.count' do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @admin.merge!({ content_type: :text })
      assert_response :locked
    end
  end

  def test_put_accepts_revision_when_file_is_locked_and_user_is_same_as_lock_holder
    @project1.enable_module! :dmsf # Flag module enabled
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation

    # Lock the file
    User.current = @jsmith_user
    file = DmsfFile.find_file_by_name @project1, nil, 'test.txt'
    l = file.lock!
    assert l, "File failed to be locked by #{User.current}"
    assert_equal file.last_revision.id, l.dmsf_file_last_revision_id

    # First PUT should always create new revision.
    User.current = @jsmith_user
    assert_difference 'file.dmsf_file_revisions.count', +1 do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
        headers: @jsmith.merge!({ content_type: :text })
      assert_response :created
    end

    # Second PUT on a locked file should only update the revision that were created on the first PUT
    User.current = @jsmith_user
    assert_no_difference 'file.dmsf_file_revisions.count' do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @jsmith.merge!({ content_type: :text })
      assert_response :created
    end

    # Unlock
    User.current = @jsmith_user
    assert file.unlock!, "File failed to be unlocked by #{User.current}"

    # Lock file again, but this time delete the revision that were stored in the lock
    User.current = @jsmith_user
    file = DmsfFile.find_file_by_name @project1, nil, 'test.txt'
    l = file.lock!
    assert l, "File failed to be locked by #{User.current}"
    assert_equal file.last_revision.id, l.dmsf_file_last_revision_id

    # Delete the last revision, the revision that were stored in the lock.
    file.last_revision.delete(true)

    # First PUT should always create new revision.
    User.current = @jsmith_user
    assert_difference 'file.dmsf_file_revisions.count', +1 do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @jsmith.merge!({ content_type: :text })
      assert_response :created
    end

    # Second PUT on a locked file should only update the revision that were created on the first PUT
    User.current = @jsmith_user
    assert_no_difference 'file.dmsf_file_revisions.count' do
      put "/dmsf/webdav/#{@project1.identifier}/test.txt", params: '1234',
          headers: @jsmith.merge!({ content_type: :text })
      assert_response :created
    end
  end

  def test_put_ignored_files_default
    # Ignored patterns: /^(\._|\.DS_Store$|Thumbs.db$)/
    @project1.enable_module! :dmsf
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    put "/dmsf/webdav/#{@project1.identifier}/._test.txt", params: '1234',
        headers: @admin.merge!({ content_type: :text })
    assert_response :no_content
    put "/dmsf/webdav/#{@project1.identifier}/.DS_Store", params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :no_content
    put "/dmsf/webdav/#{@project1.identifier}/Thumbs.db", params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :no_content
    original = Setting.plugin_redmine_dmsf['dmsf_webdav_ignore']
    Setting.plugin_redmine_dmsf['dmsf_webdav_ignore'] = '.dump$'
    put "/dmsf/webdav/#{@project1.identifier}/test.dump", params: '1234', headers: @admin.merge!({ content_type: :text })
    assert_response :no_content
    Setting.plugin_redmine_dmsf['dmsf_webdav_ignore'] = original
  end

  def test_put_non_versioned_files
    @project1.enable_module! :dmsf
    @role.add_permission! :view_dmsf_folders
    @role.add_permission! :file_manipulation
    credentials = @admin.merge!({ content_type: :text })

    put "/dmsf/webdav/#{@project1.identifier}/file1.tmp", params: '1234', headers: credentials
    assert_response :success
    file1 = DmsfFile.find_by(project_id: @project1.id, dmsf_folder: nil, name: 'file1.tmp')
    assert file1
    assert_difference 'file1.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/file1.tmp", params: '5678', headers: credentials
      assert_response :created
    end
    assert_difference 'file1.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/file1.tmp", params: '9ABC', headers: credentials
      assert_response :created
    end

    put "/dmsf/webdav/#{@project1.identifier}/~$file2.txt", params: '1234', headers: credentials
    assert_response :success
    file2 = DmsfFile.find_by(project_id: @project1.id, dmsf_folder_id: nil, name: '~$file2.txt')
    assert file2
    assert_difference 'file2.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/~$file2.txt", params: '5678', headers: credentials
      assert_response :created
    end
    assert_difference 'file2.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/~$file2.txt", params: '9ABC', headers: credentials
      assert_response :created
    end

    original = Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning']
    Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning'] = '.dump$'
    put "/dmsf/webdav/#{@project1.identifier}/file3.dump", params: '1234', headers: credentials
    assert_response :success
    file3 = DmsfFile.find_by(project_id: @project1.id, dmsf_folder_id: nil, name: 'file3.dump')
    assert file3
    assert_difference 'file3.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/file3.dump", params: '5678', headers: credentials
      assert_response :created
    end
    assert_difference 'file3.dmsf_file_revisions.count', 0 do
      put "/dmsf/webdav/#{@project1.identifier}/file3.dump", params: '9ABC', headers: credentials
      assert_response :created
    end
    Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning'] = original
  end

  def test_put_into_subproject
    put "/dmsf/webdav/#{@project1.identifier}/#{@project3.identifier}/test-1234.txt", params: '1234',
        headers: @admin.merge!({ content_type: :text })
    assert_response :created
    assert DmsfFile.find_by(project_id: @project3.id, dmsf_folder: nil, name: 'test-1234.txt')
  end
  
end