store_agent 1.0.0

data/lib/store_agent/node/attachment.rb

@@ -0,0 +1,93 @@
+#--
+# 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 Node
+    # メタデータや権限情報など、オブジェクトに付属する情報<br>
+    # データはJSON形式のファイルで保存され、ハッシュ形式のデータとしてアクセスできる
+    class Attachment
+      extend Forwardable
+      include StoreAgent::Validator
+
+      attr_reader :object
+      def_delegators :object, *%w(current_user root? directory?)
+
+      def initialize(object: nil) # :nodoc:
+        @object = object
+        validates_to_be_not_nil_value!(:object)
+      end
+
+      # ハッシュ形式のデータにアクセスするためのメソッド
+      def data
+        @data ||= (load || initial_data)
+      end
+
+      # オブジェクトの作成時に一緒に作成される
+      def create
+        dirname = File.dirname(file_path)
+        if !File.exists?(dirname)
+          FileUtils.mkdir(dirname)
+        end
+        save
+      end
+
+      # オブジェクトの削除時に一緒に削除される
+      def delete
+        if object.directory?
+          FileUtils.remove_dir(File.dirname(file_path))
+        else
+          FileUtils.rm(file_path)
+        end
+        object.workspace.version_manager.remove(file_path)
+      end
+
+      # データをファイルに保存するメソッド
+      def save
+        json_data = Oj.dump(data, mode: :compat, indent: StoreAgent.config.json_indent_level)
+        encoded_data = StoreAgent.config.attachment_data_encoders.inject(json_data) do |data, encoder|
+          encoder.encode(data)
+        end
+        open(file_path, File::WRONLY | File::CREAT) do |f|
+          f.truncate(0)
+          f.write encoded_data
+        end
+        object.workspace.version_manager.add(file_path)
+        reload
+      end
+
+      # データをファイルから読み込むメソッド
+      def load
+        if File.exists?(file_path)
+          encoded_data = open(file_path, "rb").read
+          json_data = StoreAgent.config.attachment_data_encoders.reverse.inject(encoded_data) do |data, encoder|
+            encoder.decode(data)
+          end
+          Oj.load(json_data)
+        end
+      end
+
+      # 保存されていない変更を破棄する
+      def reload
+        @data = nil
+        self
+      end
+
+      def inspect # :nodoc:
+        Oj.dump(data, mode: :compat, indent: 2)
+      end
+    end
+  end
+end

data/lib/store_agent/node/attachment/metadata.rb

@@ -0,0 +1,120 @@
+#--
+# 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 Node
+    # ファイルサイズ、作成者、更新日時などの情報
+    class Metadata < Attachment
+      def_delegators :data, *%w([] []=)
+
+      # TODO check disk_usage before save
+
+      def create
+        super
+        parent.update(disk_usage: disk_usage, directory_file_count: 1, tree_file_count: 1, recursive: true)
+      end
+
+      def update(disk_usage: 0, directory_file_count: 0, tree_file_count: 0, recursive: false)
+        if directory?
+          self["directory_file_count"] += directory_file_count
+          self["tree_file_count"] += tree_file_count
+        end
+        self.disk_usage += disk_usage
+        save
+        if recursive
+          parent.update(disk_usage: disk_usage, tree_file_count: tree_file_count, recursive: recursive)
+        end
+      end
+
+      def delete
+        parent.update(disk_usage: -disk_usage, directory_file_count: -1, tree_file_count: -1, recursive: true)
+        super
+      end
+
+      def base_path # :nodoc:
+        "#{@object.workspace.metadata_dirname}#{@object.path}"
+      end
+
+      # オブジェクトのメタデータを保存しているファイルの絶対パス
+      def file_path
+        "#{base_path}#{StoreAgent.config.metadata_extension}"
+      end
+
+      # ディスク使用量をバイトからキロバイトなどの単位に変換するメソッド
+      def self.datasize_format(size)
+        byte_names = %w(KB MB GB TB PB)
+        byte_length = size.abs.to_s(2).length
+        if byte_length <= 10
+          "#{size} bytes"
+        else
+          exponent = [byte_names.length, (byte_length - 1) / 10].min
+          sprintf("%0.2f%s", size.to_f / (2 ** (10 * exponent)), byte_names[exponent - 1])
+        end
+      end
+
+      def disk_usage
+        if directory?
+          self["directory_bytes"]
+        else
+          self["bytes"]
+        end
+      end
+
+      def disk_usage=(usage)
+        usage_string = StoreAgent::Node::Metadata.datasize_format(usage)
+        if directory?
+          self["directory_size"] = usage_string
+          self["directory_bytes"] = usage
+        else
+          self["size"] = usage_string
+          self["bytes"] = usage
+        end
+      end
+
+      def owner=(identifier)
+        self["owner"] = identifier
+      end
+
+      def updated_at=(time)
+        self["updated_at"] = time.to_s
+        self["updated_at_unix_timestamp"] = time.to_i
+      end
+
+      private
+
+      def parent
+        if root?
+          SuperRootMetadata.new
+        else
+          object.parent_directory.metadata
+        end
+      end
+
+      def initial_data
+        object.default_metadata
+      end
+
+      # 最上位階層の親ディレクトリのメタデータとして振る舞うダミーのクラス
+      class SuperRootMetadata < Metadata # :nodoc:
+        def initialize(*)
+        end
+
+        def update(*)
+        end
+      end
+    end
+  end
+end

