store_agent 1.0.0

data/lib/store_agent/validator.rb

@@ -0,0 +1,60 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module StoreAgent
+  # バリデーションに使用するメソッドを定義したモジュール
+  module Validator
+    # 文字列またはシンボルでないとエラー
+    def validates_to_be_string_or_symbol!(value)
+      case
+      when value.nil?, value == "", value == :""
+        raise ArgumentError, "#{value} is empty string or symbol"
+      when !value.is_a?(String) && !value.is_a?(Symbol)
+        raise ArgumentError, "#{value} is not string or symbol"
+      else
+        true
+      end
+    end
+
+    # 文字列中に '/' を含むとエラー
+    def validates_to_be_excluded_slash!(value)
+      if value.to_s.include?("/")
+        raise ArgumentError, "#{value} includes '/'"
+      end
+    end
+
+    # スーパーユーザーのIDと一致している場合エラー
+    def validates_to_be_not_superuser_identifier!(value)
+      if value.to_s == StoreAgent.config.superuser_identifier
+        raise ArgumentError, "#{value} is reserved for superuser"
+      end
+    end
+
+    # ゲストユーザーのIDと一致している場合エラー
+    def validates_to_be_not_guest_identifier!(value)
+      if value.to_s == StoreAgent.config.guest_identifier
+        raise ArgumentError, "#{value} is reserved for guest"
+      end
+    end
+
+    # アクセサが nil を返す場合エラー
+    def validates_to_be_not_nil_value!(accessor_method_name)
+      if send(accessor_method_name).nil?
+        raise ArgumentError, "#{accessor_method_name} is nil"
+      end
+    end
+  end
+end

data/lib/store_agent/version.rb

@@ -0,0 +1,19 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module StoreAgent
+  VERSION = "1.0.0"
+end

data/lib/store_agent/version_manager.rb

@@ -0,0 +1,101 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require "store_agent/version_manager/rugged_git"
+require "store_agent/version_manager/ruby_git"
+
+module StoreAgent
+  # バージョン管理に使用するクラスの雛形。<br>
+  # デフォルトではこのクラスが使用されるが、その場合はバージョン管理を行わない。
+  class VersionManager
+    attr_reader :workspace
+
+    # バージョン管理システムが使用するため予約されているファイル名<br>
+    # 例えば git の場合は、.git .keep など
+    def self.reserved_filenames
+      []
+    end
+
+    def initialize(workspace: nil) # :nodoc:
+      @workspace = workspace
+    end
+
+    # :call-seq:
+    #   init
+    #
+    # バージョン管理対象のリポジトリを初期化する
+    def init(*params, &block)
+      call_block(params, &block)
+    end
+
+    # :call-seq:
+    #   add(*paths)
+    #
+    # 引数で渡されたパスをバージョン管理対象に追加する
+    def add(*params, &block)
+      call_block(params, &block)
+    end
+
+    # :call-seq:
+    #   remove(*paths, directory: false)
+    #
+    # 引数で渡されたパスをバージョン管理対象から除外する<br>
+    # パスがディレクトリの場合には、directory に true が渡される
+    def remove(*params, &block)
+      call_block(params, &block)
+    end
+
+    # :call-seq:
+    #   transaction(messsage, &block)
+    #
+    # 引数でコミットメッセージとブロックを受け取り、トランザクション処理で実行する<br>
+    # ブロックの実行に成功した場合には受け取ったメッセージで変更をコミットする。<br>
+    # 処理に失敗した場合は、ブロックの実行前の状態に戻す。
+    def transaction(*params, &block)
+      call_block(params, &block)
+    end
+
+    # :call-seq:
+    #   read(path: "", revision: nil)
+    #
+    # 指定されたパスの指定リビジョン時の中身を返す
+    def read(*params, &block)
+      call_block(params, &block)
+    end
+
+    # :call-seq:
+    #   revisions(path)
+    #
+    # 引数で渡されたパスのリビジョン一覧を返す
+    def revisions(*params, &block)
+      call_block(params, &block)
+    end
+
+    private
+
+    def relative_path(path)
+      path[(workspace.namespace_dirname.length + 1)..-1]
+    end
+
+    def call_block(*, &block)
+      FileUtils.cd(workspace.namespace_dirname) do
+        if block
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/store_agent/version_manager/ruby_git.rb

