openproject/lib/open_project/scm/adapters/filesystem.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# 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.
#
# See doc/COPYRIGHT.rdoc for more details.
#++

require 'find'

module OpenProject
  module Scm
    module Adapters
      class FileSystem < Base
        include LocalClient

        def initialize(url, _root_url = nil, _login = nil, _password = nil, path_encoding = nil)
          @url = with_trailling_slash(url)
          @path_encoding = path_encoding || 'UTF-8'
        end

        def format_path_ends(path, leading = true, trailling = true)
          path = leading ? with_leading_slash(path) : without_leading_slash(path)
          trailling ? with_trailling_slash(path) : without_trailling_slash(path)
        end

        def info
          Info.new(root_url: target,
                   lastrev: nil
                  )
        rescue CommandFailed
          return nil
        end

        def entries(path = '', _identifier = nil)
          entries = Entries.new
          trgt_utf8 = target(path)
          trgt = scm_encode(@path_encoding, 'UTF-8', trgt_utf8)
          Dir.new(trgt).each do |e1|
            e_utf8 = scm_encode('UTF-8', @path_encoding, e1)
            next if e_utf8.blank?
            relative_path_utf8 = format_path_ends(
                (format_path_ends(path, false, true) + e_utf8), false, false)
            t1_utf8 = target(relative_path_utf8)
            t1 = scm_encode(@path_encoding, 'UTF-8', t1_utf8)
            relative_path = scm_encode(@path_encoding, 'UTF-8', relative_path_utf8)
            e1 = scm_encode(@path_encoding, 'UTF-8', e_utf8)
            if File.exist?(t1) and # paranoid test
               %w{file directory}.include?(File.ftype(t1)) and # avoid special types
               not File.basename(e1).match(/\A\.+\z/) # avoid . and ..
              p1         = File.readable?(t1) ? relative_path : ''
              utf_8_path = scm_encode('UTF-8', @path_encoding, p1)
              entries <<
                Entry.new(
                  name: scm_encode('UTF-8', @path_encoding, File.basename(e1)),
                  # below : list unreadable files, but dont link them.
                  path: utf_8_path,
                  kind: (File.directory?(t1) ? 'dir' : 'file'),
                  size: (File.directory?(t1) ? nil : [File.size(t1)].pack('l').unpack('L').first),
                  lastrev: Revision.new(time: (File.mtime(t1)))
                )
            end
          end
          entries.sort_by_name
        rescue  => err
          logger.error "scm: filesystem: error: #{err.message}"
          raise CommandFailed.new('filesystem', '', err.message)
        end

        def cat(path, _identifier = nil)
          p = scm_encode(@path_encoding, 'UTF-8', target(path))
          File.new(p, 'rb').read
        rescue  => err
          logger.error "scm: filesystem: error: #{err.message}"
          raise CommandFailed.new('filesystem', '', err.message)
        end

        private

        # AbstractAdapter::target is implicitly made to quote paths.
        # Here we do not shell-out, so we do not want quotes.
        def target(path = nil)
          # Prevent the use of ..
          if path and !path.match(/(^|\/)\.\.(\/|$)/)
            return "#{url}#{without_leading_slash(path)}"
          end
          url
        end
      end
    end
  end
end