data/lib/store_agent/node/attachment/permission.rb

@@ -0,0 +1,121 @@
+#--
+# 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 Node
+    # オブジェクトの権限情報
+    class Permission < Attachment
+      # オブジェクトに対して、引数で受け取った権限を持つなら true を返す
+      def allow?(permission_name)
+        case
+        when current_user.super_user?
+          true
+        when !(permission_value = get_permission_value(permission_name)).nil?
+          permission_value
+        else
+          !!data["guest"][permission_name]
+        end
+      end
+
+      # 権限を設定する
+      def set!(identifier: nil, permission_values: {})
+        return if permission_values.empty?
+        user_permission = [identifier].flatten.inject(data["users"]) do |r, id|
+          r[id] ||= {}
+        end
+        permission_values.each do |permission_name, value|
+          user_permission[permission_name] = value
+        end
+        save
+      end
+
+      # 権限を解除する
+      def unset!(identifier: nil, permission_names: [])
+        identifiers = [identifier].flatten
+        permission_names = [permission_names].flatten
+        user_permission = find_permission(data["users"], identifiers)
+        if user_permission
+          user_permission.delete_if do |permission_name, _|
+            permission_names.include?(permission_name)
+          end
+          sweep_permission(data["users"], identifiers)
+          save
+        end
+      end
+
+      def base_path # :nodoc:
+        "#{@object.workspace.permission_dirname}#{@object.path}"
+      end
+
+      # オブジェクトの権限情報を保存しているファイルの絶対パス
+      def file_path
+        "#{base_path}#{StoreAgent.config.permission_extension}"
+      end
+
+      private
+
+      def find_permission(data, identifiers)
+        identifier = identifiers.first
+        next_data = data[identifier]
+        next_identifiers = identifiers[1..-1]
+        case
+        when next_identifiers.empty?
+          next_data
+        when next_data
+          find_permission(next_data, next_identifiers)
+        else
+          nil
+        end
+      end
+
+      def sweep_permission(data, identifiers)
+        identifier = identifiers.first
+        next_data = data[identifier]
+        if next_data
+          sweep_permission(next_data, identifiers[1..-1])
+          if next_data.empty?
+            data.delete(identifier)
+          end
+        end
+      end
+
+      def get_permission_value(permission_name)
+        current_user.identifiers.reverse.each do |identifier|
+          user_permission = [identifier].flatten.inject(data["users"]) do |r, id|
+            r[id] || break
+          end
+          if user_permission && user_permission.key?(permission_name)
+            return user_permission[permission_name]
+          end
+        end
+        nil
+      end
+
+      def initial_data
+        user_permission = {}
+        if !(current_user.super_user? || current_user.guest?)
+          user_permission = current_user.identifier_array.reverse.inject(@object.initial_permission) do |r, id|
+            {id => r}
+          end
+        end
+        {
+          "users" => user_permission,
+          "guest" => StoreAgent.config.default_guest_permission
+        }
+      end
+    end
+  end
+end

data/lib/store_agent/node/object.rb