@@ -0,0 +1,100 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module StoreAgent
+  class VersionManager
+    # ruby-git(https://github.com/schacon/ruby-git) を使用してバージョン管理を行うクラス<br>
+    # StoreAgent::VersionManager を継承しているので、詳細はそちらを参照
+    class RubyGit < VersionManager
+      # :enddoc:
+      def self.reserved_filenames
+        %w(.git .keep)
+      end
+
+      def init
+        super do
+          Git.init
+        end
+      end
+
+      def add(*paths)
+        super do
+          FileUtils.touch(paths)
+          repository.add(paths, force: true)
+        end
+      end
+
+      def remove(*paths, **_)
+        super do
+          repository.remove(paths, recursive: true)
+        end
+      end
+
+      def transaction(message)
+        if @transaction
+          yield
+        else
+          begin
+            @transaction = true
+            super do
+              yield
+            end
+            repository.commit(message)
+          rescue => e
+            repository.reset_hard
+            raise e
+          ensure
+            @transaction = false
+          end
+        end
+      end
+
+      def read(path: "", revision: nil)
+        if path.end_with?("/")
+          read_directory(path: path, revision: revision)
+        else
+          read_file(path: path, revision: revision)
+        end
+      end
+
+      def revisions(path = ".")
+        logs(path).map(&:objectish)
+      end
+
+      private
+
+      def repository
+        @repository ||= Git.open(workspace.namespace_dirname)
+      end
+
+      def logs(path)
+        repository.log.path(path)
+      end
+
+      def read_directory(path: ".", revision: "HEAD")
+        repository.gtree("#{revision}:#{relative_path(path)}").children.keys
+      rescue Git::GitExecuteError
+        raise StoreAgent::InvalidRevisionError.new(path: path, revision: revision)
+      end
+
+      def read_file(path: ".", revision: "HEAD")
+        repository.gblob("#{revision}:#{relative_path(path)}").contents
+      rescue Git::GitExecuteError
+        raise StoreAgent::InvalidRevisionError.new(path: path, revision: revision)
+      end
+    end
+  end
+end

data/lib/store_agent/version_manager/rugged_git.rb

@@ -0,0 +1,133 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module StoreAgent
+  class VersionManager
+    # rugged(https://github.com/libgit2/rugged) を使用してバージョン管理を行うクラス<br>
+    # StoreAgent::VersionManager を継承しているので、詳細はそちらを参照
+    class RuggedGit < VersionManager
+      # :enddoc:
+      def self.reserved_filenames
+        %w(.git .keep)
+      end
+
+      def init
+        super do
+          Rugged::Repository.init_at(".")
+        end
+      end
+
+      def add(*paths)
+        super do
+          FileUtils.touch(paths)
+          paths.flatten.each do |path|
+            oid = Rugged::Blob.from_workdir(repository, relative_path(path))
+            repository.index.add(relative_path(path))
+          end
+        end
+      end
+
+      def remove(*paths, directory: false)
+        super do
+          paths.flatten.each do |path|
+            if directory
+              repository.index.remove_dir(relative_path(path))
+            else
+              repository.index.remove(relative_path(path))
+            end
+          end
+        end
+      end
+
+      def transaction(message)
+        if @transaction
+          yield
+        else
+          begin
+            @transaction = true
+            super do
+              yield
+            end
+            commit(message)
+          rescue => e
+            repository.reset("HEAD", :hard)
+            raise e
+          ensure
+            @transaction = false
+          end
+        end
+      end
+
+      def read(path: "", revision: nil)
+        if path.end_with?("/")
+          read_directory(path: path, revision: revision)
+        else
+          read_file(path: path, revision: revision)
+        end
+      end
+
+      def revisions(path = "*")
+        logs(path).map(&:oid)
+      end
+
+      private
+
+      def repository
+        @repository ||= Rugged::Repository.new(workspace.namespace_dirname)
+      end
+
+      def walker
+        @walker ||= Rugged::Walker.new(repository)
+      end
+
+      def logs(path)
+        walker.sorting(Rugged::SORT_DATE)
+        walker.push(repository.head.target)
+        walker.select do |commit|
+          commit.parents.size == 1 && commit.diff(paths: [path]).size > 0
+        end
+      end
+
+      def lookup_path(path: "", revision: nil)
+        paths = relative_path(path).split("/")
+        paths.inject(repository.lookup(revision).tree) do |tree, path|
+          repository.lookup(tree.find{|t| t[:name] == path}[:oid])
+        end
+      rescue Rugged::InvalidError
+        raise StoreAgent::InvalidRevisionError.new(path: path, revision: revision)
+      end
+
+      def read_directory(path: "", revision: nil)
+        lookup_path(path: path, revision: revision).map{|t| t[:name]}
+      end
+
+      def read_file(path: "", revision: nil)
+        lookup_path(path: path, revision: revision).content
+      end
+
+      def commit(message)
+        options = {
+          tree: repository.index.write_tree(repository),
+          message: message,
+          parents: repository.empty? ? [] : [ repository.head.target ].compact,
+          update_ref: "HEAD"
+        }
+        Rugged::Commit.create(repository, options)
+        repository.index.write
+      end
+    end
+  end
+end

data/lib/store_agent/workspace.rb

@@ -0,0 +1,88 @@
+#--
+# Copyright 2015 realglobe, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module StoreAgent
+  # ワークスペース
+  class Workspace
+    extend Forwardable
+    include StoreAgent::Validator
+
+    attr_reader :current_user, :namespace, :version_manager
+    def_delegators :root, *%w(find_object directory file exists?)
+
+    def initialize(current_user: nil, namespace: nil) # :nodoc:
+      @current_user = current_user
+      @namespace = namespace
+      validates_to_be_not_nil_value!(:current_user)
+      validates_to_be_string_or_symbol!(@namespace)
+      validates_to_be_excluded_slash!(@namespace)
+      @version_manager = StoreAgent.config.version_manager.new(workspace: self)
+    end
+
+    # ワークスペースを新規作成する
+    def create
+      if exists?
+        raise InvalidPathError, "workspace #{@namespace} is already exists"
+      end
+      FileUtils.mkdir_p(namespace_dirname)
+      @version_manager.init
+      root.create
+    end
+
+    # ワークスペースを削除する
+    def delete
+      if !exists?
+        raise InvalidPathError, "workspace #{@namespace} not found"
+      end
+      FileUtils.remove_dir(namespace_dirname)
+    end
+
+    # ワークスペースのファイルツリーの最上位ノード
+    def root
+      @root ||= StoreAgent::Node::DirectoryObject.new(workspace: self, path: "/")
+    end
+
+    # ワークスペースの絶対パス
+    def namespace_dirname
+      File.absolute_path("#{StoreAgent.config.storage_root}/#{@namespace}")
+    end
+
+    # ストレージとして使用する領域の絶対パス
+    def storage_dirname
+      File.absolute_path("#{namespace_dirname}/#{StoreAgent.config.storage_dirname}")
+    end
+
+    # メタデータの保存に使用する領域の絶対パス
+    def metadata_dirname
+      File.absolute_path("#{namespace_dirname}/#{StoreAgent.config.metadata_dirname}")
+    end
+
+    # 権限情報の保存に使用する領域の絶対パス
+    def permission_dirname
+      File.absolute_path("#{namespace_dirname}/#{StoreAgent.config.permission_dirname}")
+    end
+
+    # 全ワークスペース名の一覧を配列で返す
+    def self.name_list
+      if !File.exists?(StoreAgent.config.storage_root)
+        FileUtils.mkdir(StoreAgent.config.storage_root)
+      end
+      FileUtils.cd(StoreAgent.config.storage_root) do
+        return Dir.glob("*", File::FNM_DOTMATCH) - StoreAgent.reserved_filenames
+      end
+    end
+  end
+end