@@ -0,0 +1,233 @@
+#--
+# 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 Node
+    # ファイルやディレクトリなど、オブジェクトの雛形となるクラス<br>
+    # 実際にはファイルやディレクトリなど、このクラスを継承したクラスを使用する
+    class Object
+      extend Forwardable
+      include StoreAgent::Validator
+      prepend *[] <<
+        StoreAgent::Node::PathValidator <<
+        StoreAgent::Node::PermissionChecker <<
+        StoreAgent::Node::Locker
+
+      # def self.inherited(child)
+      #   child.include StoreAgent::Node::Locker
+      #   child.include StoreAgent::Node::PermissionChecker
+      #   child.include StoreAgent::Node::PathValidator
+      # end
+
+      attr_reader :workspace, :path
+      def_delegators :workspace, *%w(current_user)
+
+      def initialize(workspace: nil, path: "/") # :nodoc:
+        @workspace = workspace
+        validates_to_be_not_nil_value!(:workspace)
+        @path = sanitize_path(path)
+      end
+
+      # オブジェクトに紐づくメタデータのインスタンス
+      def metadata
+        @metadata ||= StoreAgent::Node::Metadata.new(object: self)
+      end
+
+      # オブジェクトに紐づく権限情報のインスタンス
+      def permission
+        @permission ||= StoreAgent::Node::Permission.new(object: self)
+      end
+
+      def initial_owner # :nodoc:
+        @initial_owner ||= current_user.identifier
+      end
+
+      def initial_owner=(owner_identifier) # :nodoc:
+        authorize!("chown")
+        @initial_owner = owner_identifier
+      end
+
+      def initial_permission # :nodoc:
+        @initial_permission ||= StoreAgent.config.default_owner_permission
+      end
+
+      def initial_permission=(permissions) # :nodoc:
+        authorize!("chmod")
+        @initial_permission = permissions
+      end
+
+      def create(*)
+        workspace.version_manager.transaction("created #{path}") do
+          yield
+          metadata.create
+          permission.create
+        end
+        self
+      end
+
+      def read(*)
+        yield
+      end
+
+      def update(*)
+        workspace.version_manager.transaction("updated #{path}") do
+          yield
+        end
+        true
+      end
+
+      def delete(*)
+        workspace.version_manager.transaction("deleted #{path}") do
+          yield
+          metadata.delete
+          permission.delete
+        end
+        true
+      end
+
+      def touch(*)
+        workspace.version_manager.transaction("touch #{path}") do
+          metadata.reload
+          yield
+          metadata.updated_at = Time.now
+          metadata.save
+          workspace.version_manager.add(permission.file_path)
+        end
+      end
+
+      def copy(dest_path = nil)
+        workspace.version_manager.transaction("copy #{path} to #{dest_path}") do
+          yield
+        end
+      end
+
+      def move(dest_path = nil)
+        workspace.version_manager.transaction("move #{path} to #{dest_path}") do
+          yield
+        end
+      end
+
+      def get_metadata(*) # :nodoc:
+        yield
+        metadata.data
+      end
+
+      def get_permissions(*) # :nodoc:
+        yield
+        permission.data
+      end
+
+      def chown(*, identifier: nil, **_)
+        workspace.version_manager.transaction("change_owner #{path}") do
+          yield
+          metadata.owner = identifier
+          metadata.save
+        end
+      end
+
+      def set_permission(identifier: nil, permission_values: {}, **_)
+        workspace.version_manager.transaction("add_permission #{path}") do
+          permission.set!(identifier: identifier, permission_values: permission_values)
+          yield
+        end
+      end
+
+      def unset_permission(identifier: nil, permission_names: [], **_)
+        workspace.version_manager.transaction("remove_permission #{path}") do
+          permission.unset!(identifier: identifier, permission_names: permission_names)
+          yield
+        end
+      end
+
+      # 親階層のディレクトリオブジェクトを返す
+      def parent_directory
+        if !root?
+          @parent_directory ||= StoreAgent::Node::DirectoryObject.new(workspace: @workspace, path: File.dirname(@path))
+        end
+      end
+
+      # バージョン管理をしている場合、変更があったリビジョンの一覧を返す
+      def revisions
+        workspace.version_manager.revisions("storage#{path}")
+      end
+
+      # オブジェクトが存在するなら true を返す
+      def exists?
+        File.exists?(storage_object_path)
+      end
+
+      # ファイルの種類。file、directory など
+      def filetype
+        File.ftype(storage_object_path)
+      end
+
+      def initial_metadata # :nodoc:
+        @initial_metadata ||= {}
+      end
+
+      def default_metadata # :nodoc:
+        {
+          "size" => StoreAgent::Node::Metadata.datasize_format(initial_bytesize),
+          "bytes" => initial_bytesize,
+          "owner" => initial_owner,
+          "is_dir" => directory?,
+          "created_at" => updated_at.to_s,
+          "updated_at" => updated_at.to_s,
+          "created_at_unix_timestamp" => updated_at.to_i,
+          "updated_at_unix_timestamp" => updated_at.to_i,
+        }.merge(initial_metadata)
+      end
+
+      # true を返す場合、ファイルツリーの最上位ディレクトリとして認識される
+      def root?
+        @path == "/"
+      end
+
+      # true を返す場合、ディレクトリとして認識される
+      def directory?
+        false
+      end
+
+      # true を返す場合、ファイルとして認識される
+      def file?
+        false
+      end
+
+      # オブジェクトの絶対パス
+      def storage_object_path
+        "#{@workspace.storage_dirname}#{@path}"
+      end
+
+      private
+
+      def sanitize_path(path)
+        File.absolute_path("/./#{path}")
+      end
+
+      def owner?
+        metadata["owner"] == current_user.identifier
+      end
+
+      def initial_bytesize
+        0
+      end
+
+      def updated_at
+        File.mtime(storage_object_path)
+      end
+    end
+  end
+end